com.cosylab.acs.maci.plug

Class ManagerProxy

java.lang.Object

com.cosylab.acs.maci.plug.CORBAReferenceSerializator

com.cosylab.acs.maci.plug.ManagerProxy

All Implemented Interfaces:

Manager, ManagerConstants, java.io.Serializable

public class ManagerProxy
extends CORBAReferenceSerializator
implements Manager, java.io.Serializable

CORBA Manager Proxy. This class is used by clients of remote Managers that want to use the acs.maci.Manager interface. In particular it used by the JManager application to implement Manager federation. In this way we have simmetry: - ManagerProxyImpl is used to convert the IDL interface of the Manager into acs.maci.Manager on the servant/skeleton side - ManagerProsy is used to convert from acs.maci.Manager into the IDL interface on the client/stub side

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

See Also:

Serialized Form

Nested Class Summary

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

Manager.LongCompletionCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected si.ijs.maci.Manager	manager CORBA reference.

Fields inherited from interface com.cosylab.acs.maci.ManagerConstants

RELEASE_IMMEDIATELY, RELEASE_NEVER, RELEASE_TIME_UNDEFINED

Constructor Summary

Constructors

Constructor and Description
ManagerProxy(si.ijs.maci.Manager manager) Constructor for ManagerProxy.

Method Summary

Modifier and Type	Method and Description
boolean	equals(org.omg.CORBA.Object obj)
int	forceReleaseComponent(int id, java.net.URI curl) Forcefully release a component.
ClientInfo[]	getClientInfo(int id, int[] handles, java.lang.String name_wc) Get all the information that the Manager has about its known clients.
ComponentInfo	getCollocatedComponent(int id, ComponentSpec componentSpec, boolean markAsDefault, java.net.URI targetComponentURI) Activation of an co-deployed component.
Component	getComponent(int id, java.net.URI curl, boolean activate, StatusHolder status) Get a component, activating it if necessary.
ComponentInfo[]	getComponentInfo(int id, int[] handles, java.lang.String name_wc, java.lang.String type_wc, boolean activeOnly) Get all the information that the Manager has about components.
Component	getComponentNonSticky(int id, java.net.URI curl) Get a component, do not activate it and also do not do any reference counting.
Component[]	getComponents(int id, java.net.URI[] curls, boolean activate, StatusSeqHolder statuses) Deprecated.
ContainerInfo[]	getContainerInfo(int id, int[] handles, java.lang.String name_wc) Get all the information that the Manager has about its known containers.
ComponentInfo	getDefaultComponent(int id, java.lang.String type) Get default component of given type.
java.lang.String	getDomain() Return the fully qualified name of the domain, e.g., "antenna1.alma.nrao".
ComponentInfo	getDynamicComponent(int id, ComponentSpec componentSpec, boolean markAsDefault) Activation of an dynamic component.
ComponentInfo[]	getDynamicComponents(int id, ComponentSpec[] components) Deprecated.
si.ijs.maci.Manager	getManager() Returns the manager.
Component	getService(int id, java.net.URI curl, boolean activate, StatusHolder status) Get a service.
Component[]	getServices(int id, java.net.URI[] curls, boolean activate, StatusSeqHolder statuses) Deprecated.
ClientInfo	login(Client reference) Login to MACI.
void	logout(int id) Logout from MACI.
void	makeComponentImmortal(int id, java.net.URI curl, boolean immortalState) Change mortality state of an component.
int	registerComponent(int id, java.net.URI curl, java.lang.String type, Component cob) Register a CORBA object as a component, assigning it a CURL and making it accessible through the Manager.
int	releaseComponent(int id, java.net.URI curl) Release a component.
void	releaseComponentAsync(int id, java.net.URI curl, Manager.LongCompletionCallback callback)
void	releaseComponents(int id, java.net.URI[] curls) Deprecated.
Component	restartComponent(int id, java.net.URI curl) Restart a component.
void	setStatePersistence(int id, boolean enable) Enable/disable state persistence subsystem.
void	shutdown(int id, int containers) Shutdown the Manager.
void	shutdownContainer(int id, java.lang.String containerName, int action) Shutdown a container.
java.lang.String	toString() Returns a single-line rendition of this instance into text.
void	unregisterComponent(int id, int handle) Unregister a component from the Manager.

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

deserialize, getOrb, serialize, setOrb

Methods inherited from class java.lang.Object

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

Field Detail

manager

protected si.ijs.maci.Manager manager

CORBA reference.

Constructor Detail

ManagerProxy

public ManagerProxy(si.ijs.maci.Manager manager)

