org.exoplatform.services.ecm.publication

Interface PublicationService

All Known Implementing Classes:

PublicationServiceImpl

public interface PublicationService

Created by The eXo Platform SAS Author : Romain Dénarié romain.denarie@exoplatform.com 7 mai 08

Field Summary

Fields

Modifier and Type	Field and Description
static String	CURRENT_STATE
static String	HISTORY
static String	LIFECYCLE_NAME
static String	PUBLICATION

Method Summary

Modifier and Type	Method and Description
void	addLog(javax.jcr.Node node, String[] log) Adds a log entry to the specified Node.
void	addPublicationPlugin(PublicationPlugin p) Add a Publication Plugin to the service.
void	changeState(javax.jcr.Node node, String newState, HashMap<String,String> context) Update the state of the specified node.
void	enrollNodeInLifecycle(javax.jcr.Node node, String lifecycle) Enroll the specified Node to the specified lifecycle.
String	getCurrentState(javax.jcr.Node node) Retrieves the name of the publication state corresponding to the specified Node.
String	getLocalizedAndSubstituteLog(Locale locale, String key, String[] values) Get localized log messages and substitute variables.
String	getLocalizedAndSubstituteLog(javax.jcr.Node node, Locale locale, String key, String[] values) Gets the localized and substitute log for current node.
String[][]	getLog(javax.jcr.Node node) Retrieves the history of publication changes made to the specified Node.
String	getNodeLifecycleDesc(javax.jcr.Node node) Retrieves the description of the lifecycle in which the specified Node has been enrolled.
String	getNodeLifecycleName(javax.jcr.Node node) Retrieves the name of the lifecycle in which the specified Node has been enrolled.
javax.jcr.Node	getNodePublish(javax.jcr.Node node, String pluginName)
Map<String,PublicationPlugin>	getPublicationPlugins() Retrieves all added publication plugins.
byte[]	getStateImage(javax.jcr.Node node, Locale locale) Retrieves an image showing the lifecycle state of the specified Node.
String	getUserInfo(javax.jcr.Node node, Locale locale) Retrieves description information explaining to the user the current This method first inspects the specified Node.
boolean	isNodeEnrolledInLifecycle(javax.jcr.Node node) Determines whether the specified Node has been enrolled into a lifecycle.
boolean	isUnsubcribeLifecycle(javax.jcr.Node node) Check current node is unsubcriber or nots
void	unsubcribeLifecycle(javax.jcr.Node node) Unsubcribe node that in publication lifecyle.

Field Detail

PUBLICATION

static final String PUBLICATION

See Also:

Constant Field Values

LIFECYCLE_NAME

static final String LIFECYCLE_NAME

See Also:

Constant Field Values

CURRENT_STATE

static final String CURRENT_STATE

See Also:

Constant Field Values

HISTORY

static final String HISTORY

See Also:

Constant Field Values

Method Detail

addPublicationPlugin

void addPublicationPlugin(PublicationPlugin p)

Add a Publication Plugin to the service. The method caches all added plugins.

Parameters:

p - the plugin to add

getPublicationPlugins

Map<String,PublicationPlugin> getPublicationPlugins()

Retrieves all added publication plugins. This method is notably used to enumerate possible lifecycles.

Returns:

the added publication plugins

changeState

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

Update the state of the specified node. This method first inspects the publication mixin bound to the specified Node. From that mixin, it retrieves the lifecycle registered with the node. Finally, it delegates the call to the method with same name in the plugin that implements the lifecycle.

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. A typical example is information submitted by the user in a user interface.

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

IncorrectStateUpdateLifecycleException - if the update is not allowed

Exception - the exception

getStateImage

byte[] getStateImage(javax.jcr.Node node,
                     Locale locale)
              throws NotInPublicationLifecycleException,
                     Exception

Retrieves an image showing the lifecycle state of the specified Node. 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 image should be obtained

locale - the locale

Returns:

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

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

getCurrentState

String getCurrentState(javax.jcr.Node node)
                throws NotInPublicationLifecycleException,
                       Exception

Retrieves the name of the publication state corresponding to the specified Node. This method first inspects the specified Node. If it does not contain a publication mixin, then it throws a NotInPublicationLifecycleException exception. Else, it retrieves the current state name from the mixin. Possible examples of State names are : "draft", "validation requested", "publication pending", "published", "backed up", "validation refused".

Parameters:

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

Returns:

a String giving the current state.

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

getUserInfo

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

Retrieves description information explaining to the user the current This 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 user information should be retrieved

locale - the locale

Returns:

a text message describing the state of the current message.

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

getLog

String[][] getLog(javax.jcr.Node node)
           throws NotInPublicationLifecycleException,
                  Exception

Retrieves the history of publication changes made to the specified Node. This 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. Log entries are specified as a multi-valued property of the publication mixin.

Parameters:

node - the Node from which the history Log should be retrieved

Returns:

a String array with 2 dimensions. The first dimension contains each log entry. The second dimension contains each information in a log entry, which are : date, name of the new state, involved user, additional information.

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

addLog

void addLog(javax.jcr.Node node,
            String[] log)
     throws NotInPublicationLifecycleException,
            Exception

Adds a log entry to the specified Node. The specified array of String defines the Log information to be added. Log entries are specified as a multi-valued property of the publication mixin.

Parameters:

node - the Node from which the history Log should be updated

log - the Log information to be added log contains : date, newState, userInvolved, key for additionalInformation in locale with possible subsitutions, values for substitutions

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

isNodeEnrolledInLifecycle

boolean isNodeEnrolledInLifecycle(javax.jcr.Node node)
                           throws Exception

Determines whether the specified Node has been enrolled into a lifecycle.

Parameters:

node - the Node from which the enrollment should be evaluated

Returns:

true of the Node is enrolled

Throws:

Exception - the exception

getNodeLifecycleName

String getNodeLifecycleName(javax.jcr.Node node)
                     throws NotInPublicationLifecycleException,
                            Exception

Retrieves the name of the lifecycle in which the specified Node has been enrolled.

Parameters:

node - the Node from which the enrollment should be retrieved

Returns:

the name of the lifecycle corresponding to the specified Node

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

getNodeLifecycleDesc

String getNodeLifecycleDesc(javax.jcr.Node node)
                     throws NotInPublicationLifecycleException,
                            Exception

Retrieves the description of the lifecycle in which the specified Node has been enrolled. This 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 enrollment should be retrieved

Returns:

the description of the lifecycle corresponding to the specified Node

Throws:

NotInPublicationLifecycleException - in case the Node has not been registered in any lifecycle yet (in other words, if no publication mixin has been found).

Exception - the exception

enrollNodeInLifecycle

void enrollNodeInLifecycle(javax.jcr.Node node,
                           String lifecycle)
                    throws AlreadyInPublicationLifecycleException,
                           Exception

Enroll the specified Node to the specified lifecycle. This method adds a publication mixin to the specified Node. The lifecycle name is the one specified as parameter. By default, the state is set to "enrolled".

Parameters:

node - the Node to be enrolled in the specified lifecycle

lifecycle - the name of the lifecycle in which the Node should be enrolled

Throws:

AlreadyInPublicationLifecycleException - the already in publication lifecycle exception

Exception - the exception

unsubcribeLifecycle

void unsubcribeLifecycle(javax.jcr.Node node)
                  throws NotInPublicationLifecycleException,
                         Exception

Unsubcribe node that in publication lifecyle.

Parameters:

node - the node

Throws:

NotInPublicationLifecycleException - the not in publication lifecycle exception

Exception - the exception

isUnsubcribeLifecycle

boolean isUnsubcribeLifecycle(javax.jcr.Node node)
                       throws Exception

Check current node is unsubcriber or nots

Parameters:

node -

Returns:

- true: this node is unsubcriber Lifecycle - false: this node is not unsubcriber Lifecycle

Throws:

Exception

getLocalizedAndSubstituteLog

String getLocalizedAndSubstituteLog(Locale locale,
                                    String key,
                                    String[] values)

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

getLocalizedAndSubstituteLog

String getLocalizedAndSubstituteLog(javax.jcr.Node node,
                                    Locale locale,
                                    String key,
                                    String[] values)
                             throws NotInPublicationLifecycleException,
                                    Exception

Gets the localized and substitute log for current node. Base on lifecycle that node is enroll. The method call to get message for each lifecycle

Parameters:

node - the node

locale - the locale

key - the key

values - the values

Returns:

the localized and substitute log

Throws:

NotInPublicationLifecycleException - the not in publication lifecycle exception

Exception - the exception

getNodePublish

javax.jcr.Node getNodePublish(javax.jcr.Node node,
                              String pluginName)
                       throws Exception

Throws:

Exception