com.cosylab.acs.maci.plug

Class ContainerProxy

java.lang.Object

com.cosylab.acs.maci.plug.CORBAReferenceSerializator

com.cosylab.acs.maci.plug.ClientProxy

com.cosylab.acs.maci.plug.ContainerProxy

All Implemented Interfaces:

Client, Container, java.io.Serializable

public class ContainerProxy
extends ClientProxy
implements Container

CORBA Container Proxy.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.cosylab.acs.maci.Container

Container.ComponentInfoCompletionCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected si.ijs.maci.Container	container CORBA reference.
protected static java.util.logging.Logger	logger

Fields inherited from class com.cosylab.acs.maci.plug.ClientProxy

client, ior

Constructor Summary

Constructors

Constructor and Description
ContainerProxy(si.ijs.maci.Container container) Constructor for ContainerProxy.

Method Summary

Modifier and Type	Method and Description
void	activate_component_async(int handle, long executionId, java.lang.String name, java.lang.String exe, java.lang.String type, Container.ComponentInfoCompletionCallback callback) Asynchronous version of activate_component.
ComponentInfo	activate_component(int handle, long executionId, java.lang.String name, java.lang.String exe, java.lang.String type) Activate a Component whose type (class) and name (instance) are given.
void	deactivate_component(int handle) Deactivate a component whose handles is given.
boolean	equals(java.lang.Object obj)
ComponentInfo[]	get_component_info(int[] handles) Returns information about a subset of components that are currently hosted by the Container.
int	get_handle() Get the Container handle give by the Managert at login.
si.ijs.maci.Client	getClient() Returns the client.
static int	inverseMapAccessRights(int accessRights) Map CORBA specific codes to AccessRights status codes.
Component	restart_component(int handle) Restarts a component.
void	set_component_shutdown_order(int[] handles) Set component shutdown order.
void	shutdown(int action) Shutdown the Container.
java.lang.String	toString() Returns a single-line rendition of this instance into text.

Methods inherited from class com.cosylab.acs.maci.plug.ClientProxy

authenticate, components_available, components_unavailable, disconnect, equals, getRemoteLocation, message, name, ping, release, taggedmessage, toClientType, toImplLang, wrapForRoundtripTimeout

Methods inherited from class com.cosylab.acs.maci.plug.CORBAReferenceSerializator

deserialize, getOrb, serialize, setOrb

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.cosylab.acs.maci.Client

authenticate, components_available, components_unavailable, disconnect, getRemoteLocation, message, name, ping, release, taggedmessage

Field Detail

container

protected si.ijs.maci.Container container

CORBA reference.

logger

protected static final java.util.logging.Logger logger

Constructor Detail

ContainerProxy

public ContainerProxy(si.ijs.maci.Container container)

Constructor for ContainerProxy.

Parameters:

container - CORBA reference, non-null.

Method Detail

get_handle

public int get_handle()

Description copied from interface: Container

Get the Container handle give by the Managert at login.

Specified by:

get_handle in interface Container

Returns:

the Container handle, 0 if not (yet) logged in.

activate_component

public ComponentInfo activate_component(int handle,
                                        long executionId,
                                        java.lang.String name,
                                        java.lang.String exe,
                                        java.lang.String type)
                                 throws AcsJCannotActivateComponentEx

Description copied from interface: Container

Activate a Component whose type (class) and name (instance) are given. In the process of activation, Component's code-base is loaded into memory if it is not there already. The code-base resides in an executable file (usually a dynamic-link library or a shared library -- DLL). On platforms that do not automatically load dependent executables (e.g., VxWorks), the Container identifies the dependancies by querying the executable and loads them automatically. Once the code is loaded, it is asked to construct a servant of a given type. The servant is then initialized with the Configuration Database (CDB) and Persistance Database (PDB) data. The servant is attached to the Component, and a reference to it is returned.

Specified by:

activate_component in interface Container

Parameters:

