org.springframework.extensions.surf.support

Class AlfrescoUserFactory

java.lang.Object

org.springframework.extensions.surf.support.BaseFactory

org.springframework.extensions.surf.support.AbstractUserFactory

org.springframework.extensions.surf.support.AlfrescoUserFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, UserFactory

Direct Known Subclasses:

Alfresco32UserFactory

public class AlfrescoUserFactory
extends AbstractUserFactory

This factory loads users from Alfresco, fetching their properties and so forth. The data source is assumed to be a JSON provider.

By implementing this class, User derived objects are available to all downstream components and templates. These components and templates can then consult the user profile as they execute.

The user is stored on the request context and can be fetched using context.getUser(). The user is also available in the root of the a script component context as 'user'.

Author:

muzquiano, kevinr

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALFRESCO_ENDPOINT_ID
static String	CM_AVATAR
static String	CM_COMPANYADDRESS1
static String	CM_COMPANYADDRESS2
static String	CM_COMPANYADDRESS3
static String	CM_COMPANYEMAIL
static String	CM_COMPANYFAX
static String	CM_COMPANYPOSTCODE
static String	CM_COMPANYTELEPHONE
static String	CM_EMAIL
static String	CM_FIRSTNAME
static String	CM_GOOGLEUSERNAME
static String	CM_INSTANTMSG
static String	CM_JOBTITLE
static String	CM_LASTNAME
static String	CM_LOCATION
static String	CM_MOBILE
static String	CM_ORGANIZATION
static String	CM_PERSONDESCRIPTION
static String	CM_SKYPE
static String	CM_TELEPHONE
static String	CM_USERNAME
static String	DEFAULT_USER_URL_PREFIX

Fields inherited from class org.springframework.extensions.surf.support.BaseFactory

frameworkUtils, webFrameworkServiceRegistry

Fields inherited from interface org.springframework.extensions.surf.UserFactory

SESSION_ATTRIBUTE_EXTERNAL_AUTH, SESSION_ATTRIBUTE_KEY_USER_ID, SESSION_ATTRIBUTE_KEY_USER_OBJECT, USER_GUEST

Constructor Summary

Constructors

Constructor and Description
AlfrescoUserFactory()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate(javax.servlet.http.HttpServletRequest request, String username, String password) Authentication the user given the supplied username/password
protected AlfrescoUser	buildAlfrescoUser(org.json.JSONObject json) Build the Alfresco User from the supplied JSON data
protected String	buildUserMetadataRestUrl(RequestContext context, String userId, String endpointId) Build the REST URl to use to retrieve the metadata for the supplied user
protected AlfrescoUser	constructAlfrescoUser(org.json.JSONObject jsonData, org.json.JSONObject properties, Map<String,Boolean> capabilities, Map<String,Boolean> immutability) Construct the Alfresco User from the supplied JSON data, properties and capabilities
protected AlfrescoUser	constructUser(org.json.JSONObject properties, Map<String,Boolean> capabilities, Map<String,Boolean> immutability) Return the AlfrescoUser object
org.springframework.extensions.webscripts.connector.User	loadUser(RequestContext context, String userId) Load the user from a store
org.springframework.extensions.webscripts.connector.User	loadUser(RequestContext context, String requestedUserId, String endpointId) Load the user from a store

Methods inherited from class org.springframework.extensions.surf.support.AbstractUserFactory

getGuestUser, initialiseUser, initialiseUser, initialiseUser, initialiseUser

Methods inherited from class org.springframework.extensions.surf.support.BaseFactory

getApplicationContext, getObjectService, getResourceService, getServiceRegistry, getWebFrameworkConfiguration, setApplicationContext, setFrameworkUtils, setServiceRegistry

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USER_URL_PREFIX

public static final String DEFAULT_USER_URL_PREFIX

See Also:

Constant Field Values

CM_AVATAR

public static final String CM_AVATAR

See Also:

Constant Field Values

CM_COMPANYEMAIL

public static final String CM_COMPANYEMAIL

See Also:

Constant Field Values

CM_COMPANYFAX

public static final String CM_COMPANYFAX

See Also:

Constant Field Values

CM_COMPANYTELEPHONE

public static final String CM_COMPANYTELEPHONE

See Also:

Constant Field Values

CM_COMPANYPOSTCODE

public static final String CM_COMPANYPOSTCODE

See Also:

Constant Field Values

CM_COMPANYADDRESS3

public static final String CM_COMPANYADDRESS3

See Also:

Constant Field Values

CM_COMPANYADDRESS2

