1 /*
   2  * Copyright (c) 2003, 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 
  26 package com.sun.corba.se.spi.orbutil.threadpool;
  27 
  28 public interface ThreadPoolManager
  29 {
  30     /**
  31     * This method will return an instance of the threadpool given a threadpoolId,
  32     * that can be used by any component in the app. server.
  33     *
  34     * @throws NoSuchThreadPoolException thrown when invalid threadpoolId is passed
  35     * as a parameter
  36     */
  37     public ThreadPool getThreadPool(String threadpoolId) throws NoSuchThreadPoolException;
  38 
  39     /**
  40     * This method will return an instance of the threadpool given a numeric threadpoolId.
  41     * This method will be used by the ORB to support the functionality of
  42     * dedicated threadpool for EJB beans
  43     *
  44     * @throws NoSuchThreadPoolException thrown when invalidnumericIdForThreadpool is passed
  45     * as a parameter
  46     */
  47     public ThreadPool getThreadPool(int numericIdForThreadpool) throws NoSuchThreadPoolException;
  48 
  49     /**
  50     * This method is used to return the numeric id of the threadpool, given a String
  51     * threadpoolId. This is used by the POA interceptors to add the numeric threadpool
  52     * Id, as a tagged component in the IOR. This is used to provide the functionality of
  53     * dedicated threadpool for EJB beans
  54     */
  55     public int  getThreadPoolNumericId(String threadpoolId);
  56 
  57     /**
  58     * Return a String Id for a numericId of a threadpool managed by the threadpool
  59     * manager
  60     */
  61     public String getThreadPoolStringId(int numericIdForThreadpool);
  62 
  63     /**
  64     * Returns the first instance of ThreadPool in the ThreadPoolManager
  65     */
  66     public ThreadPool getDefaultThreadPool();
  67 
  68     /**
  69      * Return an instance of ThreadPoolChooser based on the componentId that was
  70      * passed as argument
  71      */
  72     public ThreadPoolChooser getThreadPoolChooser(String componentId);
  73 
  74     /**
  75      * Return an instance of ThreadPoolChooser based on the componentIndex that was
  76      * passed as argument. This is added for improved performance so that the caller
  77      * does not have to pay the cost of computing hashcode for the componentId
  78      */
  79     public ThreadPoolChooser getThreadPoolChooser(int componentIndex);
  80 
  81     /**
  82      * Sets a ThreadPoolChooser for a particular componentId in the ThreadPoolManager. This
  83      * would enable any component to add a ThreadPoolChooser for their specific use
  84      */
  85     public void setThreadPoolChooser(String componentId, ThreadPoolChooser aThreadPoolChooser);
  86 
  87     /**
  88      * Gets the numeric index associated with the componentId specified for a
  89      * ThreadPoolChooser. This method would help the component call the more
  90      * efficient implementation i.e. getThreadPoolChooser(int componentIndex)
  91      */
  92     public int getThreadPoolChooserNumericId(String componentId);
  93 }
  94 
  95 // End of file.