alma.acs.commandcenter.meta

Class MaciSupervisor

java.lang.Object

alma.acs.commandcenter.meta.MaciSupervisor

All Implemented Interfaces:

IMaciSupervisor

Direct Known Subclasses:

GuiMaciSupervisor

public class MaciSupervisor
extends java.lang.Object
implements IMaciSupervisor

Author:

mschilli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MaciSupervisor.AdministratorImplementation Implementation of Administrator Interface
protected class	MaciSupervisor.ManagerConnectionExceptionHandler
protected class	MaciSupervisor.RefreshIfNeeded

Nested classes/interfaces inherited from interface alma.acs.commandcenter.meta.IMaciSupervisor

IMaciSupervisor.CannotRetrieveManagerException, IMaciSupervisor.CorbaNoPermissionException, IMaciSupervisor.CorbaNotExistException, IMaciSupervisor.CorbaTransientException, IMaciSupervisor.CorbaUnknownException, IMaciSupervisor.MaciSupervisorException, IMaciSupervisor.NotConnectedToManagerException, IMaciSupervisor.UnknownErrorException

Field Summary

Fields

Modifier and Type	Field and Description
protected MaciSupervisor.AdministratorImplementation	acImpl Instantiated in constructor.
protected ClientInfo	administratorClientInfo assigned in connectToManager().
protected boolean	connectsAutomatically
protected boolean	infoShouldBeRefreshed The 'refresh needed' flag used by the lazy-refresh timer task.
protected java.util.logging.Logger	log
protected MaciInfo	maciInfo
protected java.lang.String	managerLoc
protected Manager	managerRef assigned in connectToManager()
protected MaciSupervisor.ManagerConnectionExceptionHandler	mcehandler
protected java.lang.String	name
protected org.omg.CORBA.ORB	orb
protected int	refreshCountdown
protected int	refreshCountFrom
protected int	refreshLag
protected MaciSupervisor.RefreshIfNeeded	refreshTask
protected boolean	refreshWithoutACause
protected java.util.Timer	timer

Fields inherited from interface alma.acs.commandcenter.meta.IMaciSupervisor

MSG_ERROR, MSG_INFORMATION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MaciSupervisor(java.lang.String clientName, java.lang.String managerLoc, org.omg.CORBA.ORB orb, java.util.logging.Logger log) Creates a MaciSupervisor running on the given ORB, it will connect to the specified manager.

Method Summary