Constructor for ManagerProxy.

Parameters:

manager - CORBA reference, non-null.

Method Detail

getClientInfo

public ClientInfo[] getClientInfo(int id,
                                  int[] handles,
                                  java.lang.String name_wc)
                           throws AcsJNoPermissionEx

Description copied from interface: Manager

Get all the information that the Manager has about its known clients. To invoke this method, the caller must have INTROSPECT_MANAGER access rights, or it must be the object whose info it is requesting (request by handle sequence of length one). Calling this function does not affect the internal state of the Manager.

Specified by:

getClientInfo in interface Manager

Parameters:

id - Identification of the caller.

handles - Handles of the clients whose information is requested. If this is an empty sequence, the name_wc parameter is used.

name_wc - Wildcard that the clients's name must match in order for its information to be returned.

Returns:

A sequence of ClientInfo structures containing the entire Manager's knowledge about the containers. If access is denied to a subset of objects, the handles to those objects are set to 0.

Throws:

AcsJNoPermissionEx

See Also:

Manager.getClientInfo(int, int[], java.lang.String)

getComponent

public Component getComponent(int id,
                              java.net.URI curl,
                              boolean activate,
                              StatusHolder status)
                       throws AcsJNoPermissionEx

Description copied from interface: Manager

Get a component, activating it if necessary. The client represented by id (the handle) must have adequate access rights to access the component. This is untrue of components: components always have unlimited access rights to other components.

Specified by:

getComponent in interface Manager

Parameters:

id - Identification of the caller. If this is an invalid handle, or if the caller does not have enough access rights, a AcsJNoPermissionEx exception is raised.

curl - CURL of the component whose reference is to be retrieved.

activate - true if the Component is to be activated in case it does not exist. If set to false, and the Component exist, a null reference is returned and status is set to COMPONENT_NOT_ACTIVATED.

status - Status of the request. One of COMPONENT_ACTIVATED, COMPONENT_DOES_NO_EXIST and COMPONENT_NOT_ACTIVATED.

Returns:

Reference to the Component. If the Component could not be activated, a nil reference is returned, and the status contains an error code detailing the cause of failure (one of the component_* constants).

Throws:

AcsJNoPermissionEx

See Also:

Manager.getComponent(int, java.net.URI, boolean, com.cosylab.acs.maci.StatusHolder)

getComponentInfo

public ComponentInfo[] getComponentInfo(int id,
                                        int[] handles,
                                        java.lang.String name_wc,
                                        java.lang.String type_wc,
                                        boolean activeOnly)
                                 throws AcsJNoPermissionEx

Description copied from interface: Manager

Get all the information that the Manager has about components. To invoke this method, the caller must have INTROSPECT_MANAGER access rights, or it must have adequate privileges to access the Component (the same as with the get_component method). Information about all components is returned, unless the active_only parameter is set to true, in which case only information about those components that are currently registered with the Manager and activated is returned. Calling this function does not affect the internal state of the Manager.

Specified by:

getComponentInfo in interface Manager

Parameters:

id - Identification of the caller.

handles - Handles of the components whose information is requested. If this is an empty sequence, the name_wc and type_wc parameters are used.

name_wc - Wildcard that the Component's name must match in order for its information to be returned.

type_wc - Wildcard that the Component's type must match in order for its information to be returned.

activeOnly - If true returns information only about components that are activated.

Returns:

A sequence of ComponentInfo structures containing the entire Manager's knowledge about the components. If access is denied to a subset of objects, the handles to those objects are set to 0.

Throws:

AcsJNoPermissionEx

See Also:

Manager.getComponentInfo(int, int[], java.lang.String, java.lang.String, boolean)

getComponents

public Component[] getComponents(int id,
                                 java.net.URI[] curls,
                                 boolean activate,
                                 StatusSeqHolder statuses)
                          throws AcsJNoPermissionEx

Deprecated.

Throws:

AcsJNoPermissionEx

See Also:

com.cosylab.acs.maci.Manager#getComponents(int, java.net.URI[], boolean, com.cosylab.acs.maci.StatusSeqHolder)

getContainerInfo

public ContainerInfo[] getContainerInfo(int id,
                                        int[] handles,
                                        java.lang.String name_wc)
                                 throws AcsJNoPermissionEx

Description copied from interface: Manager

Get all the information that the Manager has about its known containers. To invoke this method, the caller must have INTROSPECT_MANAGER access rights, or it must be the object whose info it is requesting (request by handle sequence of length one). Calling this function does not affect the internal state of the Manager.

Specified by:

getContainerInfo in interface Manager

Parameters:

