org.jahia.services.preferences.impl

Class JahiaPreferencesJCRProviders<T extends JCRNodeWrapper>

java.lang.Object

org.jahia.services.preferences.impl.JahiaPreferencesJCRProviders<T>

All Implemented Interfaces:

JahiaPreferencesProvider<T>

public class JahiaPreferencesJCRProviders<T extends JCRNodeWrapper>
extends Object
implements JahiaPreferencesProvider<T>

JCR based preferences provider implementation. User: jahia Date: 11 mars 2009 Time: 12:18:34

Constructor Summary

Constructors

Constructor and Description
JahiaPreferencesJCRProviders()

Method Summary

Modifier and Type	Method and Description
JahiaPreference	createJahiaPreferenceNode(Principal principal) Create a new JahiaPreference Node
void	deleteAllPreferencesByPrincipal(Principal principal) Delete all preferences by node
void	deleteJahiaPreference(JahiaPreference jahiaPreference) Delete Jahia Prefernce
void	deleteJahiaPreference(Principal principal, String sqlConstraint) Delete Jahia Preference
List<JahiaPreference<T>>	findJahiaPreferences(Principal principal, String sqlConstraint) Find all preferences for a user matching certain sqlConstraint
List<JahiaPreference<T>>	getJahiaAllPreferences(Principal principal) Get all preferences of a user.
JahiaPreference	getJahiaPreference(Principal principal, String sqlConstraint) Get the existing JahiaPreference associated to this path
JahiaPreference	getJahiaPreference(Principal principal, String sqlConstraint, boolean notNull) Get or create the requested preference at the path
JCRSessionFactory	getJCRStoreService()
String	getNodeType()
String	getType() Get the type of the provider.
void	setJahiaPreference(JahiaPreference jahiaPreference) Set Jahia preference
void	setJahiaPreferenceByMaps(Map<String,String> jahiaPreferenceAttributes) Set jahia preference by properties Map
void	setJCRSessionFactory(JCRSessionFactory jcrStoreService)
void	setNodeType(String nodeType)
void	setType(String type)
boolean	validate(JahiaPreference jahiaPreference) Validate the preference

Methods inherited from class java.lang.Object

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

Constructor Detail

JahiaPreferencesJCRProviders

public JahiaPreferencesJCRProviders()

Method Detail

getNodeType

public String getNodeType()

setNodeType

public void setNodeType(String nodeType)

setType

public void setType(String type)

getType

public String getType()

Description copied from interface: JahiaPreferencesProvider

Get the type of the provider. Each provider has a unique type.

Specified by:

getType in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Returns:

getJCRStoreService

public JCRSessionFactory getJCRStoreService()

setJCRSessionFactory

public void setJCRSessionFactory(JCRSessionFactory jcrStoreService)

createJahiaPreferenceNode

public JahiaPreference createJahiaPreferenceNode(Principal principal)

Create a new JahiaPreference Node

Specified by:

createJahiaPreferenceNode in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal - the user creating this preference

Returns:

the newly created JahiaPreference

validate

public boolean validate(JahiaPreference jahiaPreference)
                 throws JahiaPreferencesNotValidException

Validate the preference

Specified by:

validate in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

jahiaPreference - to validate

Returns:

true if valid throw a JahiaPreferencesNotValidException otherwise

Throws:

JahiaPreferencesNotValidException

getJahiaPreference

public JahiaPreference getJahiaPreference(Principal principal,
                                          String sqlConstraint)

Get the existing JahiaPreference associated to this path

Specified by:

getJahiaPreference in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal - the user for searching the preference

sqlConstraint - the sql constraint of the preference

Returns:

a JahiaPreference if found null otherwise

getJahiaPreference

public JahiaPreference getJahiaPreference(Principal principal,
                                          String sqlConstraint,
                                          boolean notNull)

Get or create the requested preference at the path

Specified by:

getJahiaPreference in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal - the user for searching the preference

sqlConstraint - the sql constraint of the preference

notNull - if true create the preference if not found

Returns:

a JahiaPreference if prefrence found or notNull is true, null otherwise

getJahiaAllPreferences

public List<JahiaPreference<T>> getJahiaAllPreferences(Principal principal)

Get all preferences of a user. WARNING: if there is lots of preferences, it can be time consuming.

Specified by:

getJahiaAllPreferences in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal - the user for whom we want the preferences

Returns:

a List of all JahiaPreference for this user

findJahiaPreferences

public List<JahiaPreference<T>> findJahiaPreferences(Principal principal,
                                                     String sqlConstraint)

Find all preferences for a user matching certain sqlConstraint

Specified by:

findJahiaPreferences in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal - the user for whom we want the preferences

sqlConstraint - the sql constraint of the preference

Returns:

a List of all JahiaPreference for this user

deleteJahiaPreference

public void deleteJahiaPreference(Principal principal,
                                  String sqlConstraint)
                           throws JahiaPreferenceNotDefinedAttributeException

Delete Jahia Preference

Specified by:

deleteJahiaPreference in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal - the user for whom we want the preferences

sqlConstraint - the sql constraint of the preference

Throws:

JahiaPreferenceNotDefinedAttributeException

deleteJahiaPreference

public void deleteJahiaPreference(JahiaPreference jahiaPreference)

Delete Jahia Prefernce

Specified by:

deleteJahiaPreference in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

jahiaPreference - the preference to delete

setJahiaPreference

public void setJahiaPreference(JahiaPreference jahiaPreference)

Set Jahia preference

Specified by:

setJahiaPreference in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

jahiaPreference - the preference to set

setJahiaPreferenceByMaps

public void setJahiaPreferenceByMaps(Map<String,String> jahiaPreferenceAttributes)
                              throws JahiaPreferenceNotDefinedAttributeException,
                                     JahiaPreferenceNotDefinedPropertyException,
                                     JahiaPreferencesNotValidException

Set jahia preference by properties Map

Specified by:

setJahiaPreferenceByMaps in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

jahiaPreferenceAttributes -

Throws:

JahiaPreferenceNotDefinedAttributeException

JahiaPreferenceNotDefinedPropertyException

JahiaPreferencesNotValidException

deleteAllPreferencesByPrincipal

public void deleteAllPreferencesByPrincipal(Principal principal)

Delete all preferences by node

Specified by:

deleteAllPreferencesByPrincipal in interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

Parameters:

principal -