org.sakaiproject.entitybroker.providers

Class SessionEntityProvider

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

org.sakaiproject.entitybroker.providers.SessionEntityProvider

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.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, 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 SessionEntityProvider
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.CRUDable, org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Inputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable

Entity provider for Sakai Sessions

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_PASSWORD
static String	AUTH_USERNAME
static String	PREFIX
org.sakaiproject.tool.api.SessionManager	sessionManager
org.sakaiproject.user.api.UserDirectoryService	userDirectoryService

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
SessionEntityProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	createEntity(org.sakaiproject.entitybroker.EntityReference ref, Object entity, Map<String,Object> params)
org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap[]	defineURLMappings()
void	deleteEntity(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
boolean	entityExists(String id)
Object	getCurrentSession()
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()
Object	getSampleEntity()
void	setRequestGetter(org.sakaiproject.entitybroker.entityprovider.extension.RequestGetter requestGetter)
void	setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)
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

AUTH_USERNAME

public static String AUTH_USERNAME

AUTH_PASSWORD

public static String AUTH_PASSWORD

sessionManager

public org.sakaiproject.tool.api.SessionManager sessionManager

userDirectoryService

public org.sakaiproject.user.api.UserDirectoryService userDirectoryService

PREFIX

public static String PREFIX

Constructor Detail

SessionEntityProvider

public SessionEntityProvider()

Method Detail

setSessionManager

public void setSessionManager(org.sakaiproject.tool.api.SessionManager sessionManager)

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

getEntityPrefix

public String getEntityPrefix()

Specified by:

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

defineURLMappings

public org.sakaiproject.entitybroker.entityprovider.extension.TemplateMap[] defineURLMappings()

Specified by:

defineURLMappings in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RedirectDefinable

getCurrentSession

public Object getCurrentSession()

entityExists

public boolean entityExists(String id)

Specified by:

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

getSampleEntity

public Object getSampleEntity()

Specified by:

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

getEntity

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

Specified by:

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

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

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

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

setRequestGetter

public void setRequestGetter(org.sakaiproject.entitybroker.entityprovider.extension.RequestGetter requestGetter)

Specified by:

setRequestGetter in interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware