Inheritance diagram for alma.acs.container.ContainerServicesProxy:

Public Member Functions
	ContainerServicesProxy (ContainerServices delegate)
String	getName ()
AcsLogger	getLogger ()
DAL	getCDB () throws AcsJContainerServicesEx
void	deactivateOffShoot (java.lang.Object offshootImpl) throws AcsJContainerServicesEx
AdvancedContainerServices	getAdvancedContainerServices ()
ThreadFactory	getThreadFactory ()
ComponentStateManager	getComponentStateManager ()
Object	getComponent (String componentUrl) throws AcsJContainerServicesEx
Object	getComponentNonSticky (String curl) throws AcsJContainerServicesEx
Object	getDefaultComponent (String componentIDLType) throws AcsJContainerServicesEx
Object	getCollocatedComponent (String compUrl, String targetCompUrl) throws AcsJContainerServicesEx
Object	getCollocatedComponent (ComponentQueryDescriptor compSpec, boolean markAsDefaul, String targetCompUrl) throws AcsJContainerServicesEx
Object	getDynamicComponent (ComponentQueryDescriptor compSpec, boolean markAsDefault) throws AcsJContainerServicesEx
Object	getDynamicComponent (ComponentSpec compSpec, boolean markAsDefault) throws AcsJContainerServicesEx
String[]	findComponents (String curlWildcard, String typeWildcard) throws AcsJContainerServicesEx
ComponentDescriptor	getComponentDescriptor (String componentUrl) throws AcsJContainerServicesEx
void	releaseComponent (String componentUrl)
void	releaseComponent (String componentUrl, ComponentReleaseCallback callback)
void	registerComponentListener (ComponentListener listener)
Object	getReferenceWithCustomClientSideTimeout (Object originalCorbaRef, double timeoutSeconds) throws AcsJContainerServicesEx
void	assignUniqueEntityId (EntityT entity) throws AcsJContainerServicesEx
AcsEventSubscriber	createNotificationChannelSubscriber (String channelName) throws AcsJContainerServicesEx
AcsEventSubscriber	createNotificationChannelSubscriber (String channelName, String channelNotifyServiceDomainName) throws AcsJContainerServicesEx
AcsEventPublisher	createNotificationChannelPublisher (String channelName) throws AcsJContainerServicesEx
AcsEventPublisher	createNotificationChannelPublisher (String channelName, String channelNotifyServiceDomainName) throws AcsJContainerServicesEx
void	raiseAlarm (String faultFamily, String faultMember, int faultCode) throws AcsJContainerServicesEx
void	clearAlarm (String faultFamily, String faultMember, int faultCode) throws AcsJContainerServicesEx
AlarmSource	getAlarmSource () throws AcsJContainerServicesEx
Protected Member Functions
void	check () throws AcsJContainerServicesEx
Protected Attributes
final ContainerServices	delegate
Package Functions
public< T extends Servant &OffShootOperations > OffShoot	activateOffShoot (T cbServant) throws AcsJContainerServicesEx
public< T extends OffShootOperations > OffShoot	activateOffShoot (T offshootImpl, Class< T > idlOpInterface) throws AcsJContainerServicesEx
public< T, F > T	getTransparentXmlWrapper (Class< T > transparentXmlIF, F objectReference, Class< F > flatXmlIF) throws AcsJContainerServicesEx

Detailed Description

A proxy for ContainerServices} that is specifically meant to isolate implementations of the Alma OMC's PluginContainerServices interface (which extends ContainerServices) from changes in the ACS container services.

PluginContainerServicesImpl should extend ContainerServicesProxy and implement only the methods from PluginContainerServices that are not part of ContainerServices.

Note that the OMC is the only known case outside of ACS that should implement or extend ContainerServices.

Author:: hsommer

Constructor & Destructor Documentation

alma.acs.container.ContainerServicesProxy.ContainerServicesProxy ( ContainerServices delegate )

Member Function Documentation

public<T extends Servant & OffShootOperations> OffShoot alma.acs.container.ContainerServicesProxy.activateOffShoot ( T cbServant ) throws AcsJContainerServicesEx [package]

See also:: alma.acs.container.ContainerServicesBase.activateOffShoot(org.omg.PortableServer.Servant)

