org.chromattic.api
Interface Chromattic

public interface Chromattic

The Chromattic object provides the entry points for runtime interactions.

Version:

$Revision$

Author:

Julien Viet

Method Summary

ChromatticSession	openSession() Opens a session and returns it.
ChromatticSession	openSession(javax.jcr.Credentials credentials) Opens with the specified credentials a session and returns it.
ChromatticSession	openSession(javax.jcr.Credentials credentials, java.lang.String workspace) Opens with the specified credentials a session for the specified workspace and returns it.
ChromatticSession	openSession(java.lang.String workspace) Opens a session for the specified workspace and returns it.

Method Detail

openSession

ChromatticSession openSession()
                              throws ChromatticException

Opens a session and returns it.

Returns:

the session

Throws:

ChromatticException - any Chromattic exception

openSession

ChromatticSession openSession(java.lang.String workspace)
                              throws ChromatticException

Opens a session for the specified workspace and returns it.

Parameters:

workspace - the workspace name

Returns:

the session

Throws:

ChromatticException - any Chromattic exception

openSession

ChromatticSession openSession(javax.jcr.Credentials credentials,
                              java.lang.String workspace)
                              throws ChromatticException

Opens with the specified credentials a session for the specified workspace and returns it.

Parameters:

credentials - the credentials

workspace - the workspace name

Returns:

the session

Throws:

ChromatticException - any Chromattic exception

openSession

ChromatticSession openSession(javax.jcr.Credentials credentials)
                              throws ChromatticException

Opens with the specified credentials a session and returns it.

Parameters:

credentials - the credentials

Returns:

the session

Throws:

ChromatticException - any Chromattic exception