org.sakaiproject.profile2.tool.entityprovider

Class ProfileEntityProvider

java.lang.Object

org.sakaiproject.entitybroker.util.AbstractEntityProvider

org.sakaiproject.profile2.tool.entityprovider.ProfileEntityProvider

All Implemented Interfaces:

org.sakaiproject.entitybroker.collector.AutoRegister, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, 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 ProfileEntityProvider
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.AutoRegisterEntityProvider, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Redirectable, org.sakaiproject.entitybroker.entityprovider.capabilities.ActionsExecutable, org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware

This is the entity provider for a user's profile.

Author:

Steve Swinsburg (s.swinsburg@lancaster.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_PREFIX

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

developerHelperService

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	confirmFriendRequest(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
boolean	entityExists(String eid)
Object	getConnections(org.sakaiproject.entitybroker.EntityView view, org.sakaiproject.entitybroker.EntityReference ref)
Object	getConnectionStatus(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> parameters)
Object	getEntity(org.sakaiproject.entitybroker.EntityReference ref)
String	getEntityPrefix()
Object	getFormattedProfile(org.sakaiproject.entitybroker.EntityReference ref)
String[]	getHandledOutputFormats()
Object	getProfileImage(OutputStream out, org.sakaiproject.entitybroker.EntityView view, Map<String,Object> params, org.sakaiproject.entitybroker.EntityReference ref)
Object	getSampleEntity()
Object	ignoreFriendRequest(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
String	redirectUserAccount(Map<String,String> vars)
Object	removeFriend(org.sakaiproject.entitybroker.EntityReference ref, Map<String,Object> params)
Object	requestFriend(org.sakaiproject.entitybroker.EntityReference ref, 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

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.RequestAware

setRequestGetter

Field Detail

ENTITY_PREFIX

public static final String ENTITY_PREFIX

See Also:

Constant Field Values

Constructor Detail

ProfileEntityProvider

public ProfileEntityProvider()

Method Detail

getEntityPrefix

public String getEntityPrefix()

Specified by:

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

entityExists

public boolean entityExists(String eid)

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

getProfileImage

public Object getProfileImage(OutputStream out,
                     org.sakaiproject.entitybroker.EntityView view,
                     Map<String,Object> params,
                     org.sakaiproject.entitybroker.EntityReference ref)

getConnections

public Object getConnections(org.sakaiproject.entitybroker.EntityView view,
                    org.sakaiproject.entitybroker.EntityReference ref)

getConnectionStatus

public Object getConnectionStatus(org.sakaiproject.entitybroker.EntityReference ref,
                         Map<String,Object> parameters)

getFormattedProfile

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

requestFriend

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

removeFriend

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

confirmFriendRequest

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

ignoreFriendRequest

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

redirectUserAccount

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

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

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