com.cosylab.acs.maci

Interface Manager

All Superinterfaces:

ManagerConstants

All Known Implementing Classes:

ManagerImpl, ManagerProxy

public interface Manager
extends ManagerConstants

Manager is the central point of interaction between the components and the clients that request MACI services. A Manager is responsible for managing a domain. Manager has the following functionality:

• It is the communication entry point.
• It performs as a name service, resolving CURLs into Component references.
• It delegates the Component life cycle management to the Container.
• It provides information about the whole domain.

This interface defines a CORBA-independent interface for the Manager. In ACS, the acs.maci.plugManagerProxyImpl class implements the CORBA interface and delegates toan implementation of this Manager class the real work. NOTE: There is no throws RemoteException in the signature of the methods.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

See Also:

si.ijs.acs.maci.plug.ManagerProxyImpl, si.ijs.acs.maci.plug.ManagerProxy, acs.maci.manager.ManagerImpl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Manager.LongCompletionCallback

Field Summary

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

RELEASE_IMMEDIATELY, RELEASE_NEVER, RELEASE_TIME_UNDEFINED

Method Summary

Modifier and Type	Method and Description
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.
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.
Component	getService(int id, java.net.URI curl, boolean activate, StatusHolder status) Get a service.
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)
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.
void	unregisterComponent(int id, int handle) Unregister a component from the Manager.

Method Detail

getDomain

java.lang.String getDomain()

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

Returns:

the fully qualified name of the domain

getContainerInfo

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

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.

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

getClientInfo

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

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.

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

getComponentInfo

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

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.

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

getComponent

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

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.

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:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

restartComponent

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

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

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

AcsJBadParameterEx

makeComponentImmortal

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

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.

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:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

AcsJBadParameterEx

getService

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

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

Throws:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

See Also:

#get_component

login

ClientInfo login(Client reference)
          throws AcsJNoPermissionEx

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.

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

logout

void logout(int id)
     throws AcsJNoPermissionEx

Logout from MACI.

Parameters:

id - Handle of the Client that is logging out

Throws:

AcsJNoPermissionEx

registerComponent

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

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.

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

AcsJBadParameterEx

releaseComponent

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

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.

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

AcsJBadParameterEx

releaseComponentAsync

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

Throws:

AcsJNoPermissionEx

AcsJBadParameterEx

forceReleaseComponent

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

Forcefully release a component.

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

AcsJBadParameterEx

shutdown

void shutdown(int id,
              int containers)
       throws AcsJNoPermissionEx

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

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

shutdownContainer

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

Shutdown a container.

Parameters:

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

container_name - name of the container to shutdown.

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

Throws:

AcsJNoPermissionEx

unregisterComponent

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

Unregister a component from the 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

AcsJBadParameterEx

getDefaultComponent

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

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

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:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

NoDefaultComponentException

getDynamicComponent

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

Activation of an dynamic component.

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

getCollocatedComponent

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

Activation of an co-deployed component.

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

getComponentNonSticky

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

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.

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.

component_url - CURL of the Component whose reference is to be retrieved.

Returns:

Reference to the Component.

Throws:

AcsJCannotGetComponentEx

AcsJNoPermissionEx

setStatePersistence

void setStatePersistence(int id,
                         boolean enable)
                  throws AcsJNoPermissionEx

Enable/disable state persistence subsystem.

Parameters:

id - Identification of the caller.

enable - enable/disable switch.

Throws:

AcsJNoPermissionEx