oracle.jdeveloper.server.lifecycle

Interface InstanceController

public interface InstanceController

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InstanceController.StatusTester

Method Summary

Modifier and Type	Method and Description
boolean	canStart(Context context) Determines whether this instance can be issued a start() command.
boolean	canStop(Context context) Determines whether this instance can be issued a stop() command.
void	fireLifecycleEvent(LifecycleEvent event)
java.lang.Object	getCurrentStatus() Returns the current status of the instance.
InstanceInfo	getInstanceInfo() Returns the Server Instance managed by this controller.
java.lang.Object	getLastKnownStatus() Returns the status of the instance determined when getCurrentStatus() was last called.
java.util.logging.Logger	getLogger()
void	restart(Context context, long timeout)
void	setLogger(java.util.logging.Logger logger)
void	start(Context context, long timeout) Synchronously starts the instance.
void	stop(long timeout) Synchronously stops the instance.
java.lang.Object	testStatus(InstanceController.StatusTester tester)
java.lang.Object	updateCurrentStatus(java.lang.Object newStatus, Context context) Updates the current status of the controller.

Method Detail

getCurrentStatus

java.lang.Object getCurrentStatus()
                           throws LifecycleException

Returns the current status of the instance. This may result in a synchronous query to the instance. The result is cached for use by getLastKnownStatus();

Returns:

Throws:

LifecycleException

updateCurrentStatus

java.lang.Object updateCurrentStatus(java.lang.Object newStatus,
                                     Context context)
                              throws LifecycleException

Updates the current status of the controller. This method should only be called by the controller implementation or to synchronize the controller to a change in status because of an external event. Fires statusChanged events for registered listeners.

Parameters:

newStatus - the new Status

Returns:

old status.

Throws:

LifecycleException

getLastKnownStatus

java.lang.Object getLastKnownStatus()

Returns the status of the instance determined when getCurrentStatus() was last called. Initially the status is 'UNKNOWN'.

testStatus

java.lang.Object testStatus(InstanceController.StatusTester tester)
                     throws LifecycleException

Throws:

LifecycleException

canStart

boolean canStart(Context context)

Determines whether this instance can be issued a start() command. This method may return false if the current status or the context passed in prevents a transition being taken to the STARTED status.

Parameters:

context -

Returns:

true if start() can be invoked on this instance.

canStop

boolean canStop(Context context)

Determines whether this instance can be issued a stop() command. This method may return false if the current status or the context passed in prevents a transition being taken to the STOPPED status.

Returns:

true if stop() can be invoked on this instance.

start

void start(Context context,
           long timeout)
    throws LifecycleException

Synchronously starts the instance. If the instance is already started this is a no-op.

Parameters:

timeout - period to wait, in milliseconds. Zero means wait indefinitely.

Throws:

LifecycleException - if the instance could not be started.

stop

void stop(long timeout)
   throws LifecycleException

Synchronously stops the instance. If instance is already stopped this is a no-op.

Parameters:

timeout - period to wait, in milliseconds. Zero means wait indefinitely.

Throws:

LifecycleException - if the instance could not be started.

restart

void restart(Context context,
             long timeout)
      throws LifecycleException

Throws:

LifecycleException

getInstanceInfo

InstanceInfo getInstanceInfo()

Returns the Server Instance managed by this controller.

getLogger

java.util.logging.Logger getLogger()

setLogger

void setLogger(java.util.logging.Logger logger)

fireLifecycleEvent

void fireLifecycleEvent(LifecycleEvent event)