com.caucho.env.deploy
Interface DeployControllerApi<I extends DeployInstance>

All Known Implementing Classes:
DeployController, EarDeployController, EnvironmentDeployController, ExpandDeployController, HostController, UnknownWebAppController, WebAppController, WebAppVersioningController

public interface DeployControllerApi<I extends DeployInstance>

DeployController controls the lifecycle of the DeployInstance.


Method Summary
 void addLifecycleListener(LifecycleListener listener)
          External lifecycle listeners, so applications can detect deployment and redeployment.
 void alarm()
          Internal notification for modification updates, either from a timer or a repository notification.
 void close()
          Closes the controller
 I getActiveDeployInstance()
          Returns the current instance, waiting for active.
 DeployControllerType getControllerType()
          Returns the controller type
 I getDeployInstance()
          Returns the current instance.
 java.lang.String getId()
          Returns the controller's id, typically a tag value like production/webapp/default/ROOT
 int getStartupPriority()
          Gets the startup priority.
 LifecycleState getState()
          Returns the state name.
 boolean init()
          Initialization of the controller itself
 boolean isNameMatch(java.lang.String name)
          Returns true if the entry matches, used for finding a matching web-app or host.
 void merge(DeployControllerApi<I> newController)
          Merging the controller
 I request()
          Returns the instance for a top-level request
 void restart()
          Force an instance restart from an admin command.
 void start()
          Force an instance start from an admin command.
 void startOnInit()
          Start the controller for initialization.
 void stop()
          Stops the controller from an admin command.
 I subrequest()
          Returns the instance for a subrequest.
 void update()
          Check for modification updates, generally from an admin command when using "manual" redeployment.
 

Method Detail

getId

java.lang.String getId()
Returns the controller's id, typically a tag value like production/webapp/default/ROOT


isNameMatch

boolean isNameMatch(java.lang.String name)
Returns true if the entry matches, used for finding a matching web-app or host.


getStartupPriority

int getStartupPriority()
Gets the startup priority.


getControllerType

DeployControllerType getControllerType()
Returns the controller type


merge

void merge(DeployControllerApi<I> newController)
Merging the controller


init

boolean init()
Initialization of the controller itself


getState

LifecycleState getState()
Returns the state name.


getDeployInstance

I getDeployInstance()
Returns the current instance.


getActiveDeployInstance

I getActiveDeployInstance()
Returns the current instance, waiting for active.


startOnInit

void startOnInit()
Start the controller for initialization.


start

void start()
Force an instance start from an admin command.


stop

void stop()
Stops the controller from an admin command.


restart

void restart()
Force an instance restart from an admin command.


update

void update()
Check for modification updates, generally from an admin command when using "manual" redeployment.


alarm

void alarm()
Internal notification for modification updates, either from a timer or a repository notification. Depending on the restart mode, the alarm may trigger a restart.


request

I request()
Returns the instance for a top-level request

Returns:
the request object or null for none.

subrequest

I subrequest()
Returns the instance for a subrequest.

Returns:
the request object or null for none.

close

void close()
Closes the controller


addLifecycleListener

void addLifecycleListener(LifecycleListener listener)
External lifecycle listeners, so applications can detect deployment and redeployment.