org.eclipse.wst.server.core.model
Class ServerBehaviourDelegate

java.lang.Object
  extended by org.eclipse.wst.server.core.model.ServerBehaviourDelegate

public abstract class ServerBehaviourDelegate
extends java.lang.Object

A server delegate provides the implementation for various generic and server-type-specific operations for a specific type of server. A server delegate is specified by the class attribute of a serverTypes extension.

When the server instance needs to be given a delegate, the delegate class specified for the server type is instantiated with a 0-argument constructor and primed with delegate.initialize(((IServerState)server), which it is expected to hang on to. Later, when delegate.dispose() is called as the server instance is being discarded, the delegate is expected to let go of the server instance.

Server delegates may keep state in instance fields, but that state is transient and will not be persisted across workbench sessions.

This abstract class is intended to be extended only by clients to extend the serverTypes extension point.

Since:
1.0
See Also:
IServer, IServerWorkingCopy

Field Summary
static int ADDED
          Publish kind constant (value 1) for added resources.
static int CHANGED
          Publish kind constant (value 2) for changed resources.
static int NO_CHANGE
          Publish kind constant (value 0) for no change.
static int REMOVED
          Publish kind constant (value 3) for removed resources.
 
Constructor Summary
ServerBehaviourDelegate()
          Delegates must have a public 0-arg constructor.
 
Method Summary
 boolean canControlModule(IModule[] module)
          Returns whether the given module can be restarted.
 void dispose()
          Disposes of this server delegate.
 IServer getServer()
          Returns the server that this server delegate corresponds to.
 void handleResourceChange()
          Called when resources change within the workspace.
 org.eclipse.core.runtime.IStatus publish(int kind, org.eclipse.core.runtime.IProgressMonitor monitor)
          Publish to the server.
 void restart(java.lang.String launchMode)
          Restart this server.
 void restartModule(IModule[] module, org.eclipse.core.runtime.IProgressMonitor monitor)
          Restarts the given module on the server.
 void setupLaunchConfiguration(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy workingCopy, org.eclipse.core.runtime.IProgressMonitor monitor)
          Configure the given launch configuration to start this server.
 void startModule(IModule[] module, org.eclipse.core.runtime.IProgressMonitor monitor)
          Starts the given module on the server.
abstract  void stop(boolean force)
          Shuts down and stops this server.
 void stopModule(IModule[] module, org.eclipse.core.runtime.IProgressMonitor monitor)
          Stops the given module on the server.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_CHANGE

public static final int NO_CHANGE
Publish kind constant (value 0) for no change.

See Also:
publishModule(int, int, IModule[], IProgressMonitor), Constant Field Values

ADDED

public static final int ADDED
Publish kind constant (value 1) for added resources.

See Also:
publishModule(int, int, IModule[], IProgressMonitor), Constant Field Values

CHANGED

public static final int CHANGED
Publish kind constant (value 2) for changed resources.

See Also:
publishModule(int, int, IModule[], IProgressMonitor), Constant Field Values

REMOVED

public static final int REMOVED
Publish kind constant (value 3) for removed resources.

See Also:
publishModule(int, int, IModule[], IProgressMonitor), Constant Field Values
Constructor Detail

ServerBehaviourDelegate

public ServerBehaviourDelegate()
Delegates must have a public 0-arg constructor.

Method Detail

getServer

public final IServer getServer()
Returns the server that this server delegate corresponds to.

Returns:
the server

dispose

public void dispose()
Disposes of this server delegate.

This method is called by the web server core framework. Clients should never call this method.

Implementations are expected to let go of the delegate's reference to the server, deregister listeners, etc.


setupLaunchConfiguration

public void setupLaunchConfiguration(org.eclipse.debug.core.ILaunchConfigurationWorkingCopy workingCopy,
                                     org.eclipse.core.runtime.IProgressMonitor monitor)
                              throws org.eclipse.core.runtime.CoreException
Configure the given launch configuration to start this server. This method is called whenever the server is started to ensure that the launch configuration is accurate and up to date. This method should not blindly update the launch configuration in cases where the user has access to change the launch configuration by hand.

Parameters:
workingCopy - a launch configuration working copy
monitor - a progress monitor, or null if progress reporting and cancellation are not desired
Throws:
org.eclipse.core.runtime.CoreException - if there is an error setting up the configuration

restart

public void restart(java.lang.String launchMode)
             throws org.eclipse.core.runtime.CoreException
Restart this server. The server should use the server listener to notify progress. It must use the same debug flags as was originally passed into the start() method. This method is used if there is a quick/better way to restart the server. If it throws a CoreException, the normal stop/start actions will be used.

Parameters:
launchMode - the mode to restart in, one of the mode constants defined by ILaunchManager
Throws:
org.eclipse.core.runtime.CoreException - if there was a problem restarting

canControlModule

public boolean canControlModule(IModule[] module)
Returns whether the given module can be restarted.

[issue: It's unclear whether this operations is guaranteed to be fast or whether it could involve communication with any actual server. If it is not fast, the method should take a progress monitor.]

Parameters:
module - the module
Returns:
true if the given module can be restarted, and false otherwise

startModule

public void startModule(IModule[] module,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                 throws org.eclipse.core.runtime.CoreException
Starts the given module on the server. See the specification of IServer.startModule(IModule[], IServer.IOperationListener) for further details.

The implementation should update the module sync state and fire an event for the module.

This method will throw an exception if the module does not exist on the server.

[issue: Since this method is ascynchronous, is there any need for the progress monitor?]

Parameters:
module - the module to be started
monitor - a progress monitor, or null if progress reporting and cancellation are not desired
Throws:
org.eclipse.core.runtime.CoreException - if an error occurs while trying to restart the module

stopModule

public void stopModule(IModule[] module,
                       org.eclipse.core.runtime.IProgressMonitor monitor)
                throws org.eclipse.core.runtime.CoreException
Stops the given module on the server. See the specification of IServer.stopModule(IModule[], IServer.IOperationListener) for further details.

The implementation should update the module sync state and fire an event for the module.

This method will throw an exception if the module does not exist on the server.

[issue: Since this method is ascynchronous, is there any need for the progress monitor?]

Parameters:
module - the module to be stopped
monitor - a progress monitor, or null if progress reporting and cancellation are not desired
Throws:
org.eclipse.core.runtime.CoreException - if an error occurs while trying to restart the module

restartModule

public void restartModule(IModule[] module,
                          org.eclipse.core.runtime.IProgressMonitor monitor)
                   throws org.eclipse.core.runtime.CoreException
Restarts the given module on the server. See the specification of IServer.restartModule(IModule[], IServer.IOperationListener) for further details.

The implementation should update the module sync state and fire an event for the module.

This method will throw an exception if the module does not exist on the server.

[issue: Since this method is ascynchronous, is there any need for the progress monitor?]

Parameters:
module - the module to be stopped
monitor - a progress monitor, or null if progress reporting and cancellation are not desired
Throws:
org.eclipse.core.runtime.CoreException - if an error occurs while trying to restart the module

stop

public abstract void stop(boolean force)
Shuts down and stops this server. The server should return from this method quickly and use the server listener to notify shutdown progress.

If force is false, it will attempt to stop the server normally/gracefully. If force is true, then the server process will be terminated any way that it can.

[issue: There is no way to communicate failure to the client. Given that this operation can go awry, there probably should be a mechanism that allows failing asynch operations to be diagnosed.]

Parameters:
force - true to kill the server, or false to stop normally

publish

public org.eclipse.core.runtime.IStatus publish(int kind,
                                                org.eclipse.core.runtime.IProgressMonitor monitor)
Publish to the server.

Parameters:
kind - the publish kind
monitor - a progress monitor, or null if progress reporting and cancellation are not desired
Returns:
the publish status

handleResourceChange

public void handleResourceChange()
Called when resources change within the workspace. This gives the server an opportunity to update the server or module restart state.