Implements alma.acs.container.ContainerServicesBase.

References alma.acs.container.ContainerServices.activateOffShoot(), alma.acs.container.ContainerServicesProxy.check(), and alma.acs.container.ContainerServicesProxy.delegate.

public<T extends OffShootOperations> OffShoot alma.acs.container.ContainerServicesProxy.activateOffShoot	(	T	offshootImpl,
		Class< T >	idlOpInterface
	)			throws AcsJContainerServicesEx `[package]`

See also:: alma.acs.container.ContainerServices.activateOffShoot(alma.acs.container.OffShootOperations, java.lang.Class)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.activateOffShoot(), alma.acs.container.ContainerServicesProxy.check(), and alma.acs.container.ContainerServicesProxy.delegate.

void alma.acs.container.ContainerServicesProxy.assignUniqueEntityId ( EntityT entity ) throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.assignUniqueEntityId(alma.acs.container.EntityT)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.assignUniqueEntityId(), alma.acs.container.ContainerServicesProxy.check(), and alma.acs.container.ContainerServicesProxy.delegate.

void alma.acs.container.ContainerServicesProxy.check ( ) throws AcsJContainerServicesEx [protected]

Here the subclass can implement checks that get executed before any delegation call is made. See protected void checkPluginRunning() throws PluginContainerException in the OMC.

Exceptions:

RuntimeException

void alma.acs.container.ContainerServicesProxy.clearAlarm	(	String	faultFamily,
		String	faultMember,
		int	faultCode
	)			throws AcsJContainerServicesEx

Clears the alarm described by the given triplet.

Alarms are described with a unique triplet, which is composed by a faultFamily, a faultMember and a faultCode, and referred to as FaultState. A particular alarm is mapped by exactly one FaultState, and vice-versa.

The faultFamily field identifies a set of elements of the same kind, and that present the same failures (e.g., all power supplies, which could be represented by the "PS" string).

The faultMember field identifies the particular instance of the given faultFamily that is currently clearing the alarm.

The faultCode field identifies the particular error that is being informed. Its value must match the corresponding one stored in the Alarm Service configuration that describes the situation being reported as corrected.

Parameters:

	faultFamily	The alarm's fault family
	faultMember	The alarm's fault member
	faultCode	The alarm's fault code

Exceptions:

AcsJContainerServicesEx

if anything goes wrong while clearing the alarm

Deprecated:: The new getAlarmSource() method should be used instead, calling AlarmSource#clearAlarm(String, String, int) on the returned object

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.clearAlarm(), and alma.acs.container.ContainerServicesProxy.delegate.

AcsEventPublisher alma.acs.container.ContainerServicesProxy.createNotificationChannelPublisher	(	String	channelName,
		String	channelNotifyServiceDomainName
	)			throws AcsJContainerServicesEx