id - Identification of the caller.

handles - Handles of the containers whose information is requested. If this is an empty sequence, the name_wc parameter is used.

name_wc - Wildcard that the container's name must match in order for its information to be returned.

Returns:

A sequence of ContainerInfo structures containing the entire Manager's knowledge about the containers. If access is denied to a subset of objects, the handles to those objects are set to 0.

Throws:

AcsJNoPermissionEx

See Also:

Manager.getContainerInfo(int, int[], java.lang.String)

getDefaultComponent

public ComponentInfo getDefaultComponent(int id,
                                         java.lang.String type)
                                  throws AcsJNoPermissionEx,
                                         NoDefaultComponentException

Description copied from interface: Manager

Get default component of given type. The client represented by id (the handle) must have adequate access rights to access the component.

Specified by:

getDefaultComponent in interface Manager

Parameters:

id - Identification of the caller. If this is an invalid handle, or if the caller does not have enough access rights, a AcsJNoPermissionEx exception is raised.

type - type of the component whose reference is to be restarted.

Returns:

ComponentInfo of the component. If no defualt component is found NoDefaultComponentException exception is thrown.

Throws:

AcsJNoPermissionEx

NoDefaultComponentException

See Also:

Manager.getDefaultComponent(int, java.lang.String)

getDomain

public java.lang.String getDomain()

Description copied from interface: Manager

Return the fully qualified name of the domain, e.g., "antenna1.alma.nrao".

Specified by:

getDomain in interface Manager

Returns:

the fully qualified name of the domain

See Also:

Manager.getDomain()

getDynamicComponent

public ComponentInfo getDynamicComponent(int id,
                                         ComponentSpec componentSpec,
                                         boolean markAsDefault)
                                  throws AcsJCannotGetComponentEx,
                                         AcsJNoPermissionEx,
                                         AcsJIncompleteComponentSpecEx,
                                         AcsJInvalidComponentSpecEx,
                                         AcsJComponentSpecIncompatibleWithActiveComponentEx

Description copied from interface: Manager

Activation of an dynamic component.

Specified by:

getDynamicComponent in interface Manager

Parameters:

id - Identification of the caller.

componentSpec - Component to be obtained.

markAsDefault - Mark component as default component of its type.

Returns:

ComponentInfo of requested component. If componentSpec if found to be incomplete IncompleteComponentSpecException exception is thrown. If requested component collides with already activated component with the same name ComponentSpecIncompatibleWithActiveComponentException exception is thrown.

Throws:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

AcsJIncompleteComponentSpecEx

AcsJInvalidComponentSpecEx

AcsJComponentSpecIncompatibleWithActiveComponentEx

See Also:

Manager.getDynamicComponent(int, com.cosylab.acs.maci.ComponentSpec, boolean)

getDynamicComponents

public ComponentInfo[] getDynamicComponents(int id,
                                            ComponentSpec[] components)
                                     throws AcsJNoPermissionEx

Deprecated.

Throws:

AcsJNoPermissionEx

See Also:

com.cosylab.acs.maci.Manager#getDynamicComponents(int, com.cosylab.acs.maci.ComponentSpec[])

getCollocatedComponent

public ComponentInfo getCollocatedComponent(int id,
                                            ComponentSpec componentSpec,
                                            boolean markAsDefault,
                                            java.net.URI targetComponentURI)
                                     throws AcsJCannotGetComponentEx,
                                            AcsJNoPermissionEx,
                                            AcsJIncompleteComponentSpecEx,
                                            AcsJInvalidComponentSpecEx,
                                            AcsJComponentSpecIncompatibleWithActiveComponentEx

Description copied from interface: Manager

Activation of an co-deployed component.

Specified by:

getCollocatedComponent in interface Manager

Parameters:

id - Identification of the caller.

componentSpec - Component to be obtained.

markAsDefault - Mark component as default component of its type.

targetComponentURI - target co-deployed component.

Returns:

ComponentInfo of requested component. If componentSpec if found to be incomplete IncompleteComponentSpecException exception is thrown. If requested component collides with already activated component with the same name ComponentSpecIncompatibleWithActiveComponentException exception is thrown.

Throws:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

AcsJIncompleteComponentSpecEx

AcsJInvalidComponentSpecEx

AcsJComponentSpecIncompatibleWithActiveComponentEx

See Also:

Manager.getCollocatedComponent(int, com.cosylab.acs.maci.ComponentSpec, boolean, URI)

getComponentNonSticky

public Component getComponentNonSticky(int id,
                                       java.net.URI curl)
                                throws AcsJCannotGetComponentEx,
                                       AcsJNoPermissionEx

