org.sakaiproject.profile2.tool.entityprovider
Class ProfileEntityProvider

java.lang.Object
  extended by org.sakaiproject.entitybroker.util.AbstractEntityProvider
      extended by 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
static java.lang.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
ProfileEntityProvider()
           
 
Method Summary
 java.lang.Object confirmFriendRequest(org.sakaiproject.entitybroker.EntityReference ref, java.util.Map<java.lang.String,java.lang.Object> params)
           
 boolean entityExists(java.lang.String eid)
           
 java.lang.Object getConnections(org.sakaiproject.entitybroker.EntityView view, org.sakaiproject.entitybroker.EntityReference ref)
           
 java.lang.Object getConnectionStatus(org.sakaiproject.entitybroker.EntityReference ref, java.util.Map<java.lang.String,java.lang.Object> parameters)
           
 java.lang.Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)
           
 java.lang.String getEntityPrefix()
           
 java.lang.Object getFormattedProfile(org.sakaiproject.entitybroker.EntityReference ref)
           
 java.lang.String[] getHandledOutputFormats()
           
 java.lang.Object getProfileImage(java.io.OutputStream out, org.sakaiproject.entitybroker.EntityView view, java.util.Map<java.lang.String,java.lang.Object> params, org.sakaiproject.entitybroker.EntityReference ref)
           
 java.lang.Object getSampleEntity()
           
 java.lang.Object ignoreFriendRequest(org.sakaiproject.entitybroker.EntityReference ref, java.util.Map<java.lang.String,java.lang.Object> params)
           
 java.lang.String redirectUserAccount(java.util.Map<java.lang.String,java.lang.String> vars)
           
 java.lang.Object removeFriend(org.sakaiproject.entitybroker.EntityReference ref, java.util.Map<java.lang.String,java.lang.Object> params)
           
 java.lang.Object requestFriend(org.sakaiproject.entitybroker.EntityReference ref, java.util.Map<java.lang.String,java.lang.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 java.lang.String ENTITY_PREFIX
See Also:
Constant Field Values
Constructor Detail

ProfileEntityProvider

public ProfileEntityProvider()
Method Detail

getEntityPrefix

public java.lang.String getEntityPrefix()
Specified by:
getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

entityExists

public boolean entityExists(java.lang.String eid)
Specified by:
entityExists in interface org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider

getSampleEntity

public java.lang.Object getSampleEntity()
Specified by:
getSampleEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Sampleable

getEntity

public java.lang.Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)
Specified by:
getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable

getProfileImage

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

getConnections

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

getConnectionStatus

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

getFormattedProfile

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

requestFriend

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

removeFriend

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

confirmFriendRequest

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

ignoreFriendRequest

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

redirectUserAccount

public java.lang.String redirectUserAccount(java.util.Map<java.lang.String,java.lang.String> vars)

getHandledOutputFormats

public java.lang.String[] getHandledOutputFormats()
Specified by:
getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable


Copyright © 2008-2013 The Sakai Foundation. All Rights Reserved.