handle - Handle of the Component that is being activated. This handle is used by the Component when it will present itself to the Manager. The Component is expected to remember this handle for its entire life-time.

executionId - Execution ID.

name - Name of the Component to instantiate.

exe - Path to the executable file (a DLL or a shared library) in which the Component's code resides. The path is relative to the root directory in which all executable code is stored. The path must not contain dots, and uses slashes (not backslashes) to separate components of the path. The path must not include the extension, or any prefixes, so that it is platform independent.

type - The type of the Component to instantiate. The interpretation of this field depends on the executable. Type should uniquely identify the code-base which the Component will be executing. Note: Type name is a CORBA repository ID.

Returns:

Returns the reference to the object that has just been activated. If the Component could not the activated, a nil reference is returned.

Throws:

AcsJCannotActivateComponentEx

See Also:

Container.activate_component(int, long, String, String, String)

activate_component_async

public void activate_component_async(int handle,
                                     long executionId,
                                     java.lang.String name,
                                     java.lang.String exe,
                                     java.lang.String type,
                                     Container.ComponentInfoCompletionCallback callback)

Description copied from interface: Container

Asynchronous version of activate_component.

Specified by:

activate_component_async in interface Container

See Also:

Container.activate_component(int, long, String, String, String)

deactivate_component

public void deactivate_component(int handle)
                          throws AcsJCannotDeactivateComponentEx,
                                 AcsJComponentDeactivationUncleanEx,
                                 AcsJComponentDeactivationFailedEx

Description copied from interface: Container

Deactivate a component whose handles is given. Deactivation is the inverse process of activation: Component is detached from the POA, and thus made unavailable through CORBA, and its resources are freed. If it's code-base is no longer used, it is unloaded from memory.

Specified by:

deactivate_component in interface Container

Parameters:

handle - A handle identifying a component to be released.

Throws:

AcsJCannotDeactivateComponentEx

AcsJComponentDeactivationUncleanEx

AcsJComponentDeactivationFailedEx

See Also:

Container.deactivate_component(int)

get_component_info

public ComponentInfo[] get_component_info(int[] handles)
                                   throws RemoteException

Description copied from interface: Container

Returns information about a subset of components that are currently hosted by the Container. Note: If the list of handles is empty, information about all components hosted by the container is returned.

Specified by:

get_component_info in interface Container

Parameters:

handles - Handles of the components whose information should be retrieved.

Returns:

Information about the selected components.

Throws:

RemoteException

See Also:

Container.get_component_info(int[])

restart_component

public Component restart_component(int handle)
                            throws RemoteException

Description copied from interface: Container

Restarts a component.

Specified by:

restart_component in interface Container

Returns:

a new reference of the restarted component.

Throws:

RemoteException

See Also:

Container.restart_component(int)

shutdown

public void shutdown(int action)
              throws RemoteException

Description copied from interface: Container

Shutdown the Container.

Specified by:

shutdown in interface Container

Throws:

RemoteException

See Also:

Container.shutdown(int)

set_component_shutdown_order

public void set_component_shutdown_order(int[] handles)
                                  throws RemoteException

Description copied from interface: Container

Set component shutdown order.

Specified by:

set_component_shutdown_order in interface Container

Parameters:

handles - ordered list of components handles.

Throws:

RemoteException

See Also:

com.cosylab.acs.maci.Container#deactivate_components(int[])

getClient

public si.ijs.maci.Client getClient()

Returns the client.

Overrides:

getClient in class ClientProxy

Returns:

si.ijs.maci.Client

inverseMapAccessRights

public static int inverseMapAccessRights(int accessRights)

Map CORBA specific codes to AccessRights status codes.

Parameters:

accessRights - CORBA specific codes

Returns:

AccessRights status codes

toString

public java.lang.String toString()

Returns a single-line rendition of this instance into text.

Overrides:

toString in class ClientProxy

Returns:

internal state of this instance

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)