org.springframework.extensions.surf

Class ModuleDeploymentService

java.lang.Object

org.springframework.extensions.surf.ModuleDeploymentService

All Implemented Interfaces:

ClusterMessageAware

public class ModuleDeploymentService
extends Object
implements ClusterMessageAware

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterService	clusterService
static String	DEFAULT_PERSISTED_EXTENSION

Constructor Summary

Constructors

Constructor and Description
ModuleDeploymentService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addModuleToExtension(String xmlFragment) Adds a module to the requested extension.
void	clearCurrentThreadErrors()
boolean	deleteModuleDeployment(ModuleDeployment moduleDeploymentToDelete) Deletes the supplied ModuleDeployment and returns the associated ExtensionModule to the list of undeployed modules.
boolean	deleteModuleFromExtension(String moduleId) Deletes the requested module from the extension with the supplied id.
String	getClusterMessageType() The unique message cluster Type ID that this bean deals with and posts using.
List<String>	getCurrentThreadErrors() Returns the current errors for the current thread.
List<ModuleDeployment>	getDeployedModules() Returns the list of configured ModuleDeployments.
Date	getLastConfigurationUpdate()
ModelObjectService	getModelObjectService()
Extension	getPersistedExtension() Retrieves the remotely persisted Extension instance with the id specified by the DEFAULT_PERSISTED_EXTENSION constant.
List<ExtensionModule>	getUndeployedModules() Retrieves the list of configured by undeployed extension modules.
void	onClusterMessage(Map<String,Serializable> payload) Called by a ClusterService implementation when a message for this bean has been sent to this cluster node and is ready to be processed by the handler based on the bean message type as supplied in getClusterMessageType().
void	setClusterService(ClusterService service) Called by a ClusterService implementation to set a ClusterService for this bean to use.
void	setDeployedModules(List<org.json.JSONObject> modulesToDeploy) This method is provided with the purpose of servicing the WebScript API that controls module deployment.
void	setModelObjectService(ModelObjectService modelObjectService)
void	setWebFrameworkConfiguration(WebFrameworkConfigElement webFrameworkConfiguration) This method is required in order for the Spring application context to set the WebFrameworkConfigElement required to detect the module deployment mode.
void	setWebScriptRegistry(org.springframework.extensions.webscripts.Registry webScriptRegistry)
boolean	updateModuleToExtension(String xmlFragment) Updates a module to the requested extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PERSISTED_EXTENSION

public static final String DEFAULT_PERSISTED_EXTENSION

See Also:

Constant Field Values

clusterService

protected ClusterService clusterService

Constructor Detail

ModuleDeploymentService

public ModuleDeploymentService()

Method Detail

setWebFrameworkConfiguration

public void setWebFrameworkConfiguration(WebFrameworkConfigElement webFrameworkConfiguration)

This method is required in order for the Spring application context to set the WebFrameworkConfigElement required to detect the module deployment mode.

Parameters:

webFrameworkConfiguration - WebFrameworkConfigElement

getModelObjectService

public ModelObjectService getModelObjectService()

setModelObjectService

public void setModelObjectService(ModelObjectService modelObjectService)

setWebScriptRegistry

public void setWebScriptRegistry(org.springframework.extensions.webscripts.Registry webScriptRegistry)

getLastConfigurationUpdate

public Date getLastConfigurationUpdate()

getCurrentThreadErrors

public List<String> getCurrentThreadErrors()

Returns the current errors for the current thread. This typically is used to report any save errors.

Returns:

List

clearCurrentThreadErrors

public void clearCurrentThreadErrors()

getPersistedExtension

public Extension getPersistedExtension()
                                throws ModelObjectPersisterException

Retrieves the remotely persisted Extension instance with the id specified by the DEFAULT_PERSISTED_EXTENSION constant. If the Extension cannot be found then it is created and saved.

Returns:

Extension

Throws:

ModelObjectPersisterException

addModuleToExtension

public boolean addModuleToExtension(String xmlFragment)
                             throws org.dom4j.DocumentException,
                                    ModelObjectPersisterException

Adds a module to the requested extension. This extension is remotely persisted and can have modules added to and removed from it without restarting the server.

Parameters:

xmlFragment - String

Throws:

ModelObjectPersisterException

org.dom4j.DocumentException

updateModuleToExtension

public boolean updateModuleToExtension(String xmlFragment)
                                throws org.dom4j.DocumentException,
                                       ModelObjectPersisterException

Updates a module to the requested extension. This extension is remotely persisted and can have modules added to and removed from it without restarting the server.

Parameters:

xmlFragment - String

Throws:

ModelObjectPersisterException

org.dom4j.DocumentException

deleteModuleFromExtension

public boolean deleteModuleFromExtension(String moduleId)
                                  throws ModelObjectPersisterException,
                                         org.dom4j.DocumentException

Deletes the requested module from the extension with the supplied id.

Parameters:

moduleId - String

Throws:

ModelObjectPersisterException

org.dom4j.DocumentException

getUndeployedModules

public List<ExtensionModule> getUndeployedModules()

Retrieves the list of configured by undeployed extension modules.

Returns:

List

getDeployedModules

public List<ModuleDeployment> getDeployedModules()

Returns the list of configured ModuleDeployments. This is the configured ordered list referencing modules that contain configured overrides (rather than their defaults).

Returns:

List

setDeployedModules

public void setDeployedModules(List<org.json.JSONObject> modulesToDeploy)
                        throws org.json.JSONException

This method is provided with the purpose of servicing the WebScript API that controls module deployment. It takes as an argument a String array of the modules that the admin has configured to deploy in the order that they should be processed.

Parameters:

modulesToDeploy - List

Throws:

org.json.JSONException

deleteModuleDeployment

public boolean deleteModuleDeployment(ModuleDeployment moduleDeploymentToDelete)

Deletes the supplied ModuleDeployment and returns the associated ExtensionModule to the list of undeployed modules.

Parameters:

moduleDeploymentToDelete - ModuleDeployment

Returns:

true if the ModuleDeployment was successfully deleted and false otherwise.

setClusterService

public void setClusterService(ClusterService service)

Description copied from interface: ClusterMessageAware

Called by a ClusterService implementation to set a ClusterService for this bean to use. If this is never called (i.e. is null) then there is no ClusterService present and no messages should be posted by the implementor of this interface.

Specified by:

setClusterService in interface ClusterMessageAware

Parameters:

service - ClusterService to use to post cluster message payloads

getClusterMessageType

public String getClusterMessageType()

Description copied from interface: ClusterMessageAware

The unique message cluster Type ID that this bean deals with and posts using. This is part of the contract of the ClusterMessageAware interface and must be implemented by the bean.

Specified by:

getClusterMessageType in interface ClusterMessageAware

Returns:

unique cluster message Type ID for this bean.

onClusterMessage

public void onClusterMessage(Map<String,Serializable> payload)

Description copied from interface: ClusterMessageAware

Called by a ClusterService implementation when a message for this bean has been sent to this cluster node and is ready to be processed by the handler based on the bean message type as supplied in getClusterMessageType().

Specified by:

onClusterMessage in interface ClusterMessageAware

Parameters:

payload - Payload from the message