org.exoplatform.commons.chromattic

Class ChromatticLifeCycle

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.commons.chromattic.ChromatticLifeCycle

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin

public class ChromatticLifeCycle
extends org.exoplatform.container.component.BaseComponentPlugin

The chromattic life cycle objets is a plugin that allow to bootstrap a chromattic builder and make it managed either locally or globally.

It is allowed to create subclasses of this class to override the methods onOpenSession(SessionContext) or onCloseSession(SessionContext) to perform additional treatment on the session context at a precise phase of its life cycle.

The life cycle domain uniquely identifies the chromattic domain among all domain registered against the ChromatticManager manager.

The plugin takes an instance of InitParams as parameter that contains the following entries:

• The domain-name string that is the life cycle domain name
• The workspace-name string that is the repository workspace name associated with this life cycle
• The entities list value that contains the list of chromattic entities that will be registered against the builder chromattic builder

Version:

$Revision$

Author:

Julien Viet

Field Summary

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

desc, name

Constructor Summary

Constructors

Constructor and Description
ChromatticLifeCycle(org.exoplatform.container.xml.InitParams params)

Method Summary

Modifier and Type	Method and Description
void	closeContext(boolean save)
org.chromattic.api.Chromattic	getChromattic()
SessionContext	getContext() Returns #getContext(false).
SessionContext	getContext(boolean peek) A best effort to return a session context whether it's local or global.
String	getDomainName()
ChromatticManager	getManager()
String	getRepositoryName()
String	getWorkspaceName()
protected void	onCloseSession(SessionContext context)
protected void	onOpenSession(SessionContext context)
SessionContext	openContext() Opens a context and returns it.
void	start()
void	stop()

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

ChromatticLifeCycle

public ChromatticLifeCycle(org.exoplatform.container.xml.InitParams params)

Method Detail

getDomainName

public String getDomainName()

getRepositoryName

public final String getRepositoryName()

getWorkspaceName

public final String getWorkspaceName()

getChromattic

public final org.chromattic.api.Chromattic getChromattic()

getManager

public final ChromatticManager getManager()

getContext

public final SessionContext getContext()

Returns #getContext(false).

Returns:

a session context

See Also:

getContext(boolean)

getContext

public final SessionContext getContext(boolean peek)

A best effort to return a session context whether it's local or global.

Parameters:

peek - true if no context should be automatically created

Returns:

a session context

openContext

public final SessionContext openContext()

Opens a context and returns it. If there is a global ongoing synchronization then the context will be scoped to that synchronization, otherwise it will be a local context.

Returns:

the session context

closeContext

public final void closeContext(boolean save)

onOpenSession

protected void onOpenSession(SessionContext context)

onCloseSession

protected void onCloseSession(SessionContext context)

start

public final void start()
                 throws Exception

Throws:

Exception

stop

public final void stop()