com.cosylab.acs.maci.plug

Class ManagerProxyImpl

java.lang.Object

ManagerPOA

com.cosylab.acs.maci.plug.ManagerProxyImpl

public class ManagerProxyImpl
extends ManagerPOA

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 class implements the IDL interface of Manager and acts like a proxy, by delegating all requests to an implementation of the com.cosylab.acs.maci.Manager interface.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

Constructor Summary

Constructors

Constructor and Description
ManagerProxyImpl(Manager manager, java.util.logging.Logger logger) Construct a new Manager which will manager implementation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	domain_name() Return the fully qualified name of the domain, e.g., "antenna1.alma.nrao".
int	force_release_component(int id, java.lang.String component_url) Forcefully release a Component.
ClientInfo[]	get_client_info(int id, int[] h, java.lang.String name_wc) Get all the information that the Manager has about its known clients.
ComponentInfo	get_collocated_component(int id, si.ijs.maci.ComponentSpec c, boolean mark_as_default, java.lang.String target_component) Activation of an co-deployed component.
ComponentInfo[]	get_component_info(int id, int[] h, java.lang.String name_wc, java.lang.String type_wc, boolean active_only) Get all the information that the Manager has about components.
org.omg.CORBA.Object	get_component_non_sticky(int id, java.lang.String component_url) Get a component, do not activate it and also do not do any reference counting.
org.omg.CORBA.Object	get_component(int id, java.lang.String component_url, boolean activate) Get a Component, activating it if necessary.
ContainerInfo[]	get_container_info(int id, int[] h, java.lang.String name_wc) Get all the information that the Manager has about its known Containers.
ComponentInfo	get_default_component(int id, java.lang.String type) Returns the default component of specific type.
LogLevels	get_default_logLevels() Gets the log levels of the default logging configuration.
ComponentInfo	get_dynamic_component(int id, si.ijs.maci.ComponentSpec c, boolean mark_as_default) Activation of an dynamic component.
java.lang.String[]	get_logger_names() Gets the names of all loggers, to allow configuring their levels individually.
LogLevels	get_logLevels(java.lang.String logger_name) Gets log levels for a particular named logger.
org.omg.CORBA.Object	get_service(int id, java.lang.String service_url, boolean activate) Get a service, activating it if necessary (components).
int	getNumberOfPendingRequests() Returns number of pending requests.
ClientInfo	login(Client reference) Login to MACI.
void	logout(int id) Logout from MACI.
void	make_component_immortal(int id, java.lang.String component_url, boolean immortal_state) Change mortality state of an component.
static int	mapAccessRights(int accessRights) Map AccessRights status codes to CORBA specific.
boolean	ping() Ping method so that clients can feel good about having an alive manager.
void	refresh_logging_config() Commands the container or manager to read in again the logging configuration from the CDB and to reconfigure the loggers accordingly.
int	register_component(int id, java.lang.String component_url, java.lang.String type, org.omg.CORBA.Object component) Register a CORBA object as a Component, assigning it a CURL and making it accessible through the Manager.
void	release_component_async(int id, java.lang.String component_url, CBlong callback, CBDescIn desc)
int	release_component(int id, java.lang.String component_url) Release a Component.
org.omg.CORBA.Object	restart_component(int id, java.lang.String component_url) Restarts an component.
void	set_default_logLevels(LogLevels levels) Sets the log levels of the default logging configuration.
void	set_logLevels(java.lang.String logger_name, LogLevels levels) Sets log levels for a particular named logger.
void	set_state_persistence(int id, boolean enable)
void	shutdown_container(int id, java.lang.String container_name, int action) Shutdown a container.
void	shutdown(int id, int containers) Shutdown the Manager.
java.lang.String	toString() Returns a single-line rendition of this instance into text.
void	unregister_component(int id, int h) Unregister a Component from the Manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagerProxyImpl

public ManagerProxyImpl(Manager manager,
                        java.util.logging.Logger logger)

Construct a new Manager which will manager implementation.

Parameters:

manager - implementation of the manager, non-null.

logger - logger.

Method Detail

ping

public boolean ping()

Ping method so that clients can feel good about having an alive manager.

See Also:

si.ijs.maci.ManagerOperations#ping()

domain_name

public java.lang.String domain_name()

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

Returns:

the fully qualified name of the domain

get_container_info

public ContainerInfo[] get_container_info(int id,
                                          int[] h,
                                          java.lang.String name_wc)
                                   throws NoPermissionEx

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. Calling this function does not affect the internal state of the Manager.

Parameters:

id - Identification of the caller.

h - 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:

NoPermissionEx

get_client_info

