org.jahia.services.render.filter.cache

Class AclCacheKeyPartGenerator

java.lang.Object

org.jahia.services.render.filter.cache.AclCacheKeyPartGenerator

All Implemented Interfaces:

CacheKeyPartGenerator, org.springframework.beans.factory.InitializingBean

public class AclCacheKeyPartGenerator
extends Object
implements CacheKeyPartGenerator, org.springframework.beans.factory.InitializingBean

Generates an ACL cache key, containing the roles of the current user on the node paths that are used to display this fragment. Multiple users having different roles on the current node path will have different keys. In addition to the current node path, the generator will also add the roles for the main resource if cache.mainResource is set to true. The cache.dependsOnReference can contains a list of reference property names, on which we should also get the list of roles. The cache.dependsOnVisibilityOf can be used to add the roles of any other node. It contains a specific path or a regexp on a path. A specific key per user can be generated if cache.perUser is set to true. In that case, no roles at all are calculated - the fragment will only be served for the current user. The non transformed keypart is a comma separated list of node paths - all paths on which we need to get the roles. At least the current node path, flags indicating the main resource, and other paths that have been added by dependsOnReference or dependsOnVisibilityOf. The transformed keypart contains for each path the list of roles the current user has.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	ACLS_PATH_PATTERN
static Pattern	DEP_ACLS_PATTERN
static String	GROUPS_SIGNATURE
static String	LOGGED_USER
static String	MR_ACL
static Pattern	P_PATTERN
static String	PER_USER
static String	PER_USER_MR_ACL

Constructor Summary

Constructors

Constructor and Description
AclCacheKeyPartGenerator()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void	flushPermissionCacheEntry(String path, boolean propagateToOtherClusterNodes)
void	flushUsersGroupsKey()
void	flushUsersGroupsKey(boolean propageToOtherClusterNodes)
void	flushUsersGroupsKey(String key, boolean propagateToOtherClusterNodes)
void	flushUsersGroupsKeys(Collection<String> keys, Collection<String> keysRelevantForGroupSignature, boolean propagateToOtherClusterNodes)
Set<String>	getAllPrincipalsWithAcl()
String	getKey()
String	getValue(Resource resource, RenderContext renderContext, Properties properties) Get value of this given key part.
boolean	isRelevantForAllPrincipalsCacheEntry(String path) Checks if the specified path is relevant for the calculation of the all principals with ACLs cache entry, based on configured groupsSignatureAclPathsToQuery value.
String	replacePlaceholders(RenderContext renderContext, String keyPart) Replace placeholders in the keyPart to construct the final key used to store the fragment in the cache.
void	setCacheProvider(EhCacheProvider cacheProvider)
void	setGroupManagerService(JahiaGroupManagerService groupManagerService)
void	setGroupsSignatureAclPathsToQuery(String paths)
void	setTemplate(JCRTemplate template)
void	setUseGroupsSignature(boolean useGroupsSignature)
void	setUsePerUser(boolean usePerUser)

Methods inherited from class java.lang.Object

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

Field Detail

PER_USER

public static final String PER_USER

See Also:

Constant Field Values

MR_ACL

public static final String MR_ACL

See Also:

Constant Field Values

PER_USER_MR_ACL

public static final String PER_USER_MR_ACL

See Also:

Constant Field Values

LOGGED_USER

public static final String LOGGED_USER

See Also:

Constant Field Values

GROUPS_SIGNATURE

public static final String GROUPS_SIGNATURE

See Also:

Constant Field Values

P_PATTERN

public static final Pattern P_PATTERN

DEP_ACLS_PATTERN

public static final Pattern DEP_ACLS_PATTERN

ACLS_PATH_PATTERN

public static final Pattern ACLS_PATH_PATTERN

Constructor Detail

AclCacheKeyPartGenerator

public AclCacheKeyPartGenerator()

Method Detail

setGroupManagerService

public void setGroupManagerService(JahiaGroupManagerService groupManagerService)

setCacheProvider

public void setCacheProvider(EhCacheProvider cacheProvider)

setTemplate

public void setTemplate(JCRTemplate template)

setUsePerUser

public void setUsePerUser(boolean usePerUser)

setUseGroupsSignature

public void setUseGroupsSignature(boolean useGroupsSignature)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.

getKey

public String getKey()

Specified by:

getKey in interface CacheKeyPartGenerator

Returns:

The key to identify the part generator

getValue

public String getValue(Resource resource,
                       RenderContext renderContext,
                       Properties properties)

Description copied from interface: CacheKeyPartGenerator

Get value of this given key part.

Specified by:

getValue in interface CacheKeyPartGenerator

Parameters:

resource - the current rendered resource

renderContext - the current renderContext

properties - the current fragment properties

Returns:

the value for this part of the key

replacePlaceholders

public String replacePlaceholders(RenderContext renderContext,
                                  String keyPart)

Description copied from interface: CacheKeyPartGenerator

Replace placeholders in the keyPart to construct the final key used to store the fragment in the cache. This function will be called every time to construct the final key and try get fragment from cache, that's why this operation need to be as light as possible.

Specified by:

replacePlaceholders in interface CacheKeyPartGenerator

Parameters:

renderContext - the current render context

keyPart - the key part, a value returned by the getValue(...) function

Returns:

the final key where plecaholders replaced with actual values

getAllPrincipalsWithAcl

public Set<String> getAllPrincipalsWithAcl()
                                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isRelevantForAllPrincipalsCacheEntry

public boolean isRelevantForAllPrincipalsCacheEntry(String path)

Checks if the specified path is relevant for the calculation of the all principals with ACLs cache entry, based on configured groupsSignatureAclPathsToQuery value.

Parameters:

path - the node path to check

Returns:

true if the path is relevant for the calculation of the all principals with ACLs cache entry; false otherwise.

flushUsersGroupsKey

public void flushUsersGroupsKey()

flushUsersGroupsKey

public void flushUsersGroupsKey(boolean propageToOtherClusterNodes)

flushUsersGroupsKey

public void flushUsersGroupsKey(String key,
                                boolean propagateToOtherClusterNodes)

flushUsersGroupsKeys

public void flushUsersGroupsKeys(Collection<String> keys,
                                 Collection<String> keysRelevantForGroupSignature,
                                 boolean propagateToOtherClusterNodes)

flushPermissionCacheEntry

public void flushPermissionCacheEntry(String path,
                                      boolean propagateToOtherClusterNodes)

setGroupsSignatureAclPathsToQuery

public void setGroupsSignatureAclPathsToQuery(String paths)