org.omg.PortableServer

Interface POAManagerOperations

Known Subinterfaces:
POAManager
Known Implementing Classes:
gnuPOAManager

public interface POAManagerOperations

Defines the operations, applicable to the POAManager. These operations can turn the associated POAs to and from holding, active and discarding states, but the incative state is irreversible. The inactivated POAs can only be recreated after they were destroyed.

Method Summary

void
activate()
Turns the associated POAs into active state, allowing them to receive and process requests.
void
deactivate(boolean etherealize_objects, boolean wait_for_completion)
Turns the asociated POAs into inactive state.
void
discard_requests(boolean wait_for_completion)
Turns the associated POAs into discaring state.
State
get_state()
Get the state of the POA manager.
void
hold_requests(boolean wait_for_completion)
Turns the associated POAs into holding state.

Method Details

activate

public void activate()
            throws AdapterInactive
Turns the associated POAs into active state, allowing them to receive and process requests.
Throws:
AdapterInactive - if the POAs are in the inactive state. If once inactivated, the POA cannot be activated again. This method can only be called to leave the holding or discarding state.

deactivate

public void deactivate(boolean etherealize_objects,
                       boolean wait_for_completion)
            throws AdapterInactive
Turns the asociated POAs into inactive state. The POAs in the incative state will reject new requests. A cliet, trying to invoke an object, belonging to the inactivated POA, will receive the remote exception (OBJ_ADAPTER, minor code 0x535503ea, incomplete).

If the POA is once inactivated, it cannot be activated again. The operation is used when the associated POAs are to be shut down.

Some independent implementations may set the minor code of the OBJ_ADAPTER to 1, as recommended by OMG (formal/04-03-12). The interoperable systems should expect any of these two values.

Parameters:
etherealize_objects - if true, the servant managers of the associated POAs, having RETAIN and USE_SERVANT_MANAGER policies, will receive a call of ServantActivatorOperations.etherealize(byte[],POA,Servant,boolean,boolean).
wait_for_completion - if true, the method call suspends the current thread till POAs complete the requests they are currently processing. If false, the method returns immediately.

Throws:
AdapterInactive - if the POAs are already in the inactive state.

discard_requests

public void discard_requests(boolean wait_for_completion)
            throws AdapterInactive
Turns the associated POAs into discaring state. In this state, the POAs discard the incoming requests. This mode is used in situations when the server is flooded with requests. The client receives remote exception (TRANSIENT, minor code 0x535503e9, incomplete).

Some independent implementations may set the minor code of the TRANSIENT to 1, as recommended by OMG (formal/04-03-12). The interoperable systems should expect any of these two values.

Parameters:
wait_for_completion - if true, the method call suspends the current thread till POAs complete the requests they are currently processing. If false, the method returns immediately.
Throws:
AdapterInactive - if the POAs are in the inactive state.

get_state

public State get_state()
Get the state of the POA manager.

hold_requests

public void hold_requests(boolean wait_for_completion)
            throws AdapterInactive
Turns the associated POAs into holding state. In this state, the POAs queue incoming requests but do not process them.
Parameters:
wait_for_completion - if true, the method call suspends the current thread till POAs complete the requests they are currently processing. If false, the method returns immediately.
Throws:
AdapterInactive - if the POAs are in the inactive state.

POAManagerOperations.java -- Copyright (C) 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.