Modifier and Type	Method and Description
protected void	connectToManager()
protected void	disconnectFromManager()
void	dismissManager() msc (2004-11-09): This was requested, suggested, and agreed upon as a workaround for the situation where a manager has gone down (and the application using this macisupervisor knows that the manager is down, e.g.
protected java.lang.String	extractLocation(org.omg.CORBA.Object reference) Helper for createNode()
MaciInfo	getMaciInfo() Returns a TreeModel compiled from information from the Acs manager.
MaciInfo	getMaciInformation() Returns a TreeModel compiled from information from the Acs manager.
java.lang.String	getManagerLocation() Some people are interested in the weirdest things..
boolean	isConnected() Whether this is connected
int	myMaciHandle() Returns the handle given by the manager.
protected Manager	myManagerReference()
void	refreshNow() Tries to refresh the component-section, container-section, and client-section of the info tree model.
void	refreshSoon() Request the MaciInfo be refreshed in the background.
protected ClientInfo[]	retrieveClientInfo(java.lang.String name_wildcard)
protected ComponentInfo[]	retrieveComponentInfo(java.lang.String name_wildcard)
protected ContainerInfo[]	retrieveContainerInfo(java.lang.String name_wildcard) The containerHandles argument cannot be specified here.
void	setConnectsAutomatically(boolean b)
void	setRefreshDelay(int lag, int period) Configures the polling rate and responsiveness for updates from the manager.
void	setRefreshesPeriodically(boolean b) Refresh every once in a while, even if there wasn't any indication from the manager that something has changed.
void	start() This start implementation is smart, it can be called repeatedly.
void	stop() Tear down this instance.
java.lang.String	toString() Overridden to provide pretty description.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

managerLoc

protected java.lang.String managerLoc

orb

protected org.omg.CORBA.ORB orb

log

protected java.util.logging.Logger log

connectsAutomatically

protected volatile boolean connectsAutomatically

mcehandler

protected volatile MaciSupervisor.ManagerConnectionExceptionHandler mcehandler

maciInfo

protected final MaciInfo maciInfo

refreshWithoutACause

protected volatile boolean refreshWithoutACause

refreshCountdown

protected volatile int refreshCountdown

refreshCountFrom

protected volatile int refreshCountFrom

refreshLag

protected volatile int refreshLag

refreshTask

protected MaciSupervisor.RefreshIfNeeded refreshTask

timer

protected java.util.Timer timer

managerRef

protected Manager managerRef

assigned in connectToManager()

infoShouldBeRefreshed

protected volatile boolean infoShouldBeRefreshed

The 'refresh needed' flag used by the lazy-refresh timer task.

administratorClientInfo

protected volatile ClientInfo administratorClientInfo

assigned in connectToManager(). unassigned in disconnectFromManager(). This means, this field indicates the "connected" status.

acImpl

protected volatile MaciSupervisor.AdministratorImplementation acImpl

Instantiated in constructor. The retrieved descriptor will be stored in field administratorClientInfo.

Constructor Detail

MaciSupervisor

protected MaciSupervisor(java.lang.String clientName,
                         java.lang.String managerLoc,
                         org.omg.CORBA.ORB orb,
                         java.util.logging.Logger log)

Creates a MaciSupervisor running on the given ORB, it will connect to the specified manager.

Parameters:

clientName - name-prefix like "AcsCommandCenter" or "OMC"

managerLoc - the manager corbaloc

orb - the orb to use

Method Detail

setConnectsAutomatically

public void setConnectsAutomatically(boolean b)

start

public void start()
           throws NoPermissionEx,
                  IMaciSupervisor.CannotRetrieveManagerException,
                  IMaciSupervisor.CorbaTransientException,
                  IMaciSupervisor.CorbaNotExistException,
                  IMaciSupervisor.UnknownErrorException

This start implementation is smart, it can be called repeatedly.

Specified by:

start in interface IMaciSupervisor

Throws:

NoPermissionEx

CorbaTransientException

CorbaNotExistException

UnknownErrorException

IMaciSupervisor.CannotRetrieveManagerException

IMaciSupervisor.CorbaTransientException

IMaciSupervisor.CorbaNotExistException

IMaciSupervisor.UnknownErrorException

stop

public void stop()

Tear down this instance.

Specified by:

stop in interface IMaciSupervisor

dismissManager

public void dismissManager()

msc (2004-11-09): This was requested, suggested, and agreed upon as a workaround for the situation where a manager has gone down (and the application using this macisupervisor knows that the manager is down, e.g. because it made it go down) while this macisupervisor does not yet know that the manager is down. It will only realize that the next time it tries to access it. Doing so will provoke some no_permission error messages in the manager log. To enable the application to avoid these error messages this API method was added.

Specified by:

dismissManager in interface IMaciSupervisor

isConnected

public boolean isConnected()

Whether this is connected

Specified by:

isConnected in interface IMaciSupervisor

myMaciHandle

public int myMaciHandle()
                 throws IMaciSupervisor.NotConnectedToManagerException

Description copied from interface: IMaciSupervisor

Returns the handle given by the manager.

Specified by:

myMaciHandle in interface IMaciSupervisor

Returns:

the handle given by the manager.

Throws:

NotConnectedToManagerException

IMaciSupervisor.NotConnectedToManagerException

myManagerReference

protected Manager myManagerReference()
                              throws IMaciSupervisor.NotConnectedToManagerException

Throws:

NotConnectedToManagerException

IMaciSupervisor.NotConnectedToManagerException

getManagerLocation

public java.lang.String getManagerLocation()

Some people are interested in the weirdest things..

Specified by:

getManagerLocation in interface IMaciSupervisor

connectToManager

protected void connectToManager()
                         throws IMaciSupervisor.CannotRetrieveManagerException,
                                NoPermissionEx,
                                org.omg.CORBA.SystemException

Throws:

IMaciSupervisor.CannotRetrieveManagerException

NoPermissionEx

org.omg.CORBA.SystemException

disconnectFromManager

protected void disconnectFromManager()

retrieveContainerInfo

protected ContainerInfo[] retrieveContainerInfo(java.lang.String name_wildcard)
                                         throws IMaciSupervisor.NotConnectedToManagerException,
                                                NoPermissionEx,
                                                org.omg.CORBA.SystemException

The containerHandles argument cannot be specified here. Reason: There's apparently a bug in Manager.get_activator_info() in ACS2.x (nothing known about ACS3.x): The containerHandles argument is not evaluated properly, instead empty (therefore useless) ContainerInfos are returned.

Parameters:

name_wildcard - not verified to work as expected, recommended to use '*'.

Returns:

Throws:

NoPermissionEx

NotConnectedToManagerException

org.omg.CORBA.SystemException

IMaciSupervisor.NotConnectedToManagerException

retrieveClientInfo

protected ClientInfo[] retrieveClientInfo(java.lang.String name_wildcard)
                                   throws IMaciSupervisor.NotConnectedToManagerException,
                                          NoPermissionEx,
                                          org.omg.CORBA.SystemException

Throws:

NoPermissionEx

NotConnectedToManagerException

org.omg.CORBA.SystemException

IMaciSupervisor.NotConnectedToManagerException

retrieveComponentInfo

protected ComponentInfo[] retrieveComponentInfo(java.lang.String name_wildcard)
                                         throws IMaciSupervisor.NotConnectedToManagerException,
                                                NoPermissionEx,
                                                org.omg.CORBA.SystemException

Throws:

NoPermissionEx

NotConnectedToManagerException

org.omg.CORBA.SystemException

IMaciSupervisor.NotConnectedToManagerException

getMaciInfo

public MaciInfo getMaciInfo()
                     throws NoPermissionEx,
                            IMaciSupervisor.NotConnectedToManagerException,
                            IMaciSupervisor.CorbaTransientException,
                            IMaciSupervisor.CorbaNotExistException,
                            IMaciSupervisor.UnknownErrorException

Returns a TreeModel compiled from information from the Acs manager. The returned model will never become invalid during the lifetime of this MaciSupervisor, and it will be automatically updated.

A call to this method will automatically trigger a refresh, possibly throwing an exception or blocking the current thread for a long time. Calling getMaciInformation() and refreshSoon() will shield you from these effects.

Specified by:

getMaciInfo in interface IMaciSupervisor

Returns:

a stable maciInfo instance, never null

Throws:

NotConnectedToManagerException

NoPermissionEx

UnknownErrorException

CorbaNotExistException

CorbaTransientException

IMaciSupervisor.NotConnectedToManagerException

IMaciSupervisor.CorbaTransientException

IMaciSupervisor.CorbaNotExistException

IMaciSupervisor.UnknownErrorException

getMaciInformation

public MaciInfo getMaciInformation()

Returns a TreeModel compiled from information from the Acs manager. The returned model will never become invalid during the lifetime of this MaciSupervisor, and it will be automatically updated.

The returned model may be out-of-date. Call refreshSoon() to have it updated.

Returns:

a stable maciInfo instance, never null

refreshSoon

public void refreshSoon()

Request the MaciInfo be refreshed in the background.

setRefreshesPeriodically

public void setRefreshesPeriodically(boolean b)

Refresh every once in a while, even if there wasn't any indication from the manager that something has changed.

setRefreshDelay

public void setRefreshDelay(int lag,
                            int period)

Configures the polling rate and responsiveness for updates from the manager. Updates from the manager are not applied one-by-one but are instead collected for a certain length of time (ie. the lag) and then applied altogether. The manager does not send notifications for all potential changes that happen in the system. It is thus recommendable to poll the manager for new information in regular intervals (ie. the period).

Parameters:

lag - - the worst-case response time before updates from the manager will be adopted. Note that the average response time is only 1/2 of this. By accepting a higher lag you can reduce the load on the manager, and vice-versa.

period - - the interval by which the manager is polled for new updates. By accepting a longer period you can reduce the load on the manager, and vice-versa.

refreshNow

public void refreshNow()
                throws NoPermissionEx,
                       IMaciSupervisor.NotConnectedToManagerException,
                       org.omg.CORBA.SystemException,
                       IMaciSupervisor.CorbaTransientException,
                       IMaciSupervisor.CorbaNotExistException,
                       IMaciSupervisor.UnknownErrorException

Tries to refresh the component-section, container-section, and client-section of the info tree model. The treemodel will be updated when things go well and also when things fail. A call to this method will instantly perform a refresh, possibly throwing an exception or blocking the current thread for a long time. Calling getMaciInformation() and refreshSoon() will shield you from these effects.

Throws:

NoPermissionEx - error during refresh

NotConnectedToManagerException - error during refresh

CorbaTransientException

CorbaNotExistException

UnknownErrorException

IMaciSupervisor.NotConnectedToManagerException

org.omg.CORBA.SystemException

IMaciSupervisor.CorbaTransientException

IMaciSupervisor.CorbaNotExistException

IMaciSupervisor.UnknownErrorException

toString

public java.lang.String toString()

Overridden to provide pretty description.

Overrides:

toString in class java.lang.Object

extractLocation

protected java.lang.String extractLocation(org.omg.CORBA.Object reference)

Helper for createNode()

Returns:

{host, port}, or null on failure