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
| 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.
|
developerHelperServiceSEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCEALL_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| Constructor and Description |
|---|
SiteEntityProvider() |
| 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) |
public static String PREFIX
public static final String PROP_SITE_PROVIDER_PAGESIZE_DEFAULT
public static final String PROP_SITE_PROVIDER_PAGESIZE_MAXIMUM
public void setMaxDepth(int maxDepth)
public int getMaxDepth()
getMaxDepth in interface org.sakaiproject.entitybroker.entityprovider.capabilities.DepthLimitablepublic void setSiteService(org.sakaiproject.site.api.SiteService siteService)
public void setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)
public void setFunctionManager(org.sakaiproject.authz.api.FunctionManager functionManager)
public void setUserEntityProvider(UserEntityProvider userEntityProvider)
public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
public void setSecurityService(org.sakaiproject.authz.api.SecurityService securityService)
public String getEntityPrefix()
getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProviderpublic void init()
public boolean checkSiteExists(org.sakaiproject.entitybroker.EntityView view)
public void handleRoles(org.sakaiproject.entitybroker.EntityView view)
public Map<String,Set<String>> handlePerms(org.sakaiproject.entitybroker.EntityView view)
public String handleSetPerms(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
public EntityGroup handleGroups(org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params)
public org.sakaiproject.entitybroker.entityprovider.extension.ActionReturn getPagesAndTools(org.sakaiproject.entitybroker.EntityView view,
org.sakaiproject.entitybroker.entityprovider.search.Search search)
protected boolean isAllowedAccessMembers(org.sakaiproject.site.api.Site site)
site - the site to check perms inSecurityException - if not allowedpublic boolean entityExists(String id)
entityExists in interface org.sakaiproject.entitybroker.entityprovider.CoreEntityProviderpublic String createEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)
createEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Createablepublic Object getSampleEntity()
getSampleEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleablepublic void updateEntity(org.sakaiproject.entitybroker.EntityReference ref,
Object entity,
Map<String,Object> params)
updateEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Updateablepublic Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)
getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvableprotected boolean isAllowedAccessSite(org.sakaiproject.site.api.Site site)
site - the site to check perms inSecurityException - if not allowedpublic void deleteEntity(org.sakaiproject.entitybroker.EntityReference ref,
Map<String,Object> params)
deleteEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Deleteablepublic List<?> getEntities(org.sakaiproject.entitybroker.EntityReference ref, org.sakaiproject.entitybroker.entityprovider.search.Search search)
getEntities in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvablepublic String[] getHandledInputFormats()
getHandledInputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Inputablepublic String[] getHandledOutputFormats()
getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputablepublic void setRequestStorage(org.sakaiproject.entitybroker.entityprovider.extension.RequestStorage requestStorage)
setRequestStorage in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestStorableprotected org.sakaiproject.site.api.Group trimGroupUsers(org.sakaiproject.site.api.Group grp)
grp - Group to trimCopyright © 2007-2015 Sakai Project. All Rights Reserved.