public ClientInfo[] get_client_info(int id,
                                    int[] h,
                                    java.lang.String name_wc)
                             throws NoPermissionEx

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. Calling this function does not affect the internal state of the Manager.

Parameters:

id - Identification of the caller.

h - 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:

NoPermissionEx

get_component_info

public ComponentInfo[] get_component_info(int id,
                                          int[] h,
                                          java.lang.String name_wc,
                                          java.lang.String type_wc,
                                          boolean active_only)
                                   throws NoPermissionEx

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.

h - 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.

active_only -

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:

NoPermissionEx

get_component

public org.omg.CORBA.Object get_component(int id,
                                          java.lang.String component_url,
                                          boolean activate)
                                   throws NoPermissionEx,
                                          CannotGetComponentEx,
                                          ComponentNotAlreadyActivatedEx,
                                          ComponentConfigurationNotFoundEx

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 maciErrType::NoPermissionEx exception is raised.

component_url - 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 does not exist, a nil reference is returned and status is set to COMPONENT_NOT_ACTIVATED.

Returns:

Reference to the Component. If the Component could not be activated, an exception is throw.

Throws:

NoPermissionEx

CannotGetComponentEx

ComponentNotAlreadyActivatedEx

ComponentConfigurationNotFoundEx

get_component_non_sticky

public org.omg.CORBA.Object get_component_non_sticky(int id,
                                                     java.lang.String component_url)
                                              throws NoPermissionEx,
                                                     CannotGetComponentEx,
                                                     ComponentNotAlreadyActivatedEx

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 maciErrType::NoPermissionEx exception is raised.

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

Returns:

Reference to the Component.

Throws:

NoPermissionEx

CannotGetComponentEx

ComponentNotAlreadyActivatedEx

login

public ClientInfo login(Client reference)
                 throws NoPermissionEx

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:

NoPermissionEx

logout

public void logout(int id)
            throws NoPermissionEx

Logout from MACI.

Parameters:

id - Handle of the Client that is logging out

Throws:

NoPermissionEx

register_component

public int register_component(int id,
                              java.lang.String component_url,
                              java.lang.String type,
                              org.omg.CORBA.Object component)
                       throws NoPermissionEx,
                              CannotRegisterComponentEx

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.

component_url - 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

Component - Reference to the CORBA object (Component).

Returns:

Returns the handle of the newly created Component.

Throws:

NoPermissionEx

CannotRegisterComponentEx

make_component_immortal

public void make_component_immortal(int id,
                                    java.lang.String component_url,
                                    boolean immortal_state)
                             throws NoPermissionEx,
                                    ComponentNotAlreadyActivatedEx

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

Parameters:

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

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

immortal_state - New mortality state.

Throws:

NoPermissionEx

ComponentNotAlreadyActivatedEx

release_component_async

public void release_component_async(int id,
                                    java.lang.String component_url,
                                    CBlong callback,
                                    CBDescIn desc)
                             throws NoPermissionEx

Throws:

NoPermissionEx

release_component

public int release_component(int id,
                             java.lang.String component_url)
                      throws CannotDeactivateComponentEx,
                             ComponentDeactivationUncleanEx,
                             ComponentDeactivationFailedEx,
                             NoPermissionEx

Release a Component. In order for this operation to be possible, the caller represented by the id must have previously successfully 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 gotten the Component through get_component.

component_url - 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:

CannotDeactivateComponentEx

ComponentDeactivationUncleanEx

ComponentDeactivationFailedEx

NoPermissionEx

force_release_component

public int force_release_component(int id,
                                   java.lang.String component_url)
                            throws NoPermissionEx

Forcefully release a Component.

Parameters:

id - Identification of the caller.

component_url - 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:

NoPermissionEx

shutdown

public void shutdown(int id,
                     int containers)

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.

unregister_component

public void unregister_component(int id,
                                 int h)
                          throws NoPermissionEx

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.

h - 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:

NoPermissionEx

get_default_component

public ComponentInfo get_default_component(int id,
                                           java.lang.String type)
                                    throws NoPermissionEx,
                                           NoDefaultComponentEx,
                                           CannotGetComponentEx

Returns the default component of specific type.

Parameters:

id - identification of the caller.

type - component type, IDL ID.

Returns:

ComponentInfo of requested component.

Throws:

NoPermissionEx

NoDefaultComponentEx

CannotGetComponentEx

get_dynamic_component

public ComponentInfo get_dynamic_component(int id,
                                           si.ijs.maci.ComponentSpec c,
                                           boolean mark_as_default)
                                    throws NoPermissionEx,
                                           IncompleteComponentSpecEx,
                                           InvalidComponentSpecEx,
                                           ComponentSpecIncompatibleWithActiveComponentEx,
                                           CannotGetComponentEx

