alma.acs.container

Class ContainerServices.ComponentReleaseCallback

java.lang.Object

alma.acs.container.ContainerServices.ComponentReleaseCallback

Direct Known Subclasses:

ContainerServices.ComponentReleaseCallbackWithLogging

Enclosing interface:

ContainerServices

public static class ContainerServices.ComponentReleaseCallback
extends java.lang.Object

Callback that can be optionally given to ContainerServices.releaseComponent(String, ComponentReleaseCallback). Users may override the methods they need in their subclasses of ComponentReleaseCallback.

Note that awaitComponentRelease(long, TimeUnit) is not a callback method but should make it easier to synchronize user code execution with component release.

An instance of ComponentReleaseCallback can be used for only one component release call.

Constructor Summary

Constructors

Constructor and Description
ComponentReleaseCallback()

Method Summary

Modifier and Type	Method and Description
boolean	awaitComponentRelease(long timeout, java.util.concurrent.TimeUnit unit) This is not a callback method but a convenience method to "park" the calling thread until The component has been released, or the given timeout has struck, or component release failed with an exception.
void	componentReleased(AcsJComponentDeactivationUncleanEx deactivationUncleanEx) Called when the component reference has been successfully released.
void	errorCommunicationFailure(java.lang.Throwable thr) Called when a CORBA or other communication error occurred.
void	errorComponentReleaseFailed(AcsJComponentDeactivationFailedEx deactivationFailureEx) Called when the target component deactivation failed.
void	errorNoPermission(java.lang.String reason) Called when the client cannot legally release the component, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentReleaseCallback

public ComponentReleaseCallback()

Method Detail

errorCommunicationFailure

public void errorCommunicationFailure(java.lang.Throwable thr)

Called when a CORBA or other communication error occurred.

errorNoPermission

public void errorNoPermission(java.lang.String reason)

Called when the client cannot legally release the component, e.g. because it no longer holds a reference to it.

componentReleased

public void componentReleased(AcsJComponentDeactivationUncleanEx deactivationUncleanEx)

Called when the component reference has been successfully released.

Parameters:

deactivationUncleanEx - If the component was deactivated with problems, this exception will be forwarded; otherwise null for clean deactivation.

errorComponentReleaseFailed

public void errorComponentReleaseFailed(AcsJComponentDeactivationFailedEx deactivationFailureEx)

Called when the target component deactivation failed.

Parameters:

deactivationFailureEx - to provide details about the failure.

awaitComponentRelease

public final boolean awaitComponentRelease(long timeout,
                                           java.util.concurrent.TimeUnit unit)
                                    throws java.lang.InterruptedException

This is not a callback method but a convenience method to "park" the calling thread until

• The component has been released, or
• the given timeout has struck, or
• component release failed with an exception.

A client that only wants to wait for component release without caring about the details does not have to subclass ComponentReleaseCallback, but can simply call awaitComponentRelease. The client may in addition override the callback methods though.

Parameters:

timeout - The maximum time to wait for the component release to succeed.

unit - The unit of timeout.

Returns:

true if the component was released properly, false if the call returns because of a timeout. See CountDownLatch.await(long, TimeUnit).

Throws:

java.lang.InterruptedException