Description copied from interface: Manager

Get a component, do not activate it and also do not do any reference counting. The client represented by id (the handle) must have adequate access rights to access the Component. This is untrue of components: components always have unlimited access rights to other components.

Specified by:

getComponentNonSticky in interface Manager

Parameters:

id - Identification of the caller. If this is an invalid handle, or if the caller does not have enough access rights, a AcsJNoPermissionEx exception is raised.

Returns:

Reference to the Component.

Throws:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

See Also:

Manager.getComponentNonSticky(int, java.net.URI)

getService

public Component getService(int id,
                            java.net.URI curl,
                            boolean activate,
                            StatusHolder status)
                     throws AcsJNoPermissionEx

Description copied from interface: Manager

Get a service. NOTE: a component is also a service, i.e. a service activated by a container.

Specified by:

getService in interface Manager

Throws:

AcsJNoPermissionEx

See Also:

Manager.getService(int, java.net.URI, boolean, com.cosylab.acs.maci.StatusHolder)

getServices

public Component[] getServices(int id,
                               java.net.URI[] curls,
                               boolean activate,
                               StatusSeqHolder statuses)
                        throws AcsJNoPermissionEx

Deprecated.

Throws:

AcsJNoPermissionEx

See Also:

com.cosylab.acs.maci.Manager#getServices(int, java.net.URI[], boolean, com.cosylab.acs.maci.StatusSeqHolder)

login

public ClientInfo login(Client reference)
                 throws AcsJNoPermissionEx

Description copied from interface: Manager

Login to MACI. Containers, Clients and Administrative clients call this function first to identify themselves with the Manager. The Manager authenticates them (through the authenticate function), and assigns them access rights and a handle, through which they will identify themselves at subsequent calls to the Manager.

Specified by:

login in interface Manager

Parameters:

reference - A reference to the Client.

Returns:

A ClientInfo structure with handle (h) and access fields filled-in. If the client with this name did not logout prior to calling login, the components sequence in ClientInfo contains the handles of all components that the client was using. (For containers, the components sequence contains handles of all components previously hosted by the Container.)

Throws:

AcsJNoPermissionEx

See Also:

Manager.login(com.cosylab.acs.maci.Client)

logout

public void logout(int id)
            throws AcsJNoPermissionEx

Description copied from interface: Manager

Logout from MACI.

Specified by:

logout in interface Manager

Parameters:

id - Handle of the Client that is logging out

Throws:

AcsJNoPermissionEx

See Also:

Manager.logout(int)

registerComponent

public int registerComponent(int id,
                             java.net.URI curl,
                             java.lang.String type,
                             Component cob)
                      throws AcsJNoPermissionEx

Description copied from interface: Manager

Register a CORBA object as a component, assigning it a CURL and making it accessible through the Manager. The component is treated as an immortal Component.

Specified by:

registerComponent in interface Manager

Parameters:

id - Identification of the caller. The caller must have the REGISTER_COMPONENT access right to perform this operation.

curl - CURL that will be assigned to the object. The CURL must be in the Manager's domain, otherwise a fundamental property of domains that one computer belongs to only one domain would be too easy to violate.

type - Type of the component

cob - Object to be registered as component.

Returns:

Returns the handle of the newly registered component.

Throws:

AcsJNoPermissionEx

See Also:

Manager.registerComponent(int, java.net.URI, java.lang.String, com.cosylab.acs.maci.Component)

releaseComponent

public int releaseComponent(int id,
                            java.net.URI curl)
                     throws AcsJNoPermissionEx

Description copied from interface: Manager

Release a component. In order for this operation to be possible, the caller represented by the id must have previously successfuly requested the component via a call to get_component. Releasing a component more times than requesting it should be avoided, but it produces no errors.

Specified by:

releaseComponent in interface Manager

Parameters:

id - Identification of the caller. The caller must have previously got the Component through get_component.

curl - The CURL of the Component to be released.

Returns:

Number of clients that are still using the Component after the operation completed. This is a useful debugging tool.

Throws:

AcsJNoPermissionEx

See Also:

Manager.releaseComponent(int, java.net.URI)

releaseComponents

public void releaseComponents(int id,
                              java.net.URI[] curls)
                       throws AcsJNoPermissionEx

Deprecated.

Throws:

AcsJNoPermissionEx

See Also:

com.cosylab.acs.maci.Manager#releaseComponents(int, java.net.URI[])

forceReleaseComponent

public int forceReleaseComponent(int id,
                                 java.net.URI curl)
                          throws AcsJNoPermissionEx

