oracle.jdeveloper.server.lifecycle.spi

Interface Controller

public interface Controller

The interface used by the LifecycleManager to interface with the specific type of instance being managed. Controllers are registered with the LifecycleManager.
Uses a memento object to let the controller store any state, in between invocations, the state is passed back in the next time the controller is invoked for the same instance.
The memento object is created by the controller in the initialize method.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(InstanceInfo instance) Return true if this controller can be used for managing the given ADRS instance.
boolean	canTransition(java.lang.Object targetStatus, InstanceInfo instance, Context context, java.lang.Object memento) Return true if the transition to targetStatus can be made from current status.
void	doTransition(java.lang.Object targetStatus, java.lang.Object errorStatus, InstanceInfo instance, Context context, long timeout, java.lang.Object memento) Start, stop the server, or otherwise, bring it to requested status.
java.lang.Object	getCurrentStatus(InstanceInfo instance, java.lang.Object memento) Get the latest status of the instance.
java.lang.Object	getLastKnownStatus(InstanceInfo instance, java.lang.Object memento) Returns cached value from last call to getCurrentStatus.
java.lang.Object	initialize(InstanceController icontroller, InstanceInfo instance) Initialize controller for an InstanceInfo.
void	release(InstanceInfo instance, java.lang.Object memento) Signals end of association of the controller with the instance.
java.lang.Object	setStatus(java.lang.Object newStatus, Context context, java.lang.Object memento) Set the status to newStatus.

Method Detail

canHandle

boolean canHandle(InstanceInfo instance)

Return true if this controller can be used for managing the given ADRS instance.

Parameters:

instance -

Returns:

initialize

java.lang.Object initialize(InstanceController icontroller,
                            InstanceInfo instance)

Initialize controller for an InstanceInfo. Any state that needs to be remembered may be passed back as a memento object, available in subsequent calls to the controller for the same instance.

Parameters:

instance -

Returns:

a memento object (cookie) used for subsequent calls.

getCurrentStatus

java.lang.Object getCurrentStatus(InstanceInfo instance,
                                  java.lang.Object memento)
                           throws ControllerException

Get the latest status of the instance.

Parameters:

instance -

memento -

Returns:

Throws:

ControllerException

getLastKnownStatus

java.lang.Object getLastKnownStatus(InstanceInfo instance,
                                    java.lang.Object memento)

Returns cached value from last call to getCurrentStatus. This is intended to be a fast non-blocking call.

Parameters:

instance -

memento -

Returns:

setStatus

java.lang.Object setStatus(java.lang.Object newStatus,
                           Context context,
                           java.lang.Object memento)

Set the status to newStatus. The implementation should remember this in memento, so that the next getLastKnownStatus call can return the same value. This method is called by the InstanceController in response to an external event.

Parameters:

newStatus -

memento -

Returns:

canTransition

boolean canTransition(java.lang.Object targetStatus,
                      InstanceInfo instance,
                      Context context,
                      java.lang.Object memento)

Return true if the transition to targetStatus can be made from current status. A context will be passed in where available, otherwise it is set to null.

Parameters:

targetStatus -

instance -

context -

memento -

Returns:

doTransition

void doTransition(java.lang.Object targetStatus,
                  java.lang.Object errorStatus,
                  InstanceInfo instance,
                  Context context,
                  long timeout,
                  java.lang.Object memento)
           throws ControllerException

Start, stop the server, or otherwise, bring it to requested status.

Parameters:

targetStatus -

errorStatus -

instance -

context -

timeout -

memento -

Throws:

ControllerException

release

void release(InstanceInfo instance,
             java.lang.Object memento)

Signals end of association of the controller with the instance. No further calls will be made to this controller with the same memento object for this instance.