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