Description copied from interface: Manager

Forcefully release a component.

Specified by:

forceReleaseComponent in interface Manager

Parameters:

id - Identification of the caller.

curl - The CURL of the Component to be released.

Returns:

Number of clients that are still using the Component after the operation completed. This is a useful debugging tool.

Throws:

AcsJNoPermissionEx

See Also:

Manager.forceReleaseComponent(int, java.net.URI)

restartComponent

public Component restartComponent(int id,
                                  java.net.URI curl)
                           throws AcsJNoPermissionEx

Description copied from interface: Manager

Restart a component. The client represented by id (the handle) must be a owner of a component.

Specified by:

restartComponent in interface Manager

Parameters:

id - Identification of the caller. If this is an invalid handle, or if the caller does not have enough access rights, a AcsJNoPermissionEx exception is raised.

curl - CURL of the component whose reference is to be restarted.

Returns:

Reference to the component. If the component could not be restarted, a nil reference is returned.

Throws:

AcsJNoPermissionEx

See Also:

Manager.restartComponent(int, java.net.URI)

shutdown

public void shutdown(int id,
                     int containers)
              throws AcsJNoPermissionEx

Description copied from interface: Manager

Shutdown the Manager. Warning: This call will also deactivate all components active in the system, including startup and immortal components.

Specified by:

shutdown in interface Manager

Parameters:

id - Identification of the caller. The caller must have the SHUTDOWN_SYSTEM access right.

containers - The code to send to shutdown methods of all containers. If 0, the Container's shutdown methods are not called.

Throws:

AcsJNoPermissionEx

See Also:

Manager.shutdown(int, int)

unregisterComponent

public void unregisterComponent(int id,
                                int handle)
                         throws AcsJNoPermissionEx

Description copied from interface: Manager

Unregister a component from the Manager.

Specified by:

unregisterComponent in interface Manager

Parameters:

id - Identification of the caller. The caller must have the REGISTER_COMPONENT access right to perform this operation.

handle - Component's handle. The component must have been previously registered through the call to register_component. If there are clients still using this component, a components_unavailable notification is issued to all of them, and the component is unregistered.

Throws:

AcsJNoPermissionEx

See Also:

Manager.unregisterComponent(int, int)

shutdownContainer

public void shutdownContainer(int id,
                              java.lang.String containerName,
                              int action)
                       throws AcsJNoPermissionEx

Description copied from interface: Manager

Shutdown a container.

Specified by:

shutdownContainer in interface Manager

Parameters:

id - Identification of the caller. The caller must have the SHUTDOWN_SYSTEM access right.

action - The code to send to shutdown method of the container. If 0, the Container's disconnect methods is called instead.

Throws:

AcsJNoPermissionEx

See Also:

Manager.shutdownContainer(int, java.lang.String, int)

makeComponentImmortal

public void makeComponentImmortal(int id,
                                  java.net.URI curl,
                                  boolean immortalState)
                           throws AcsJNoPermissionEx

Description copied from interface: Manager

Change mortality state of an component. Compnent must be already active, otherwise NoResourcesException exception will be thrown. The caller must be an owner of an component or have administator rights, otherwise AcsJNoPermissionEx exception will be thrown.

Specified by:

makeComponentImmortal in interface Manager

Parameters:

id - Identification of the caller. The caller must be an owner of an component or have administator rights.

curl - The CURL of the component whose mortality to change.

immortalState - New mortality state.

Throws:

AcsJNoPermissionEx

See Also:

Manager.makeComponentImmortal(int, java.net.URI, boolean)

setStatePersistence

public void setStatePersistence(int id,
                                boolean enable)
                         throws AcsJNoPermissionEx

Description copied from interface: Manager

Enable/disable state persistence subsystem.

Specified by:

setStatePersistence in interface Manager

Parameters:

id - Identification of the caller.

enable - enable/disable switch.

Throws:

AcsJNoPermissionEx

See Also:

Manager.setStatePersistence(int, boolean)

getManager

public si.ijs.maci.Manager getManager()

Returns the manager.

Returns:

si.ijs.maci.Manager

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

internal state of this instance

equals

public boolean equals(org.omg.CORBA.Object obj)

See Also:

Object.equals(Object)

releaseComponentAsync

public void releaseComponentAsync(int id,
                                  java.net.URI curl,
                                  Manager.LongCompletionCallback callback)
                           throws AcsJNoPermissionEx,
                                  AcsJBadParameterEx

Specified by:

releaseComponentAsync in interface Manager

Throws:

AcsJNoPermissionEx

AcsJBadParameterEx