See also:: ContainerServices.createNotificationChannelPublisher(String, String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.createNotificationChannelPublisher(), and alma.acs.container.ContainerServicesProxy.delegate.

AcsEventPublisher alma.acs.container.ContainerServicesProxy.createNotificationChannelPublisher ( String channelName ) throws AcsJContainerServicesEx

See also:: ContainerServices.createNotificationChannelPublisher(String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.createNotificationChannelPublisher(), and alma.acs.container.ContainerServicesProxy.delegate.

AcsEventSubscriber alma.acs.container.ContainerServicesProxy.createNotificationChannelSubscriber ( String channelName ) throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.createNotificationChannelSubscriber(String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.createNotificationChannelSubscriber(), and alma.acs.container.ContainerServicesProxy.delegate.

AcsEventSubscriber alma.acs.container.ContainerServicesProxy.createNotificationChannelSubscriber	(	String	channelName,
		String	channelNotifyServiceDomainName
	)			throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.createNotificationChannelSubscriber(String, String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServices.createNotificationChannelSubscriber(), and alma.acs.container.ContainerServicesProxy.delegate.

void alma.acs.container.ContainerServicesProxy.deactivateOffShoot ( java.lang.Object offshootImpl ) throws AcsJContainerServicesEx

Exceptions:

AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServicesBase.deactivateOffShoot(java.lang.Object)

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesBase.deactivateOffShoot(), and alma.acs.container.ContainerServicesProxy.delegate.

String [] alma.acs.container.ContainerServicesProxy.findComponents	(	String	curlWildcard,
		String	typeWildcard
	)			throws AcsJContainerServicesEx

Exceptions:

RuntimeException,see

check()

See also:: alma.acs.container.ContainerServices.findComponents(java.lang.String, java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.findComponents().

AdvancedContainerServices alma.acs.container.ContainerServicesProxy.getAdvancedContainerServices ( )

See also:: alma.acs.container.ContainerServicesBase.getAdvancedContainerServices()

Implements alma.acs.container.ContainerServicesBase.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServicesBase.getAdvancedContainerServices().

AlarmSource alma.acs.container.ContainerServicesProxy.getAlarmSource ( ) throws AcsJContainerServicesEx

Returns the AlarmSource owned by this object. The AlarmSource object allows to raise and clear alarms, among other advanced operations

Returns:: The AlarmSource owned by this object

Exceptions:

AcsJContainerServicesEx

if anything goes wrong

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getAlarmSource().

DAL alma.acs.container.ContainerServicesProxy.getCDB ( ) throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServicesBase.getCDB()

Implements alma.acs.container.ContainerServicesBase.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServicesBase.getCDB().

Object alma.acs.container.ContainerServicesProxy.getCollocatedComponent	(	String	compUrl,
		String	targetCompUrl
	)			throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getCollocatedComponent(java.lang.String, java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getCollocatedComponent().

Object alma.acs.container.ContainerServicesProxy.getCollocatedComponent	(	ComponentQueryDescriptor	compSpec,
		boolean	markAsDefaul,
		String	targetCompUrl
	)			throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getCollocatedComponent(alma.acs.component.ComponentQueryDescriptor, boolean, java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getCollocatedComponent().

Object alma.acs.container.ContainerServicesProxy.getComponent ( String componentUrl ) throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getComponent(java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getComponent().

ComponentDescriptor alma.acs.container.ContainerServicesProxy.getComponentDescriptor ( String componentUrl ) throws AcsJContainerServicesEx

Exceptions:

RuntimeException,see

check()

See also:: alma.acs.container.ContainerServices.getComponentDescriptor(java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getComponentDescriptor().

Object alma.acs.container.ContainerServicesProxy.getComponentNonSticky ( String curl ) throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getComponentNonSticky(java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getComponentNonSticky().

ComponentStateManager alma.acs.container.ContainerServicesProxy.getComponentStateManager ( )

Exceptions:

RuntimeException,see

check()

See also:: alma.acs.container.ContainerServices.getComponentStateManager()

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getComponentStateManager().

Object alma.acs.container.ContainerServicesProxy.getDefaultComponent ( String componentIDLType ) throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getDefaultComponent(java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getDefaultComponent().

Object alma.acs.container.ContainerServicesProxy.getDynamicComponent	(	ComponentSpec	compSpec,
		boolean	markAsDefault
	)			throws AcsJContainerServicesEx

Deprecated:

See also:: alma.acs.container.ContainerServices.getDynamicComponent(alma.acs.container.ComponentSpec, boolean)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getDynamicComponent().

Object alma.acs.container.ContainerServicesProxy.getDynamicComponent	(	ComponentQueryDescriptor	compSpec,
		boolean	markAsDefault
	)			throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getDynamicComponent(alma.acs.component.ComponentQueryDescriptor, boolean)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getDynamicComponent().

AcsLogger alma.acs.container.ContainerServicesProxy.getLogger ( )

Exceptions:

RuntimeException,see

check()

See also:: alma.acs.container.ContainerServicesBase.getLogger()

Implements alma.acs.container.ContainerServicesBase.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServicesBase.getLogger().

String alma.acs.container.ContainerServicesProxy.getName ( )

Exceptions:

RuntimeException,see

check()

See also:: alma.acs.container.ContainerServicesBase.getName()

Implements alma.acs.container.ContainerServicesBase.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServicesBase.getName().

Object alma.acs.container.ContainerServicesProxy.getReferenceWithCustomClientSideTimeout	(	Object	originalCorbaRef,
		double	timeoutSeconds
	)			throws AcsJContainerServicesEx

See also:: alma.acs.container.ContainerServices.getReferenceWithCustomClientSideTimeout(org.omg.CORBA.Object, double)

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getReferenceWithCustomClientSideTimeout().

ThreadFactory alma.acs.container.ContainerServicesProxy.getThreadFactory ( )

See also:: alma.acs.container.ContainerServicesBase.getThreadFactory()

Implements alma.acs.container.ContainerServicesBase.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServicesBase.getThreadFactory().

public<T, F> T alma.acs.container.ContainerServicesProxy.getTransparentXmlWrapper	(	Class< T >	transparentXmlIF,
		F	objectReference,
		Class< F >	flatXmlIF
	)			throws AcsJContainerServicesEx `[package]`

See also:: alma.acs.container.ContainerServices.getTransparentXmlWrapper(java.lang.Class, java.lang.Object, java.lang.Class)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getTransparentXmlWrapper().

void alma.acs.container.ContainerServicesProxy.raiseAlarm	(	String	faultFamily,
		String	faultMember,
		int	faultCode
	)			throws AcsJContainerServicesEx

Raises the alarm described by the given triplet.

Alarms are described with a unique triplet, which is composed by a faultFamily, a faultMember and a faultCode, and referred to as FaultState. A particular alarm is mapped by exactly one FaultState, and vice-versa.

The faultFamily field identifies a set of elements of the same kind, and that present the same failures (e.g., all power supplies, which could be represented by the "PS" string).

The faultMember field identifies the particular instance of the given faultFamily that is currently raising the alarm.

The faultCode field identifies the particular error that is being informed. Its value must match the corresponding one stored in the Alarm Service configuration that describes the situation being reported as faulty.

Parameters:

	faultFamily	The alarm's fault family
	faultMember	The alarm's fault member
	faultCode	The alarm's fault code

Exceptions:

AcsJContainerServicesEx

if anything goes wrong while raising the alarm

Deprecated:: The new getAlarmSource() method should be used instead, calling AlarmSource#raiseAlarm(String, String, int) on the returned object

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.raiseAlarm().

void alma.acs.container.ContainerServicesProxy.registerComponentListener ( ComponentListener listener )

See also:: alma.acs.container.ContainerServices.registerComponentListener(alma.acs.container.ContainerServices.ComponentListener)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.registerComponentListener().

void alma.acs.container.ContainerServicesProxy.releaseComponent ( String componentUrl )

See also:: alma.acs.container.ContainerServices.releaseComponent(java.lang.String)

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.releaseComponent().

void alma.acs.container.ContainerServicesProxy.releaseComponent	(	String	componentUrl,
		ComponentReleaseCallback	callback
	)

Releases the reference to the specified component. Releasing a component reference may result in the deactivation of that component, if no other clients hold (sticky) references.

This call will return as soon as the release request has been delivered to the ACS manager, which means that the reference count evaluation and possible component deactivation will happen only after returning from this call.

If your code must synchronize with the reference evaluation and possible component deactivation in the target container, or if you are interested in exceptions that may occur during component deactivation, then you should supply the optional ComponentRequestCallback object and block execution of your calling thread until you receive the callback.

If an exception (such as no-permission) is thrown during the synchronous first part of the underlying call to the manager, then this exception will not be thrown upward by this method but will instead be reported to the optional callback object, just like any exception that happens later during the asynchronous part of the component release. The idea here is to have either "interested" clients that want to get all exceptions, or "easy" clients that do not care about any exceptions, thus do not provide a callback object, and also do not want to bother about a try/catch block.

Parameters:

	componentUrl	the name/curl of the component instance as used by the manager
	callback	may be `null` if you do not need to wait for component activation or to see the results. An new instance of `ComponentReleaseCallback` is required for every call.

Since:: ACS 9.1

Implements alma.acs.container.ContainerServices.

References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.releaseComponent().

Member Data Documentation

final ContainerServices alma.acs.container.ContainerServicesProxy.delegate [protected]

The documentation for this class was generated from the following file:

ContainerServicesProxy.java

All Classes Namespaces Files Functions Variables Enumerations Properties

alma.acs.container.ContainerServicesProxy Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Package Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation