org.springframework.extensions.surf.support

Class AbstractUserFactory

java.lang.Object

org.springframework.extensions.surf.support.BaseFactory

org.springframework.extensions.surf.support.AbstractUserFactory

All Implemented Interfaces:

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

Direct Known Subclasses:

AlfrescoUserFactory, DefaultUserFactory

public abstract class AbstractUserFactory
extends BaseFactory
implements UserFactory

Abstract base class for UserFactory implementations. This is provided as a convenience to developers who wish to build their own custom UserFactory variations.

Author:

muzquiano, Kevin Roast

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	authenticate(javax.servlet.http.HttpServletRequest request, String username, String password) Authentication the user given the supplied username/password
protected org.springframework.extensions.webscripts.connector.User	getGuestUser(RequestContext context) Retrieve the special "Guest" user instance.
org.springframework.extensions.webscripts.connector.User	initialiseUser(RequestContext context, javax.servlet.http.HttpServletRequest request) Loads a user from the remote user store and store it into the session.
org.springframework.extensions.webscripts.connector.User	initialiseUser(RequestContext context, javax.servlet.http.HttpServletRequest request, boolean force) Loads a user from the remote user store and stores it into the session.
org.springframework.extensions.webscripts.connector.User	initialiseUser(RequestContext context, javax.servlet.http.HttpServletRequest request, String endpoint) Loads a user from the remote user store and store it into the session.
org.springframework.extensions.webscripts.connector.User	initialiseUser(RequestContext context, javax.servlet.http.HttpServletRequest request, String endpoint, boolean force) Loads a user from the remote user store and stores it into the session.
abstract org.springframework.extensions.webscripts.connector.User	loadUser(RequestContext context, String userId) Load the user from a store
abstract org.springframework.extensions.webscripts.connector.User	loadUser(RequestContext context, String userId, String endpointId) Load the user from a store

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

Constructor Detail

AbstractUserFactory

public AbstractUserFactory()

Method Detail

getGuestUser

protected org.springframework.extensions.webscripts.connector.User getGuestUser(RequestContext context)
                                                                         throws UserFactoryException

Retrieve the special "Guest" user instance.

Parameters:

context - RequestContext

Returns:

Guest User

Throws:

UserFactoryException

initialiseUser

public org.springframework.extensions.webscripts.connector.User initialiseUser(RequestContext context,
                                                                      javax.servlet.http.HttpServletRequest request)
                                                                        throws UserFactoryException

Loads a user from the remote user store and store it into the session.

Specified by:

initialiseUser in interface UserFactory

Parameters:

context - RequestContext

request - HttpServletRequest

Returns:

User

Throws:

UserFactoryException

initialiseUser

public org.springframework.extensions.webscripts.connector.User initialiseUser(RequestContext context,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      String endpoint)
                                                                        throws UserFactoryException

Loads a user from the remote user store and store it into the session.

Specified by:

initialiseUser in interface UserFactory

Parameters:

context - RequestContext

request - HttpServletRequest

endpoint - String

Returns:

User

Throws:

UserFactoryException

initialiseUser

public org.springframework.extensions.webscripts.connector.User initialiseUser(RequestContext context,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      boolean force)
                                                                        throws UserFactoryException

Loads a user from the remote user store and stores it into the session. If the force flag is set, the current in-session user object will be purged, forcing the user object to reload.

Specified by:

initialiseUser in interface UserFactory

Parameters:

context - RequestContext

request - HttpServletRequest

force - boolean

Returns:

User

Throws:

UserFactoryException

initialiseUser

public org.springframework.extensions.webscripts.connector.User initialiseUser(RequestContext context,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      String endpoint,
                                                                      boolean force)
                                                                        throws UserFactoryException

Loads a user from the remote user store and stores it into the session. If the force flag is set, the current in-session user object will be purged, forcing the user object to reload.

Specified by:

initialiseUser in interface UserFactory

Parameters:

context - RequestContext

request - HttpServletRequest

endpoint - String

force - boolean

Returns:

User

Throws:

UserFactoryException

loadUser

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

Load the user from a store

Specified by:

loadUser in interface UserFactory

Parameters:

context - RequestContext

userId - String

Returns:

User

Throws:

UserFactoryException

loadUser

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

Load the user from a store

Specified by:

loadUser in interface UserFactory

Parameters:

context - RequestContext

userId - String

endpointId - String

Returns:

User

Throws:

UserFactoryException

authenticate

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

Authentication the user given the supplied username/password

Specified by:

authenticate in interface UserFactory

Parameters:

request - HttpServletRequest

username - String

password - String

Returns:

success/failure