public static final String CM_COMPANYADDRESS2

See Also:

Constant Field Values

CM_COMPANYADDRESS1

public static final String CM_COMPANYADDRESS1

See Also:

Constant Field Values

CM_INSTANTMSG

public static final String CM_INSTANTMSG

See Also:

Constant Field Values

CM_GOOGLEUSERNAME

public static final String CM_GOOGLEUSERNAME

See Also:

Constant Field Values

CM_SKYPE

public static final String CM_SKYPE

See Also:

Constant Field Values

CM_MOBILE

public static final String CM_MOBILE

See Also:

Constant Field Values

CM_TELEPHONE

public static final String CM_TELEPHONE

See Also:

Constant Field Values

CM_PERSONDESCRIPTION

public static final String CM_PERSONDESCRIPTION

See Also:

Constant Field Values

CM_EMAIL

public static final String CM_EMAIL

See Also:

Constant Field Values

CM_LOCATION

public static final String CM_LOCATION

See Also:

Constant Field Values

CM_ORGANIZATION

public static final String CM_ORGANIZATION

See Also:

Constant Field Values

CM_JOBTITLE

public static final String CM_JOBTITLE

See Also:

Constant Field Values

CM_LASTNAME

public static final String CM_LASTNAME

See Also:

Constant Field Values

CM_FIRSTNAME

public static final String CM_FIRSTNAME

See Also:

Constant Field Values

CM_USERNAME

public static final String CM_USERNAME

See Also:

Constant Field Values

ALFRESCO_ENDPOINT_ID

public static final String ALFRESCO_ENDPOINT_ID

See Also:

Constant Field Values

Constructor Detail

AlfrescoUserFactory

public AlfrescoUserFactory()

Method Detail

authenticate

public boolean authenticate(javax.servlet.http.HttpServletRequest request,
                   String username,
                   String password)

Description copied from class: AbstractUserFactory

Authentication the user given the supplied username/password

Specified by:

authenticate in interface UserFactory

Specified by:

authenticate in class AbstractUserFactory

Parameters:

request - HttpServletRequest

username - String

password - String

Returns:

success/failure

loadUser

public org.springframework.extensions.webscripts.connector.User loadUser(RequestContext context,
                                                                String userId)
                                                                  throws UserFactoryException

Description copied from class: AbstractUserFactory

Load the user from a store

Specified by:

loadUser in interface UserFactory

Specified by:

loadUser in class AbstractUserFactory

Parameters:

context - RequestContext

userId - String

Returns:

User

Throws:

UserFactoryException

loadUser

public org.springframework.extensions.webscripts.connector.User loadUser(RequestContext context,
                                                                String requestedUserId,
                                                                String endpointId)
                                                                  throws UserFactoryException

Description copied from class: AbstractUserFactory

Load the user from a store

Specified by:

loadUser in interface UserFactory

Specified by:

loadUser in class AbstractUserFactory

Parameters:

context - RequestContext

requestedUserId - String

endpointId - String

Returns:

User

Throws:

UserFactoryException

buildUserMetadataRestUrl

protected String buildUserMetadataRestUrl(RequestContext context,
                              String userId,
                              String endpointId)

Build the REST URl to use to retrieve the metadata for the supplied user

Parameters:

context - RequestContext

userId - String

endpointId - String

Returns:

String

buildAlfrescoUser

protected AlfrescoUser buildAlfrescoUser(org.json.JSONObject json)
                                  throws org.json.JSONException,
                                         UserFactoryException

Build the Alfresco User from the supplied JSON data

Parameters:

json - JSONObject

Returns:

AlfrescoUser

Throws:

org.json.JSONException

UserFactoryException

constructAlfrescoUser

protected AlfrescoUser constructAlfrescoUser(org.json.JSONObject jsonData,
                                 org.json.JSONObject properties,
                                 Map<String,Boolean> capabilities,
                                 Map<String,Boolean> immutability)
                                      throws org.json.JSONException

Construct the Alfresco User from the supplied JSON data, properties and capabilities

Parameters:

jsonData - JSONObject

properties - Properties describing the user

capabilities - Map of user capability flags

immutability - Optional map of property qnames to immutability

Returns:

AlfrescoUser

Throws:

org.json.JSONException

constructUser

protected AlfrescoUser constructUser(org.json.JSONObject properties,
                         Map<String,Boolean> capabilities,
                         Map<String,Boolean> immutability)
                              throws org.json.JSONException

Return the AlfrescoUser object

Returns:

AlfrescoUser

Throws:

org.json.JSONException