org.exoplatform.services.wcm.publication

Class WCMPublicationServiceImpl

java.lang.Object

org.exoplatform.services.wcm.publication.WCMPublicationServiceImpl

All Implemented Interfaces:

WCMPublicationService, org.picocontainer.Startable

Direct Known Subclasses:

WCMPublicationServiceImpl

public class WCMPublicationServiceImpl
extends Object
implements WCMPublicationService, org.picocontainer.Startable

Created by The eXo Platform SAS Author : Hoa Pham hoa.pham@exoplatform.com Sep 29, 2008

Field Summary

Fields

Modifier and Type	Field and Description
protected CmsService	cmsService
protected org.exoplatform.services.listener.ListenerService	listenerService
protected PublicationService	publicationService The publication service.
static String	STATEVERSION_LIFECYCLE_NAME The Constant STATEVERSION_LIFECYCLE_NAME.

Fields inherited from interface org.exoplatform.services.wcm.publication.WCMPublicationService

UPDATE_EVENT

Constructor Summary

Constructors

Constructor and Description
WCMPublicationServiceImpl() Instantiates a new WCM publication service.

Method Summary

Modifier and Type	Method and Description
void	addPublicationPlugin(WebpagePublicationPlugin p) Add a Web Publication Plugin to the service.
void	enrollNodeInLifecycle(javax.jcr.Node node, String lifecycleName) Enroll in a web page publication lifecycle.
void	enrollNodeInLifecycle(javax.jcr.Node node, String siteName, String remoteUser) This default implementation uses "States and versions based publication" as a default lifecycle for all sites and "Simple Publishing" for the root user.
String	getContentState(javax.jcr.Node node) returns the current state of the content.
Map<String,WebpagePublicationPlugin>	getWebpagePublicationPlugins() Retrieves all added web page publication plugins.
boolean	isEnrolledInWCMLifecycle(javax.jcr.Node node) Checks if is enrolled in wcm lifecycle.
void	start()
void	stop()
void	unsubcribeLifecycle(javax.jcr.Node node) Unsubcribe node from a lifecycle plugin.
void	updateLifecyleOnChangeContent(javax.jcr.Node node, String siteName, String remoteUser) This default implementation simply delegates updates to the node WebpagePublicationPlugin.
void	updateLifecyleOnChangeContent(javax.jcr.Node node, String siteName, String remoteUser, String newState) This default implementation checks if the state is valid then delegates the update to the node WebpagePublicationPlugin.

Methods inherited from class java.lang.Object

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

Field Detail

STATEVERSION_LIFECYCLE_NAME

public static final String STATEVERSION_LIFECYCLE_NAME

The Constant STATEVERSION_LIFECYCLE_NAME.

See Also:

Constant Field Values

publicationService

protected PublicationService publicationService

The publication service.

listenerService

protected org.exoplatform.services.listener.ListenerService listenerService

cmsService

protected CmsService cmsService

Constructor Detail

WCMPublicationServiceImpl

public WCMPublicationServiceImpl()

Instantiates a new WCM publication service. This service delegate to PublicationService to manage the publication

Method Detail

addPublicationPlugin

public void addPublicationPlugin(WebpagePublicationPlugin p)

Description copied from interface: WCMPublicationService

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

Specified by:

addPublicationPlugin in interface WCMPublicationService

Parameters:

p - the plugin to add

enrollNodeInLifecycle

public void enrollNodeInLifecycle(javax.jcr.Node node,
                                  String lifecycleName)
                           throws Exception

Description copied from interface: WCMPublicationService

Enroll in a web page publication lifecycle. The method will be retrieve the web page publication lifecycle by lifecycle name and enroll to lifecycle

Specified by:

enrollNodeInLifecycle in interface WCMPublicationService

Parameters:

node - the node

lifecycleName - the lifecycle name

Throws:

Exception - the exception

unsubcribeLifecycle

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

Description copied from interface: WCMPublicationService

Unsubcribe node from a lifecycle plugin. After unsubcribe, the node can enroll to other publication lifecycle

Specified by:

unsubcribeLifecycle in interface WCMPublicationService

Parameters:

node - the node

Throws:

NotInPublicationLifecycleException - the not in publication lifecycle exception

Exception - the exception

getWebpagePublicationPlugins

public Map<String,WebpagePublicationPlugin> getWebpagePublicationPlugins()

Description copied from interface: WCMPublicationService

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

Specified by:

getWebpagePublicationPlugins in interface WCMPublicationService

Returns:

the map of web page publication plugin

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

isEnrolledInWCMLifecycle

public boolean isEnrolledInWCMLifecycle(javax.jcr.Node node)
                                 throws NotInPublicationLifecycleException,
                                        Exception

Description copied from interface: WCMPublicationService

Checks if is enrolled in wcm lifecycle.

Specified by:

isEnrolledInWCMLifecycle in interface WCMPublicationService

Parameters:

node - the node

Returns:

true, if is enrolled in wcm lifecycle

Throws:

NotInPublicationLifecycleException - the not in publication lifecycle exception

Exception - the exception

enrollNodeInLifecycle

public void enrollNodeInLifecycle(javax.jcr.Node node,
                                  String siteName,
                                  String remoteUser)
                           throws Exception

This default implementation uses "States and versions based publication" as a default lifecycle for all sites and "Simple Publishing" for the root user.

Specified by:

enrollNodeInLifecycle in interface WCMPublicationService

Throws:

Exception

updateLifecyleOnChangeContent

public void updateLifecyleOnChangeContent(javax.jcr.Node node,
                                          String siteName,
                                          String remoteUser)
                                   throws Exception

This default implementation simply delegates updates to the node WebpagePublicationPlugin.

Specified by:

updateLifecyleOnChangeContent in interface WCMPublicationService

Throws:

Exception

See Also:

PostCreateContentEventListener, PostEditContentEventListener

updateLifecyleOnChangeContent

public void updateLifecyleOnChangeContent(javax.jcr.Node node,
                                          String siteName,
                                          String remoteUser,
                                          String newState)
                                   throws Exception

This default implementation checks if the state is valid then delegates the update to the node WebpagePublicationPlugin.

Specified by:

updateLifecyleOnChangeContent in interface WCMPublicationService

Throws:

Exception

getContentState

public String getContentState(javax.jcr.Node node)
                       throws Exception

Description copied from interface: WCMPublicationService

returns the current state of the content. We consider the publication:currentState property mandatory in all lifecycles.

Specified by:

getContentState in interface WCMPublicationService

Returns:

the revision state stored in publication:currentState property

Throws:

Exception