|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.wst.server.core.model.ServerDelegate
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.
ServerDelegate supports an open-ended set of attribute-value pairs. All state stored in this manner will be saved when the server working copy is saved, and persisted across workbench sessions. Server delegates may keep state in instance fields, but that state is transient and will not be persisted across workbench sessions. To save state across workbench sessions, it must be persisted using the attributes.
This abstract class is intended to be extended only by clients
to extend the serverTypes
extension point.
IServer
,
IServerWorkingCopy
Constructor Summary | |
---|---|
ServerDelegate()
Delegates must have a public 0-arg constructor. |
Method Summary | |
---|---|
abstract IStatus |
canModifyModules(IModule[] add,
IModule[] remove)
Returns whether the specified module modifications could be made to this server at this time. |
void |
configurationChanged()
This method is called whenever the server configuration folder has changed. |
void |
dispose()
Disposes of this server delegate. |
boolean |
getAttribute(java.lang.String id,
boolean defaultValue)
Returns the value of the specified boolean-valued attribute. |
int |
getAttribute(java.lang.String id,
int defaultValue)
Returns the value of the specified int-valued attribute. |
java.util.List |
getAttribute(java.lang.String id,
java.util.List defaultValue)
Returns the value of the specified List-valued attribute. |
java.util.Map |
getAttribute(java.lang.String id,
java.util.Map defaultValue)
Returns the value of the specified Map-valued attribute. |
java.lang.String |
getAttribute(java.lang.String id,
java.lang.String defaultValue)
Returns the value of the specified String-valued attribute. |
abstract IModule[] |
getChildModules(IModule[] module)
Returns the child module(s) of this module. |
abstract IModule[] |
getRootModules(IModule module)
Returns the parent module(s) of this module. |
IServer |
getServer()
Returns the server that this server delegate corresponds to. |
ServerPort[] |
getServerPorts()
Returns an array of IServerPorts that this server has. |
IServerWorkingCopy |
getServerWorkingCopy()
Returns the server working copy that this server delegate corresponds to. |
void |
importConfiguration(IRuntime runtime,
IProgressMonitor monitor)
This method is called to import the server configuration from the given runtime. |
void |
initialize()
Initializes this server delegate. |
void |
initialize(org.eclipse.wst.server.core.internal.Server newServer)
Initializes this server delegate with its life-long server instance. |
abstract void |
modifyModules(IModule[] add,
IModule[] remove,
IProgressMonitor monitor)
Modifies the list of modules associated with the server. |
void |
saveConfiguration(IProgressMonitor monitor)
This method is called whenever the server configuration should be saved. |
void |
setAttribute(java.lang.String id,
boolean value)
Sets the value of the specified boolean-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
int value)
Sets the value of the specified integer-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
java.util.List value)
Sets the value of the specified list-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
java.util.Map value)
Sets the value of the specified map-valued attribute of this element. |
void |
setAttribute(java.lang.String id,
java.lang.String value)
Sets the value of the specified string-valued attribute of this element. |
void |
setDefaults()
Initializes this server with default values. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ServerDelegate()
Method Detail |
public final void initialize(org.eclipse.wst.server.core.internal.Server newServer)
This method is called by the server core framework. Clients should never call this method.
newServer
- the server instancepublic void initialize()
This method is called by the server core framework. Clients should never call this method.
public IServer getServer()
public IServerWorkingCopy getServerWorkingCopy()
public int getAttribute(java.lang.String id, int defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, int)
public boolean getAttribute(java.lang.String id, boolean defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, boolean)
public java.lang.String getAttribute(java.lang.String id, java.lang.String defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, String)
public java.util.List getAttribute(java.lang.String id, java.util.List defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, List)
public java.util.Map getAttribute(java.lang.String id, java.util.Map defaultValue)
id
- the attribute iddefaultValue
- the default value of the specified attribute
setAttribute(String, Map)
public void dispose()
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.
public abstract IStatus canModifyModules(IModule[] add, IModule[] remove)
IServerAttributes.canModifyModules(IModule[], IModule[], IProgressMonitor)
for further details.
This method is called by the web server core framework,
in response to a call to IServer.canModifyModules
.
Clients should never call this method.
[issue: See IServerAttributes.canModifyModules(IModule[], IModule[], IProgressMonitor).]
[issue: doc that it should be quick]
add
- a possibly-empty list of modules to addremove
- a possibly-empty list of modules to remove
IStatus.OK
if the modules
can be modified, otherwise a status object indicating why they can'tpublic abstract IModule[] getChildModules(IModule[] module)
This method should only return the direct children. To obtain the full module tree, this method may be recursively called on the children.
module
- a module
IServerAttributes.getChildModules(IModule[], IProgressMonitor)
public abstract IModule[] getRootModules(IModule module) throws CoreException
If the module type is not supported, this method will return null. If the type is normally supported but there is a configuration problem or missing parent, etc., this method will fire a CoreException that may then be presented to the user.
If it does return valid parent(s), this method will always return the topmost parent module(s), even if there are a few levels (a heirarchy) of modules.
[issue: should the parameter be IModule[]?]
module
- a module
CoreException
- if anything went wrongIServerAttributes.getRootModules(IModule, IProgressMonitor)
public ServerPort[] getServerPorts()
public void setDefaults()
public void setAttribute(java.lang.String id, int value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, int)
public void setAttribute(java.lang.String id, boolean value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, boolean)
public void setAttribute(java.lang.String id, java.lang.String value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, String)
public void setAttribute(java.lang.String id, java.util.List value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, List)
public void setAttribute(java.lang.String id, java.util.Map value)
id
- the attribute idvalue
- the value of the specified attributegetAttribute(String, Map)
public abstract void modifyModules(IModule[] add, IModule[] remove, IProgressMonitor monitor) throws CoreException
IServerWorkingCopy.modifyModules(IModule[], IModule[], IProgressMonitor)
for further details.
This method is called by the web server core framework,
in response to a call to IServerWorkingCopy.modifyModules
.
Clients should never call this method.
This method is called to update the server configuration (if any) or update the delegates internal state. Note that the actual list of modules is stored on the server and can be accessed at any time using server.getModules(). getModules() will not be updated until after this method successfully returns.
This method will not communicate with the server. After saving, publish() can be used to sync up with the server.
add
- a possibly-empty list of modules to addremove
- a possibly-empty list of modules to removemonitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- [missing]public void importConfiguration(IRuntime runtime, IProgressMonitor monitor)
runtime
- a server runtimemonitor
- a progress monitor, or null
if progress
reporting and cancellation are not desiredpublic void saveConfiguration(IProgressMonitor monitor) throws CoreException
monitor
- a progress monitor, or null
if progress
reporting and cancellation are not desired
CoreException
- if there was a problem savingpublic void configurationChanged()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |