org.jahia.services.content

Class JCRTemplate

java.lang.Object

org.jahia.services.content.JCRTemplate

public class JCRTemplate
extends Object

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(boolean useSystemSession, String username, String workspace, JCRCallback<X> callback) Deprecated. Use doExecuteWithSystemSession or doExecute with JahiaUser
<X> X	doExecute(boolean useSystemSession, String username, String workspace, Locale locale, JCRCallback<X> callback) Deprecated. Use doExecuteWithSystemSession or doExecute with JahiaUser
<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	doExecuteWithSystemSession(String username, JCRCallback<X> callback) Deprecated. Use doExecuteWithSystemSession with JahiaUser
<X> X	doExecuteWithSystemSession(String username, String workspace, JCRCallback<X> callback) Deprecated. Use doExecuteWithSystemSession with JahiaUser
<X> X	doExecuteWithSystemSession(String username, String workspace, Locale locale, JCRCallback<X> callback) Deprecated. Use doExecuteWithSystemSession with JahiaUser
<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.
<X> X	doExecuteWithUserSession(String username, String workspace, JCRCallback<X> callback) Deprecated. Use doExecute with JahiaUser
<X> X	doExecuteWithUserSession(String username, String workspace, Locale locale, JCRCallback<X> callback) Deprecated. Use doExecute with JahiaUser
static JCRTemplate	getInstance() Obtain the JCRTemplate singleton
JCRStoreProvider	getProvider(String path)
JCRSessionFactory	getSessionFactory()
void	setSessionFactory(JCRSessionFactory sessionFactory)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static JCRTemplate getInstance()

Obtain the JCRTemplate singleton

Returns:

the JCRTemplate singleton instance

setSessionFactory

public void setSessionFactory(JCRSessionFactory sessionFactory)

Parameters:

sessionFactory - The sessionFactory to set.

getSessionFactory

public JCRSessionFactory getSessionFactory()

Returns:

Returns the sessionFactory.

doExecuteWithSystemSessionInSameWorkspaceAndLocale

public <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

public <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

doExecuteWithSystemSession

@Deprecated
public <X> X doExecuteWithSystemSession(String username,
                                                    JCRCallback<X> callback)
                                             throws javax.jcr.RepositoryException

Deprecated. Use doExecuteWithSystemSession with JahiaUser

Throws:

javax.jcr.RepositoryException

doExecuteWithSystemSession

@Deprecated
public <X> X doExecuteWithSystemSession(String username,
                                                    String workspace,
                                                    JCRCallback<X> callback)
                                             throws javax.jcr.RepositoryException

Deprecated. Use doExecuteWithSystemSession with JahiaUser

Throws:

javax.jcr.RepositoryException

doExecuteWithSystemSession

@Deprecated
public <X> X doExecuteWithSystemSession(String username,
                                                    String workspace,
                                                    Locale locale,
                                                    JCRCallback<X> callback)
                                             throws javax.jcr.RepositoryException

Deprecated. Use doExecuteWithSystemSession with JahiaUser

Throws:

javax.jcr.RepositoryException

doExecuteWithSystemSessionAsUser

public <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

doExecuteWithUserSession

@Deprecated
public <X> X doExecuteWithUserSession(String username,
                                                  String workspace,
                                                  JCRCallback<X> callback)
                                           throws javax.jcr.RepositoryException

Deprecated. Use doExecute with JahiaUser

Throws:

javax.jcr.RepositoryException

doExecuteWithUserSession

@Deprecated
public <X> X doExecuteWithUserSession(String username,
                                                  String workspace,
                                                  Locale locale,
                                                  JCRCallback<X> callback)
                                           throws javax.jcr.RepositoryException

Deprecated. Use doExecute with JahiaUser

Throws:

javax.jcr.RepositoryException

doExecute

public <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

public <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

doExecute

@Deprecated
public <X> X doExecute(boolean useSystemSession,
                                   String username,
                                   String workspace,
                                   Locale locale,
                                   JCRCallback<X> callback)
                            throws javax.jcr.RepositoryException

Deprecated. Use doExecuteWithSystemSession or doExecute with JahiaUser

Throws:

javax.jcr.RepositoryException

doExecute

@Deprecated
public <X> X doExecute(boolean useSystemSession,
                                   String username,
                                   String workspace,
                                   JCRCallback<X> callback)
                            throws javax.jcr.RepositoryException

Deprecated. Use doExecuteWithSystemSession or doExecute with JahiaUser

Throws:

javax.jcr.RepositoryException

getProvider

public JCRStoreProvider getProvider(String path)