org.exoplatform.services.ecm.publication

Class PublicationPlugin

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.services.ecm.publication.PublicationPlugin

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

Direct Known Subclasses:

WebpagePublicationPlugin

public abstract class PublicationPlugin
extends org.exoplatform.container.component.BaseComponentPlugin

Base class of Publication plugins. Publication plugins implement a publication lifecycle. Each time a new custom lifecycle needs to be defined, a new plugin has to be implemented and registered with the Publication Service. The getName() method in the parent class is used to identify the lifecycle. The getDescription() method in the parent class is used to describe the lifecycle. Internationalization resource bundles are used in the implementation of the method.

Field Summary

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
PublicationPlugin()

Method Summary

Modifier and Type	Method and Description
abstract void	addMixin(javax.jcr.Node node) Add the specific plugin mixin to the node.
abstract boolean	canAddMixin(javax.jcr.Node node) Return if the plugin can add the specific mixin for the publication.
abstract void	changeState(javax.jcr.Node node, String newState, HashMap<String,String> context) Change the state of the specified Node.
String	getLifecycleName() Retrieves the lifecycleName.
abstract String	getLocalizedAndSubstituteMessage(Locale locale, String key, String[] values) Get localized log messages and substitute variables.
String	getNodeLifecycleDesc(javax.jcr.Node node) Retrieves the description of the plugin.
abstract javax.jcr.Node	getNodeView(javax.jcr.Node node, Map<String,Object> context) Retrieves a node view of the specific node in a context
abstract String[]	getPossibleStates() Retrieves all possible states in the publication lifecycle.
abstract byte[]	getStateImage(javax.jcr.Node node, Locale locale) Retrieves an image showing the lifecycle state of the specified Node.
abstract org.exoplatform.webui.form.UIForm	getStateUI(javax.jcr.Node node, org.exoplatform.webui.core.UIComponent component) Retrieves the WebUI form corresponding to the current state of the specified node.
abstract String	getUserInfo(javax.jcr.Node node, Locale locale) Retrieves description information explaining to the user the current publication state of the specified Node.

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicationPlugin

public PublicationPlugin()

Method Detail

getPossibleStates

public abstract String[] getPossibleStates()

Retrieves all possible states in the publication lifecycle.

Returns:

an array of Strings giving the names of all possible states

changeState

public abstract void changeState(javax.jcr.Node node,
                                 String newState,
                                 HashMap<String,String> context)
                          throws IncorrectStateUpdateLifecycleException,
                                 Exception

Change the state of the specified Node. The implementation of this method basically retrieves the current state from the publication mixin of the specified Node. Then, based on the newState, it is able to determine if the update is possible. If yes, appropriate action is made (eg: launch a publication workflow). In all cases, the current state information is updated in the publication mixin of the specified Node.

Parameters:

node - the Node whose state needs to be changed

newState - the new state.

context - a Hashmap containing contextual information needed to change the state. The information set is defined on a State basis.

Throws:

IncorrectStateUpdateLifecycleException - if the update is not allowed

Exception - the exception

getStateUI

public abstract org.exoplatform.webui.form.UIForm getStateUI(javax.jcr.Node node,
                                                             org.exoplatform.webui.core.UIComponent component)
                                                      throws Exception

Retrieves the WebUI form corresponding to the current state of the specified node. There are two cases here. Either the form contains read only fields (when the state is supposed to be processed by an external entity such as a Workflow). Or the form has editable fields or buttons (in the case the user can interfere. In that case, some action listeners are leveraged.). In all cases, all UI and listener classes are provided in the JAR corresponding to the PublicationPlugin. The method first inspects the specified Node. If it does not contain a publication mixin, then it throws a NotInPublicationLifecycleException exception. Else, it retrieves the lifecycle name from the mixin, selects the appropriate publication plugin and delegates the call to it.

Parameters:

node - the Node from which the state UI should be retrieved

component - the component

Returns:

a WebUI form corresponding to the current state and node.

Throws:

Exception - the exception

getStateImage

public abstract byte[] getStateImage(javax.jcr.Node node,
                                     Locale locale)
                              throws IOException,
                                     FileNotFoundException,
                                     Exception

Retrieves an image showing the lifecycle state of the specified Node. The implementation of this method typically retrieves the current state of the specified Node, then fetches the bytes of an appropriate image found in the jar of the plugin. This image is supposed to be shown in the publication dialog of the JCR File Explorer Portlet.

Parameters:

node - the node from which the image should be obtained

locale - the locale

Returns:

an array of bytes corresponding to the image to be shown to the user

Throws:

IOException - Signals that an I/O exception has occurred.

FileNotFoundException - the file not found exception

Exception - the exception

getUserInfo

public abstract String getUserInfo(javax.jcr.Node node,
                                   Locale locale)
                            throws Exception

Retrieves description information explaining to the user the current publication state of the specified Node. Possible examples are - "The document has been submitted to the following group for validation: /organization/management.". - "The document has been validated and will be published from May 3rd 10:00am to May 3rd 10:00pm. At that time, it will be unpublished and put in a backup state.". - "The document is in draft state. At any time you can turn it to published state." The returned message should be obtained from internationalization resource bundles (ie not hardcoded).

Parameters:

node - the node from which the publication state should be retrieved

locale - the locale

Returns:

a String giving the current state.

Throws:

Exception - the exception

getLifecycleName

public String getLifecycleName()

Retrieves the lifecycleName.

Returns:

a String giving the lifecycleName

getNodeLifecycleDesc

public String getNodeLifecycleDesc(javax.jcr.Node node)

Retrieves the description of the plugin.

Parameters:

node - the node

Returns:

a String giving the description

canAddMixin

public abstract boolean canAddMixin(javax.jcr.Node node)
                             throws Exception

Return if the plugin can add the specific mixin for the publication.

Parameters:

node - the node to add the mixin

Returns:

boolean

Throws:

Exception - the exception

addMixin

public abstract void addMixin(javax.jcr.Node node)
                       throws Exception

Add the specific plugin mixin to the node.

Parameters:

node - the node

Throws:

Exception - the exception

getNodeView

public abstract javax.jcr.Node getNodeView(javax.jcr.Node node,
                                           Map<String,Object> context)
                                    throws Exception

Retrieves a node view of the specific node in a context

Parameters:

node - the node

context - the context

Returns:

the node to view

Throws:

Exception - the exception

getLocalizedAndSubstituteMessage

public abstract String getLocalizedAndSubstituteMessage(Locale locale,
                                                        String key,
                                                        String[] values)
                                                 throws Exception

Get localized log messages and substitute variables.

Parameters:

locale - : the locale to use

key - : the key to translate

values - : array of string to susbtitute in the string

Returns:

a string localized and where values are substitute

Throws:

Exception