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 |
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.
alma.acs.container.ContainerServicesProxy.ContainerServicesProxy | ( | ContainerServices | delegate | ) |
public<T extends Servant & OffShootOperations> OffShoot alma.acs.container.ContainerServicesProxy.activateOffShoot | ( | T | cbServant | ) | throws AcsJContainerServicesEx [package] |
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] |
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 |
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.
RuntimeException |
Referenced by alma.acs.container.ContainerServicesProxy.activateOffShoot(), alma.acs.container.ContainerServicesProxy.assignUniqueEntityId(), alma.acs.container.ContainerServicesProxy.deactivateOffShoot(), alma.acs.container.ContainerServicesProxy.findComponents(), alma.acs.container.ContainerServicesProxy.getCDB(), alma.acs.container.ContainerServicesProxy.getCollocatedComponent(), alma.acs.container.ContainerServicesProxy.getComponent(), alma.acs.container.ContainerServicesProxy.getComponentDescriptor(), alma.acs.container.ContainerServicesProxy.getComponentNonSticky(), alma.acs.container.ContainerServicesProxy.getDefaultComponent(), alma.acs.container.ContainerServicesProxy.getDynamicComponent(), alma.acs.container.ContainerServicesProxy.getReferenceWithCustomClientSideTimeout(), and alma.acs.container.ContainerServicesProxy.getTransparentXmlWrapper().
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.
faultFamily | The alarm's fault family | |
faultMember | The alarm's fault member | |
faultCode | The alarm's fault code |
AcsJContainerServicesEx | if anything goes wrong while clearing the alarm |
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 |
AcsEventPublisher alma.acs.container.ContainerServicesProxy.createNotificationChannelPublisher | ( | String | channelName | ) | throws AcsJContainerServicesEx |
AcsEventSubscriber alma.acs.container.ContainerServicesProxy.createNotificationChannelSubscriber | ( | String | channelName | ) | throws AcsJContainerServicesEx |
AcsEventSubscriber alma.acs.container.ContainerServicesProxy.createNotificationChannelSubscriber | ( | String | channelName, | |
String | channelNotifyServiceDomainName | |||
) | throws AcsJContainerServicesEx |
void alma.acs.container.ContainerServicesProxy.deactivateOffShoot | ( | java.lang.Object | offshootImpl | ) | throws AcsJContainerServicesEx |
AcsJContainerServicesEx |
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 |
RuntimeException,see | check() |
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 | ( | ) |
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
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 |
Object alma.acs.container.ContainerServicesProxy.getCollocatedComponent | ( | String | compUrl, | |
String | targetCompUrl | |||
) | throws AcsJContainerServicesEx |
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 |
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 |
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 |
RuntimeException,see | check() |
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 |
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 | ( | ) |
RuntimeException,see | check() |
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 |
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 |
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 |
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 | ( | ) |
RuntimeException,see | check() |
Implements alma.acs.container.ContainerServicesBase.
References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServicesBase.getLogger().
String alma.acs.container.ContainerServicesProxy.getName | ( | ) |
RuntimeException,see | check() |
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 |
References alma.acs.container.ContainerServicesProxy.check(), alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.getReferenceWithCustomClientSideTimeout().
ThreadFactory alma.acs.container.ContainerServicesProxy.getThreadFactory | ( | ) |
public<T, F> T alma.acs.container.ContainerServicesProxy.getTransparentXmlWrapper | ( | Class< T > | transparentXmlIF, | |
F | objectReference, | |||
Class< F > | flatXmlIF | |||
) | throws AcsJContainerServicesEx [package] |
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.
faultFamily | The alarm's fault family | |
faultMember | The alarm's fault member | |
faultCode | The alarm's fault code |
AcsJContainerServicesEx | if anything goes wrong while raising the alarm |
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 | ) |
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 | ) |
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.
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. |
Implements alma.acs.container.ContainerServices.
References alma.acs.container.ContainerServicesProxy.delegate, and alma.acs.container.ContainerServices.releaseComponent().
final ContainerServices alma.acs.container.ContainerServicesProxy.delegate [protected] |
Referenced by alma.acs.container.ContainerServicesProxy.activateOffShoot(), alma.acs.container.ContainerServicesProxy.assignUniqueEntityId(), alma.acs.container.ContainerServicesProxy.clearAlarm(), alma.acs.container.ContainerServicesProxy.createNotificationChannelPublisher(), alma.acs.container.ContainerServicesProxy.createNotificationChannelSubscriber(), alma.acs.container.ContainerServicesProxy.deactivateOffShoot(), alma.acs.container.ContainerServicesProxy.findComponents(), alma.acs.container.ContainerServicesProxy.getAdvancedContainerServices(), alma.acs.container.ContainerServicesProxy.getAlarmSource(), alma.acs.container.ContainerServicesProxy.getCDB(), alma.acs.container.ContainerServicesProxy.getCollocatedComponent(), alma.acs.container.ContainerServicesProxy.getComponent(), alma.acs.container.ContainerServicesProxy.getComponentDescriptor(), alma.acs.container.ContainerServicesProxy.getComponentNonSticky(), alma.acs.container.ContainerServicesProxy.getComponentStateManager(), alma.acs.container.ContainerServicesProxy.getDefaultComponent(), alma.acs.container.ContainerServicesProxy.getDynamicComponent(), alma.acs.container.ContainerServicesProxy.getLogger(), alma.acs.container.ContainerServicesProxy.getName(), alma.acs.container.ContainerServicesProxy.getReferenceWithCustomClientSideTimeout(), alma.acs.container.ContainerServicesProxy.getThreadFactory(), alma.acs.container.ContainerServicesProxy.getTransparentXmlWrapper(), alma.acs.container.ContainerServicesProxy.raiseAlarm(), alma.acs.container.ContainerServicesProxy.registerComponentListener(), and alma.acs.container.ContainerServicesProxy.releaseComponent().