org.jahia.api.content

Interface JCRTemplate

All Known Implementing Classes:

JCRTemplate

public interface JCRTemplate

Helper class to simplify and unify JCR data access.

The template is taking care of properly opening and closing sessions, so it does not need to be done by the callback actions.

Data access or business logic service should rather use this template than managing sessions by themselves.

Requires a JCRSessionFactory to provide access to a JCR repository.

Author:

Cedric Mailleux

Method Summary

Modifier and Type	Method and Description
<X> X	doExecute(JahiaUser user, String workspace, Locale locale, JCRCallback<X> callback) Execute the action specified by the given callback object within a new user Session.
<X> X	doExecute(String username, String realm, String workspace, Locale locale, JCRCallback<X> callback) Execute the action specified by the given callback object within a new user Session.
<X> X	doExecuteWithSystemSession(JCRCallback<X> callback) Execute the action specified by the given callback object within a system Session.
<X> X	doExecuteWithSystemSessionAsUser(JahiaUser user, String workspace, Locale locale, JCRCallback<X> callback) Execute the action specified by the given callback object within a system Session.
<X> X	doExecuteWithSystemSessionInSameWorkspaceAndLocale(JCRCallback<X> callback) Execute the action specified by the given callback object within a system Session.
JCRSessionFactory	getSessionFactory()

Method Detail

getSessionFactory

JCRSessionFactory getSessionFactory()

Returns:

Returns the sessionFactory.

doExecuteWithSystemSessionInSameWorkspaceAndLocale

<X> X doExecuteWithSystemSessionInSameWorkspaceAndLocale(JCRCallback<X> callback)
                                                  throws javax.jcr.RepositoryException

Execute the action specified by the given callback object within a system Session.

The workspace and locale will be extracted by the current user session. This method assumes a current session is available, and will generate a RepositoryException if there is no current session.

Type Parameters:

X - the resulting object to return from the callback.

Parameters:

callback - callback the JCRCallback that executes the client operation

Returns:

a result object returned by the action, or null

Throws:

javax.jcr.RepositoryException - if the method could not find a current user session, or if any other underlying JCR error occurred.

doExecuteWithSystemSession

<X> X doExecuteWithSystemSession(JCRCallback<X> callback)
                          throws javax.jcr.RepositoryException

Execute the action specified by the given callback object within a system Session.

The workspace logged into will be the repository's default workspace. The user will be the current user of the thread obtained by JcrSessionFilter.getCurrentUser(). The locale will be "default".

Parameters:

callback - the JCRCallback that executes the client operation

Returns:

a result object returned by the action, or null

Throws:

javax.jcr.RepositoryException - in case of JCR errors

doExecuteWithSystemSessionAsUser

<X> X doExecuteWithSystemSessionAsUser(JahiaUser user,
                                       String workspace,
                                       Locale locale,
                                       JCRCallback<X> callback)
                                throws javax.jcr.RepositoryException

Execute the action specified by the given callback object within a system Session.

The workspace logged into will be the one given by the parameter or if null, the repository's default workspace will be taken. The user will be the one passed by the parameter or if null the current user of the thread obtained by JcrSessionFilter.getCurrentUser() will be taken. The locale will be "default".

Parameters:

user - the user to open the session with

workspace - the workspace name to log into

locale - the locale of the session, null to use unlocalized session

callback - the JCRCallback that executes the client operation

Returns:

a result object returned by the action, or null

Throws:

javax.jcr.RepositoryException - in case of JCR errors

doExecute

<X> X doExecute(String username,
                String realm,
                String workspace,
                Locale locale,
                JCRCallback<X> callback)
         throws javax.jcr.RepositoryException

Execute the action specified by the given callback object within a new user Session.

The workspace logged into will be the one given by the parameter or if null, the repository's default workspace will be taken. The user will be the one passed by the parameter or if null the current user of the thread obtained by JcrSessionFilter.getCurrentUser() will be taken. The locale will be "default".

Parameters:

user - the user to open the session with

workspace - the workspace name to log into

locale - the locale of the session, null to use unlocalized session

callback - the JCRCallback that executes the client operation

Returns:

a result object returned by the action, or null

Throws:

javax.jcr.RepositoryException - in case of JCR errors

doExecute

<X> X doExecute(JahiaUser user,
                String workspace,
                Locale locale,
                JCRCallback<X> callback)
         throws javax.jcr.RepositoryException

Execute the action specified by the given callback object within a new user Session.

The workspace logged into will be the one given by the parameter or if null, the repository's default workspace will be taken. The user will be the one passed by the parameter or if null the current user of the thread obtained by JcrSessionFilter.getCurrentUser() will be taken. The locale will be "default".

Parameters:

user - the user to open the session with

workspace - the workspace name to log into

locale - the locale of the session, null to use unlocalized session

callback - the JCRCallback that executes the client operation

Returns:

a result object returned by the action, or null

Throws:

javax.jcr.RepositoryException - in case of JCR errors