org.alfresco.web.extensibility

Class SlingshotSiteModuleEvaluator

java.lang.Object

org.alfresco.web.extensibility.SlingshotSiteModuleEvaluator

All Implemented Interfaces:

org.springframework.extensions.surf.extensibility.ExtensionModuleEvaluator

public class SlingshotSiteModuleEvaluator
extends Object
implements org.springframework.extensions.surf.extensibility.ExtensionModuleEvaluator

Evaluator used to decide if an extension module (and its & ) shall be used for this request.

Makes it possible to decide if we are viewed specific sites based on their ids and sitePreset ids by matching them against the regexps inside the and parameters and the comma separated groups list in the parameter. The parameter decides if the groups list shall be matched using "and" or "or", allowed values are: AND and OR.

Note! If we are outside a side (i.e. a "global/non-site-page" page: i.e. the "Repository browser", A users dashboard or the "My Workflows" page the evaluator will return true by default. To change this behaviour you can set to false, which means the evaluator will return true ONLY when inside a site. Note that the parameter still applies even

Note! The regexp is expressed without using the surrounding // characters.

Example:

<evaluator type="site.module.evaluator">
    <params>
       <sitePresets>rm-site-dashboard</sitePresets>
       <applyForNonSites>false</applyForNonSites>
     </params>
 </evaluator>
 

Will return true if we are inside a site with a sitePreset id of "rm-site-dashboard".

Example 2:

<evaluator type="site.module.evaluator">
    <params>
       <sites>rm|photos</sitePresets>
    </params>
 </evaluator>
 

Will return true if we are inside a site with a site id of "rm" or "photos" OR if we are on a global page.

Example 3:

<evaluator type="site.module.evaluator">
    <params>
       <sites>.*</sites>
       <applyForNonSites>false</applyForNonSites>
       <groups>SiteManager,SiteCollaborator</groups>
       <groupsRelation>OR</groupsRelation>
    </params>
 </evaluator>
 

Will return true as long as we are in a site and the user is a SiteManager or SiteCollaborator.

Author:

ewinlof

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLY_FOR_NON_SITES
static String	GROUPS
static String	GROUPS_RELATION
static String	GROUPS_RELATION_AND
static String	SITE_FILTER
static String	SITE_PRESET_FILTER
protected SlingshotEvaluatorUtil	util

Constructor Summary

Constructors

Constructor and Description
SlingshotSiteModuleEvaluator()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applyModule(org.springframework.extensions.surf.RequestContext context, Map<String,String> params) Will return true if we are outside a site OR inside a site with a sitePreset id of "rm-site-dashboard".
String[]	getRequiredProperties()
protected boolean	isUserInGroups(org.springframework.extensions.surf.RequestContext context, Map<String,String> params) Checks to see whether or not the current user satisfies the group membership requirements specified.
void	setSlingshotEvaluatorUtil(SlingshotEvaluatorUtil slingshotExtensibilityUtil)

Methods inherited from class java.lang.Object

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

Field Detail

SITE_PRESET_FILTER

public static final String SITE_PRESET_FILTER

See Also:

Constant Field Values

SITE_FILTER

public static final String SITE_FILTER

See Also:

Constant Field Values

APPLY_FOR_NON_SITES

public static final String APPLY_FOR_NON_SITES

See Also:

Constant Field Values

GROUPS

public static final String GROUPS

See Also:

Constant Field Values

GROUPS_RELATION

public static final String GROUPS_RELATION

See Also:

Constant Field Values

GROUPS_RELATION_AND

public static final String GROUPS_RELATION_AND

See Also:

Constant Field Values

util

protected SlingshotEvaluatorUtil util

Constructor Detail

SlingshotSiteModuleEvaluator

public SlingshotSiteModuleEvaluator()

Method Detail

setSlingshotEvaluatorUtil

public void setSlingshotEvaluatorUtil(SlingshotEvaluatorUtil slingshotExtensibilityUtil)

getRequiredProperties

public String[] getRequiredProperties()

Specified by:

getRequiredProperties in interface org.springframework.extensions.surf.extensibility.ExtensionModuleEvaluator

applyModule

public boolean applyModule(org.springframework.extensions.surf.RequestContext context,
                  Map<String,String> params)

Will return true if we are outside a site OR inside a site with a sitePreset id of "rm-site-dashboard".

Specified by:

applyModule in interface org.springframework.extensions.surf.extensibility.ExtensionModuleEvaluator

Parameters:

context -

params -

Returns:

true if we are outside a site OR inside a site with a sitePreset id of "rm-site-dashboard".

isUserInGroups

protected boolean isUserInGroups(org.springframework.extensions.surf.RequestContext context,
                     Map<String,String> params)

Checks to see whether or not the current user satisfies the group membership requirements specified.

Parameters:

context -

params -

Returns:

true if groups param is empty or user is a member of the specified groups (honouring the groupsRelation parameter)