org.alfresco.web.extensibility

Class SlingshotEvaluatorUtil

java.lang.Object

org.alfresco.web.extensibility.SlingshotEvaluatorUtil

public class SlingshotEvaluatorUtil
extends Object

Utility class for evaluators to pick values from the request and get site information etc.

Author:

ewinlof

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PAGE_CONTEXT
protected static String	PORTLET_HOST
protected static String	PORTLET_URL
protected org.springframework.extensions.surf.WebFrameworkServiceRegistry	serviceRegistry
protected static String	SITE
protected static String	SITE_PRESET
static String	SITE_PRESET_CACHE

Constructor Summary

Constructors

Constructor and Description
SlingshotEvaluatorUtil()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEvaluatorParam(Map<String,String> params, String name, String defaultValue) Helper for getting an evaluator parameter trimmed OR defaultValue if no value has been provided.
List<String>	getGroups(String groupsParm) Gets the list of groups to check for membership of.
protected String	getHeader(String name) Helper method to get a request header value from the current request context
String	getPageContext(org.springframework.extensions.surf.RequestContext context) Returns the current page context id OR null if one isn't supplied
String	getPageId(org.springframework.extensions.surf.RequestContext context) Returns the current site id OR null if we aren't in a site
Boolean	getPortletHost(org.springframework.extensions.surf.RequestContext context) Returns true if we are viewed from inside a portal.
String	getPortletUrl(org.springframework.extensions.surf.RequestContext context) Returns the portal url if we are inside a portal, otherwise null.
String	getSite(org.springframework.extensions.surf.RequestContext context) Returns the current site id OR null if we aren't in a site
String	getSitePreset(org.springframework.extensions.surf.RequestContext context, String siteId) The site's sitePreset OR null if something goes wrong.
boolean	isMemberOfGroups(org.springframework.extensions.surf.RequestContext context, List<String> groups, boolean memberOfAllGroups) Determines whether or not the current user is a member of the supplied group.
org.json.JSONObject	jsonGet(String uri) Helper method for making a json get remote call to the default repository.
void	setServiceRegistry(org.springframework.extensions.surf.WebFrameworkServiceRegistry serviceRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

SITE_PRESET_CACHE

public static final String SITE_PRESET_CACHE

PORTLET_HOST

protected static final String PORTLET_HOST

See Also:

Constant Field Values

PORTLET_URL

protected static final String PORTLET_URL

See Also:

Constant Field Values

SITE_PRESET

protected static final String SITE_PRESET

See Also:

Constant Field Values

SITE

protected static final String SITE

See Also:

Constant Field Values

PAGE_CONTEXT

protected static final String PAGE_CONTEXT

See Also:

Constant Field Values

serviceRegistry

protected org.springframework.extensions.surf.WebFrameworkServiceRegistry serviceRegistry

Constructor Detail

SlingshotEvaluatorUtil

public SlingshotEvaluatorUtil()

Method Detail

setServiceRegistry

public void setServiceRegistry(org.springframework.extensions.surf.WebFrameworkServiceRegistry serviceRegistry)

getEvaluatorParam

public String getEvaluatorParam(Map<String,String> params,
                       String name,
                       String defaultValue)

Helper for getting an evaluator parameter trimmed OR defaultValue if no value has been provided.

Parameters:

params -

name -

defaultValue -

Returns:

A trimmed evaluator parameter OR defaultValue if no value has been provided.

getPortletHost

public Boolean getPortletHost(org.springframework.extensions.surf.RequestContext context)

Returns true if we are viewed from inside a portal.

Parameters:

context -

Returns:

true if we are viewed from inside a portal

getPortletUrl

public String getPortletUrl(org.springframework.extensions.surf.RequestContext context)

Returns the portal url if we are inside a portal, otherwise null.

Parameters:

context -

Returns:

the portal url if we are inside a portal, otherwise null.

getPageId

public String getPageId(org.springframework.extensions.surf.RequestContext context)

Returns the current site id OR null if we aren't in a site

Parameters:

context -

Returns:

The current page id OR null if it doesn't exist

getSite

public String getSite(org.springframework.extensions.surf.RequestContext context)

Returns the current site id OR null if we aren't in a site

Parameters:

context -

Returns:

The current site id OR null if we aren't in a site

getPageContext

public String getPageContext(org.springframework.extensions.surf.RequestContext context)

Returns the current page context id OR null if one isn't supplied

Parameters:

context -

Returns:

The current page context id OR null if there is no page context

getSitePreset

public String getSitePreset(org.springframework.extensions.surf.RequestContext context,
                   String siteId)

The site's sitePreset OR null if something goes wrong.

Parameters:

context -

siteId - The id of the site to retrieve the sitePreset for.

Returns:

The site's sitePreset OR null if something goes wrong.

jsonGet

public org.json.JSONObject jsonGet(String uri)

Helper method for making a json get remote call to the default repository.

Parameters:

uri - The uri to get the content for (MUST contain a json response)

Returns:

The content of the uri resource parsed into a json object.

isMemberOfGroups

public boolean isMemberOfGroups(org.springframework.extensions.surf.RequestContext context,
                       List<String> groups,
                       boolean memberOfAllGroups)

Determines whether or not the current user is a member of the supplied group.

Parameters:

context -

groupName -

Returns:

getGroups

public List<String> getGroups(String groupsParm)

Gets the list of groups to check for membership of. This assumes that the groups have been provided as a comma delimited string and will convert that string into a List removing trailing whitespace along the way.

Parameters:

context -

evaluationProperties -

Returns:

getHeader

protected String getHeader(String name)

Helper method to get a request header value from the current request context

Parameters:

name - Header name to retrieve

Returns:

string value or null