Activation of an dynamic component.

Parameters:

id - identification of the caller.

c - component to be obtained.

mark_as_default - mark component as default component of its type.

Returns:

ComponentInfo of requested component.

Throws:

NoPermissionEx

IncompleteComponentSpecEx

InvalidComponentSpecEx

ComponentSpecIncompatibleWithActiveComponentEx

CannotGetComponentEx

get_collocated_component

public ComponentInfo get_collocated_component(int id,
                                              si.ijs.maci.ComponentSpec c,
                                              boolean mark_as_default,
                                              java.lang.String target_component)
                                       throws NoPermissionEx,
                                              IncompleteComponentSpecEx,
                                              InvalidComponentSpecEx,
                                              ComponentSpecIncompatibleWithActiveComponentEx,
                                              CannotGetComponentEx

Activation of an co-deployed component.

Parameters:

id - identification of the caller.

c - component to be obtained.

mark_as_default - mark component as default component of its type.

target_component - target co-deployed component.

Returns:

ComponentInfo of requested co-deployed component.

Throws:

NoPermissionEx

IncompleteComponentSpecEx

InvalidComponentSpecEx

ComponentSpecIncompatibleWithActiveComponentEx

CannotGetComponentEx

get_service

public org.omg.CORBA.Object get_service(int id,
                                        java.lang.String service_url,
                                        boolean activate)
                                 throws NoPermissionEx,
                                        CannotGetComponentEx

Get a service, activating it if necessary (components). The client represented by id (the handle) must have adequate access rights to access the service. NOTE: a component is also a service, i.e. a service activated by a container.

Parameters:

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

service_url - CURL of the service 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 does not exist, a nil 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 service. If the service could not be obtained, a nil reference is returned, and the status contains an error code detailing the cause of failure (one of the COMPONENT_* constants).

Throws:

NoPermissionEx

CannotGetComponentEx

See Also:

get_component(int, java.lang.String, boolean)

restart_component

public org.omg.CORBA.Object restart_component(int id,
                                              java.lang.String component_url)
                                       throws NoPermissionEx

Restarts an component.

Parameters:

id - identification of the caller. Called has to be an owner of the component.

component_url - CURL of the component to be restarted.

Returns:

CORBA reference of the restarted component, null if it fails.

Throws:

NoPermissionEx

shutdown_container

public void shutdown_container(int id,
                               java.lang.String container_name,
                               int action)
                        throws NoPermissionEx

Shutdown a container.

Parameters:

id - identification of the caller. Called has to be an owner of the component.

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:

NoPermissionEx

set_state_persistence

public void set_state_persistence(int id,
                                  boolean enable)
                           throws NoPermissionEx

Throws:

NoPermissionEx

get_default_logLevels

public LogLevels get_default_logLevels()

Gets the log levels of the default logging configuration. These levels are used by all loggers that have not been configured individually.

set_default_logLevels

public void set_default_logLevels(LogLevels levels)
                           throws IllegalLogLevelsEx

Sets the log levels of the default logging configuration. These levels are used by all loggers that have not been configured individually.

Throws:

IllegalLogLevelsEx

get_logger_names

public java.lang.String[] get_logger_names()

Gets the names of all loggers, to allow configuring their levels individually. The names are those that appear in the log records in the field "SourceObject". This includes the container logger, ORB logger, component loggers, and (only C++) GlobalLogger.

get_logLevels

public LogLevels get_logLevels(java.lang.String logger_name)

Gets log levels for a particular named logger. If the returned field LogLevels.useDefault is true, then the logger uses the default levels, see get_default_logLevels(); otherwise the returned local and remote levels apply.

set_logLevels

public void set_logLevels(java.lang.String logger_name,
                          LogLevels levels)
                   throws IllegalLogLevelsEx

Sets log levels for a particular named logger. If levels.useDefault is true, then the logger will be reset to using default levels; otherwise it will use the supplied local and remote levels.

Throws:

IllegalLogLevelsEx

refresh_logging_config

public void refresh_logging_config()

Commands the container or manager to read in again the logging configuration from the CDB and to reconfigure the loggers accordingly. This allows for persistent changes in the logging configuration to become effective, and also for changes of more advanced parameters.

mapAccessRights

public static int mapAccessRights(int accessRights)

Map AccessRights status codes to CORBA specific.

Parameters:

accessRights - access rights as defined in AccessRights

Returns:

CORBA specific access rights code.

getNumberOfPendingRequests

public int getNumberOfPendingRequests()

Returns number of pending requests.

Returns:

number of pending requests.

toString

public java.lang.String toString()

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

Returns:

internal state of this instance