org.sakaiproject.entitybroker.providers

Class SiteEntityProvider

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

org.sakaiproject.entitybroker.providers.SiteEntityProvider

All Implemented Interfaces:

org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Createable, org.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable, org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable, org.sakaiproject.entitybroker.entityprovider.capabilities.DepthLimitable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, org.sakaiproject.entitybroker.entityprovider.capabilities.Saveable, org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable, org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.extension.Formats, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class SiteEntityProvider
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.RESTful, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable, org.sakaiproject.entitybroker.entityprovider.capabilities.DepthLimitable

Creates a provider for dealing with sites

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX
static String	PROP_SITE_PROVIDER_PAGESIZE_DEFAULT Property to set the default page size for lists of entities.
static String	PROP_SITE_PROVIDER_PAGESIZE_MAXIMUM Property to set the maximum page size for lists of entities.

Fields inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

developerHelperService

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

SEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

ACTION_METHOD_SUFFIX

Constructor Summary

Constructors

Constructor and Description
SiteEntityProvider()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkSiteExists(org.sakaiproject.entitybroker.EntityView view)
String	createEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)
void	deleteEntity(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
boolean	entityExists(String id)
List<?>	getEntities(org.sakaiproject.entitybroker.EntityReference ref, org.sakaiproject.entitybroker.entityprovider.search.Search search)
Object	getEntity(org.sakaiproject.entitybroker.EntityReference ref)
String	getEntityPrefix()
String[]	getHandledInputFormats()
String[]	getHandledOutputFormats()
int	getMaxDepth()
org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn	getPagesAndTools(org.sakaiproject.entitybroker.EntityView view, org.sakaiproject.entitybroker.entityprovider.search.Search search)
Object	getSampleEntity()
EntityGroup	handleGroups(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
Map<String,Set<String>>	handlePerms(org.sakaiproject.entitybroker.EntityView view)
void	handleRoles(org.sakaiproject.entitybroker.EntityView view)
String	handleSetPerms(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
Set<String>	handleUserPerms(org.sakaiproject.entitybroker.EntityView view)
void	init()
protected boolean	isAllowedAccessMembers(org.sakaiproject.site.api.Site site)
protected boolean	isAllowedAccessSite(org.sakaiproject.site.api.Site site)
String	redirectMemberships(Map<String,String> vars)
void	setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)
void	setFunctionManager(org.sakaiproject.authz.api.FunctionManager functionManager)
void	setMaxDepth(int maxDepth)
void	setRequestStorage(org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage requestStorage)
void	setSecurityService(org.sakaiproject.authz.api.SecurityService securityService)
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
void	setSiteService(org.sakaiproject.site.api.SiteService siteService)
void	setUserEntityProvider(UserEntityProvider userEntityProvider)
protected org.sakaiproject.site.api.Group	trimGroupUsers(org.sakaiproject.site.api.Group grp) Remove the users list from the group provided.
void	updateEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)

Methods inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

afterPropertiesSet, destroy, setDeveloperHelperService, setEntityProviderManager

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static String PREFIX

PROP_SITE_PROVIDER_PAGESIZE_DEFAULT

public static final String PROP_SITE_PROVIDER_PAGESIZE_DEFAULT

Property to set the default page size for lists of entities.

See Also:

Constant Field Values

PROP_SITE_PROVIDER_PAGESIZE_MAXIMUM

public static final String PROP_SITE_PROVIDER_PAGESIZE_MAXIMUM

Property to set the maximum page size for lists of entities.

See Also:

Constant Field Values

Constructor Detail

SiteEntityProvider

public SiteEntityProvider()

Method Detail

setMaxDepth

public void setMaxDepth(int maxDepth)

getMaxDepth

public int getMaxDepth()

Specified by:

getMaxDepth in interface org.sakaiproject.entitybroker.entityprovider.capabilities.DepthLimitable

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService siteService)

setAuthzGroupService

public void setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)

setFunctionManager

public void setFunctionManager(org.sakaiproject.authz.api.FunctionManager functionManager)

setUserEntityProvider

public void setUserEntityProvider(UserEntityProvider userEntityProvider)

setServerConfigurationService

public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)

setSecurityService

public void setSecurityService(org.sakaiproject.authz.api.SecurityService securityService)

getEntityPrefix

public String getEntityPrefix()

Specified by:

getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

init

public void init()

redirectMemberships

public String redirectMemberships(Map<String,String> vars)

checkSiteExists

public boolean checkSiteExists(org.sakaiproject.entitybroker.EntityView view)

handleRoles

public void handleRoles(org.sakaiproject.entitybroker.EntityView view)

handlePerms

public Map<String,Set<String>> handlePerms(org.sakaiproject.entitybroker.EntityView view)

handleSetPerms

public String handleSetPerms(org.sakaiproject.entitybroker.EntityReference ref,
                    Map<String,Object> params)

handleGroups

public EntityGroup handleGroups(org.sakaiproject.entitybroker.EntityView view,
                       Map<String,Object> params)

handleUserPerms

public Set<String> handleUserPerms(org.sakaiproject.entitybroker.EntityView view)

getPagesAndTools

public org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn getPagesAndTools(org.sakaiproject.entitybroker.EntityView view,
                                                                                   org.sakaiproject.entitybroker.entityprovider.search.Search search)

isAllowedAccessMembers

protected boolean isAllowedAccessMembers(org.sakaiproject.site.api.Site site)

Parameters:

site - the site to check perms in

Returns:

true if the current user can view this site

Throws:

SecurityException - if not allowed

entityExists

public boolean entityExists(String id)

Specified by:

entityExists in interface org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider

createEntity

public String createEntity(org.sakaiproject.entitybroker.EntityReference ref,
                  Object entity,
                  Map<String,Object> params)

Specified by:

createEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Createable

getSampleEntity

public Object getSampleEntity()

Specified by:

getSampleEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

updateEntity

public void updateEntity(org.sakaiproject.entitybroker.EntityReference ref,
                Object entity,
                Map<String,Object> params)

Specified by:

updateEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Updateable

getEntity

public Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)

Specified by:

getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable

isAllowedAccessSite

protected boolean isAllowedAccessSite(org.sakaiproject.site.api.Site site)

Parameters:

site - the site to check perms in

Returns:

true if the current user can view this site

Throws:

SecurityException - if not allowed

deleteEntity

public void deleteEntity(org.sakaiproject.entitybroker.EntityReference ref,
                Map<String,Object> params)

Specified by:

deleteEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteable

getEntities

public List<?> getEntities(org.sakaiproject.entitybroker.EntityReference ref,
                  org.sakaiproject.entitybroker.entityprovider.search.Search search)

Specified by:

getEntities in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

getHandledInputFormats

public String[] getHandledInputFormats()

Specified by:

getHandledInputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

setRequestStorage

public void setRequestStorage(org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage requestStorage)

Specified by:

setRequestStorage in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorable

trimGroupUsers

protected org.sakaiproject.site.api.Group trimGroupUsers(org.sakaiproject.site.api.Group grp)

Remove the users list from the group provided. User memberships must be retrieved from the Memberships Entity Provider

Parameters:

grp - Group to trim

Returns: