ThreadPoolManager.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.corba.se.spi.orbutil.threadpool;
27
28import java.io.Closeable;
29
30public interface ThreadPoolManager extends Closeable
31{
32    /**
33    * This method will return an instance of the threadpool given a threadpoolId,
34    * that can be used by any component in the app. server.
35    *
36    * @throws NoSuchThreadPoolException thrown when invalid threadpoolId is passed
37    * as a parameter
38    */
39    public ThreadPool getThreadPool(String threadpoolId) throws NoSuchThreadPoolException;
40
41    /**
42    * This method will return an instance of the threadpool given a numeric threadpoolId.
43    * This method will be used by the ORB to support the functionality of
44    * dedicated threadpool for EJB beans
45    *
46    * @throws NoSuchThreadPoolException thrown when invalidnumericIdForThreadpool is passed
47    * as a parameter
48    */
49    public ThreadPool getThreadPool(int numericIdForThreadpool) throws NoSuchThreadPoolException;
50
51    /**
52    * This method is used to return the numeric id of the threadpool, given a String
53    * threadpoolId. This is used by the POA interceptors to add the numeric threadpool
54    * Id, as a tagged component in the IOR. This is used to provide the functionality of
55    * dedicated threadpool for EJB beans
56    */
57    public int  getThreadPoolNumericId(String threadpoolId);
58
59    /**
60    * Return a String Id for a numericId of a threadpool managed by the threadpool
61    * manager
62    */
63    public String getThreadPoolStringId(int numericIdForThreadpool);
64
65    /**
66    * Returns the first instance of ThreadPool in the ThreadPoolManager
67    */
68    public ThreadPool getDefaultThreadPool();
69
70    /**
71     * Return an instance of ThreadPoolChooser based on the componentId that was
72     * passed as argument
73     */
74    public ThreadPoolChooser getThreadPoolChooser(String componentId);
75
76    /**
77     * Return an instance of ThreadPoolChooser based on the componentIndex that was
78     * passed as argument. This is added for improved performance so that the caller
79     * does not have to pay the cost of computing hashcode for the componentId
80     */
81    public ThreadPoolChooser getThreadPoolChooser(int componentIndex);
82
83    /**
84     * Sets a ThreadPoolChooser for a particular componentId in the ThreadPoolManager. This
85     * would enable any component to add a ThreadPoolChooser for their specific use
86     */
87    public void setThreadPoolChooser(String componentId, ThreadPoolChooser aThreadPoolChooser);
88
89    /**
90     * Gets the numeric index associated with the componentId specified for a
91     * ThreadPoolChooser. This method would help the component call the more
92     * efficient implementation i.e. getThreadPoolChooser(int componentIndex)
93     */
94    public int getThreadPoolChooserNumericId(String componentId);
95}
96
97// End of file.
98