atg.userprofiling.restresources

Class CurrentUserRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.userprofiling.restresources.CurrentUserRestResource

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, LockKeyProvider, UpdateableRestResource, java.util.EventListener

@RestResource(id="atg.userprofiling.restresources.currentUserRestResource")
public class CurrentUserRestResource
extends GenericService
implements LockKeyProvider, UpdateableRestResource

This class represents a current user resource. It authenticates a user based on the credentials. It also allows a user to sign off/refreshing access token.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CREATE
static java.lang.String	LOCK_KEY_PREFIX A String prefix for the lock key for this resource
protected java.util.Properties	mEmbeddedResources
atg.security.oauth.OAuthService	mOAuthService The oauth service.
ProfileTools	mProfileTools The profile tools.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
CurrentUserRestResource()

Method Summary

Modifier and Type	Method and Description
protected boolean	addInputsForCreateUser(FormHandlerExecutor pExecutor, org.json.JSONObject pInputJson, atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) This method provides a place from which to add form handler input during the create user operation.
protected void	addInputsForLogin(FormHandlerExecutor pExecutor, java.lang.String pLogin, java.lang.String pPassword) This method provides a place from which to add form handler input during the login operation.
protected void	addInputsForLogout(FormHandlerExecutor pExecutor) This method provides a place from which to add form handler input during the logout operation.
protected void	addInputsForUpdateUser(FormHandlerExecutor pExecutor, org.json.JSONObject pInputJson, atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo) This method provides a place from which to add form handler input during the update user operation.
java.lang.Object	getAddresses() Gets the address rest subresource.
protected java.lang.String	getAddressesUri() Build a resource URI for the Addresses.
java.lang.String	getCreateHandleMethod() Gets the name of the ProfileFormHandler method that is called for handling the creation of a profile.
RepresentationModel	getCurrentUser() Gets the current user.
java.lang.String	getEmbeddedAddressesRelationshipName() Get the relationship name used when embedding the addresses resource.
java.util.Properties	getEmbeddedResources() Gets the embedded resources
java.io.Serializable	getLockKey() Need to provide a lock key based on the current user profile id
java.lang.String	getLoginHandleMethod() Gets the name of the ProfileFormHandler method that is called for handling login.
java.lang.String	getLogoutHandleMethod() Gets the name of the ProfileFormHandler method that is called for handling logout.
atg.security.oauth.OAuthService	getOAuthService() Gets the oauth service.
RepositoryItem	getProfile() Retrieves the current profile and makes sure there is one.
java.lang.String	getProfileFormHandlerPath() Returns the ProfileFormHandlerPath.
java.lang.String	getProfilePath() Returns the ProfilePath.
ProfileTools	getProfileTools() Returns the profileTools component.
protected RepresentationModel.Builder	getRepresentationModelBuilder(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
protected RepresentationModel.Builder	getRepresentationModelBuilderWithEmbeddedDetails(java.lang.Object pState) Gets the RepresentationModel.Builder with the given object acting as the state.
java.lang.String	getUpdateHandleMethod() Gets the name of the ProfileFormHandler method that is called for handling the update of a profile.
java.util.Map<java.lang.String,java.lang.String>	login(java.lang.String pGrantType, java.lang.String pLogin, java.lang.String pPassword) This endpoint authenticates a user based on the credentials passed and returns an access token.
Response	logout() This endpoint method discards the current user's access token.
java.util.Map<java.lang.String,java.lang.String>	refreshToken() A new token is generated and returned.
RepresentationModel	register(org.json.JSONObject pInputJson) Registers a new user.
void	setCreateHandleMethod(java.lang.String pCreateHandleMethod) Sets the name of the ProfileFormHandler method that is called for handling the creation of a profile.
void	setEmbeddedAddressesRelationshipName(java.lang.String pEmbeddedAddressesRelationshipName) Configure the relationship name used for embedded addresses.
void	setEmbeddedResources(java.util.Properties pEmbeddedResources) Sets the EmbeddedResources property
void	setLoginHandleMethod(java.lang.String pLoginHandleMethod) Sets the name of the ProfileFormHandler method that is called for handling login.
void	setLogoutHandleMethod(java.lang.String pLogoutHandleMethod) Sets the name of the ProfileFormHandler method that is called for handling logout.
void	setOAuthService(atg.security.oauth.OAuthService pOAuthService) Sets the oauth service.
void	setProfileFormHandlerPath(java.lang.String pProfileFormHandlerPath) Sets the ProfileFormHandlerPath.
void	setProfilePath(java.lang.String pProfilePath) Sets the ProfilePath.
void	setProfileTools(ProfileTools pProfileTools) Sets the profileTools component.
void	setUpdateHandleMethod(java.lang.String pUpdateHandleMethod) Sets the name of the ProfileFormHandler method that is called for handling the update of a profile.
java.net.URI	update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo) This method specifically handles updates to any embedded resources, all contained with pRestResourceUpdateInfo.
RepresentationModel	updateUser(org.json.JSONObject pInputJson) This endpoint updates the current user and any updateable (those that implement atg.service.jaxrs.restresources.UpdateableRestResource) resources configured on embeddedResources property.

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Methods inherited from interface atg.service.jaxrs.restresources.UpdateableRestResource

updateEmbeddedResources

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

CREATE

public static final java.lang.String CREATE

See Also:

Constant Field Values

LOCK_KEY_PREFIX

public static final java.lang.String LOCK_KEY_PREFIX

A String prefix for the lock key for this resource

See Also:

Constant Field Values

mOAuthService

public atg.security.oauth.OAuthService mOAuthService

The oauth service.

mProfileTools

public ProfileTools mProfileTools

The profile tools.

mEmbeddedResources

protected java.util.Properties mEmbeddedResources

Constructor Detail

CurrentUserRestResource

public CurrentUserRestResource()

Method Detail

getProfileFormHandlerPath

public java.lang.String getProfileFormHandlerPath()

Returns the ProfileFormHandlerPath.

Returns:

the ProfileFormHandlerPath.

setProfileFormHandlerPath

public void setProfileFormHandlerPath(java.lang.String pProfileFormHandlerPath)

Sets the ProfileFormHandlerPath.

Parameters:

pProfileFormHandlerPath - the ProfileFormHandlerPath to set.

getProfilePath

public java.lang.String getProfilePath()

Returns the ProfilePath.

Returns:

the ProfilePath.

setProfilePath

public void setProfilePath(java.lang.String pProfilePath)

Sets the ProfilePath.

Parameters:

pProfilePath - the ProfilePath to set.

getOAuthService

public atg.security.oauth.OAuthService getOAuthService()

Gets the oauth service.

Returns:

the oauth service

setOAuthService

public void setOAuthService(atg.security.oauth.OAuthService pOAuthService)

Sets the oauth service.

Parameters:

pOAuthService - the new o auth service

setProfileTools

public void setProfileTools(ProfileTools pProfileTools)

Sets the profileTools component.

Parameters:

pProfileTools - The profileTools component

getProfileTools

public ProfileTools getProfileTools()

Returns the profileTools component.

Returns:

the profileTools component

setEmbeddedAddressesRelationshipName

public void setEmbeddedAddressesRelationshipName(java.lang.String pEmbeddedAddressesRelationshipName)

Configure the relationship name used for embedded addresses. To display the embedded resource the filter configuration also uses this name. If set the filter configuration will need updated to reflect the change.

Parameters:

pEmbeddedAddressesRelationshipName - the name of the relationship to the embedded resource

getEmbeddedAddressesRelationshipName

public java.lang.String getEmbeddedAddressesRelationshipName()

Get the relationship name used when embedding the addresses resource.

Returns:

the relationship name of the embedded addresses resource

getUpdateHandleMethod

public java.lang.String getUpdateHandleMethod()

Gets the name of the ProfileFormHandler method that is called for handling the update of a profile.

The default value is "update".

Returns:

the name of the update handle method

setUpdateHandleMethod

public void setUpdateHandleMethod(java.lang.String pUpdateHandleMethod)

Sets the name of the ProfileFormHandler method that is called for handling the update of a profile.

Parameters:

pUpdateHandleMethod - the name of the update handle method

getCreateHandleMethod

public java.lang.String getCreateHandleMethod()

Gets the name of the ProfileFormHandler method that is called for handling the creation of a profile.

The default value is "create".

Returns:

the name of the create handle method

setCreateHandleMethod

public void setCreateHandleMethod(java.lang.String pCreateHandleMethod)

Sets the name of the ProfileFormHandler method that is called for handling the creation of a profile.

Parameters:

pCreateHandleMethod - the name of the create handle method

getLoginHandleMethod

public java.lang.String getLoginHandleMethod()

Gets the name of the ProfileFormHandler method that is called for handling login.

The default value is "login".

Returns:

the name of the login handle method

setLoginHandleMethod

public void setLoginHandleMethod(java.lang.String pLoginHandleMethod)

Sets the name of the ProfileFormHandler method that is called for handling login.

Parameters:

pLoginHandleMethod - the name of the login handle method

getLogoutHandleMethod

public java.lang.String getLogoutHandleMethod()

Gets the name of the ProfileFormHandler method that is called for handling logout.

The default value is "logout".

Returns:

the name of the logout handle method

setLogoutHandleMethod

public void setLogoutHandleMethod(java.lang.String pLogoutHandleMethod)

Sets the name of the ProfileFormHandler method that is called for handling logout.

Parameters:

pLogoutHandleMethod - the name of the logout handle method

getEmbeddedResources

public java.util.Properties getEmbeddedResources()

Gets the embedded resources

Returns:

the EmbeddedResources value

setEmbeddedResources

public void setEmbeddedResources(java.util.Properties pEmbeddedResources)

Sets the EmbeddedResources property

Parameters:

pEmbeddedResources - - the EmbeddedResources value

login

@Endpoint(id="/currentUser/login#POST",
          filterId="currentUser.login-Default")
public java.util.Map<java.lang.String,java.lang.String> login(java.lang.String pGrantType,
                                                                                                                                                      java.lang.String pLogin,
                                                                                                                                                      java.lang.String pPassword)
                                                                                                                                               throws RestException,
                                                                                                                                                      atg.security.oauth.OAuthSecurityException,
                                                                                                                                                      javax.servlet.ServletException

This endpoint authenticates a user based on the credentials passed and returns an access token.

Parameters:

pGrantType - the grant type

pLogin - the login

pPassword - the password

Returns:

the access token is returned

Throws:

RestException - if something went wrong during login

atg.security.oauth.OAuthSecurityException - if something went wrong during login

javax.servlet.ServletException - if something went wrong during login

getCurrentUser

@Endpoint(id="/currentUser#GET",
          isSingular=true,
          filterId="users.id-Default")
public RepresentationModel getCurrentUser()
                                                                                                                                      throws RestException

Gets the current user.

Returns:

a representation of the current user

Throws:

RestException - if something went wrong whilst getting the current user

logout

@Endpoint(id="/currentUser/logout#POST")
public Response logout()
                                                         throws RestException,
                                                                javax.servlet.ServletException

This endpoint method discards the current user's access token.

Returns:

a response indicating if the logout succeeded or failed

Throws:

RestException - if something went wrong during logout

javax.servlet.ServletException - if something went wrong during login

refreshToken

@Endpoint(id="/currentUser/refresh#POST",
          filterId="currentUser.login-Default",
          security="logged-in")
public java.util.Map<java.lang.String,java.lang.String> refreshToken()
                                                                                                                                                                                        throws RestException

A new token is generated and returned.

Returns:

the access token is returned

Throws:

RestException - if something went wrong whilst refreshing the token

register

@Endpoint(id="/currentUser/#POST",
          validatorId="users.id-Full",
          filterId="users.id.register-Default")
public RepresentationModel register(org.json.JSONObject pInputJson)
                                                                                                                                                       throws RestException,
                                                                                                                                                              RepositoryException,
                                                                                                                                                              atg.security.oauth.OAuthSecurityException,
                                                                                                                                                              java.net.URISyntaxException,
                                                                                                                                                              javax.servlet.ServletException

Registers a new user.

Parameters:

pInputJson - JSON representation of the user

Returns:

a representation of the user

Throws:

RestException - if something went wrong whilst registering the user

RepositoryException - if something went wrong whilst registering the user

atg.security.oauth.OAuthSecurityException - if something went wrong whilst registering the user

java.net.URISyntaxException - if something went wrong whilst registering the user

javax.servlet.ServletException - if something went wrong whilst registering the user

updateUser

@PATCH
 @Endpoint(id="/currentUser/#PATCH",
          isSingular=true,
          validatorId="users.id-Full",
          filterId="users.id-Default")
public RepresentationModel updateUser(org.json.JSONObject pInputJson)
                                                                                                                                                                                    throws RestException,
                                                                                                                                                                                           RepositoryException,
                                                                                                                                                                                           javax.servlet.ServletException

This endpoint updates the current user and any updateable (those that implement atg.service.jaxrs.restresources.UpdateableRestResource) resources configured on embeddedResources property.

Parameters:

pInputJson - JSON representation of the current user

Returns:

a representation of the current user

Throws:

RestException - if something went wrong updating the current user

RepositoryException - if something went wrong updating the current user

javax.servlet.ServletException - if something went wrong updating the current user

getAddresses

@SubresourceLocator(subresourceIds="atg.userprofiling.restresources.currentUserAddressRestSubresource")
public java.lang.Object getAddresses()
                                                                                                                                      throws RestException

Gets the address rest subresource.

Returns:

the addresses

Throws:

RestException - if something went wrong whilst getting the addresses

getProfile

public RepositoryItem getProfile()
                          throws RestException

Retrieves the current profile and makes sure there is one.

Returns:

the profile for the current request

Throws:

RestException - if there is a problem obtaining the profile.

addInputsForCreateUser

protected boolean addInputsForCreateUser(FormHandlerExecutor pExecutor,
                                         org.json.JSONObject pInputJson,
                                         atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)
                                  throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the create user operation.

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

pInputJson - representation of the details to be added

pResourceUpdateInfo - a ResourceUpdateInfo containing data to be used during profile creation

Returns:

true if inputs were added successfully, false otherwise

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

addInputsForUpdateUser

protected void addInputsForUpdateUser(FormHandlerExecutor pExecutor,
                                      org.json.JSONObject pInputJson,
                                      atg.service.jaxrs.ResourceUpdateInfo pResourceUpdateInfo)
                               throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the update user operation.

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

pInputJson - representation of the details to be added

pResourceUpdateInfo - a ResourceUpdateInfo containing data to be used during profile update

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

addInputsForLogin

protected void addInputsForLogin(FormHandlerExecutor pExecutor,
                                 java.lang.String pLogin,
                                 java.lang.String pPassword)
                          throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the login operation. Out of the box, the form handler properties that are set are:

• login
• password

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

pLogin - the login

pPassword - the password

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

addInputsForLogout

protected void addInputsForLogout(FormHandlerExecutor pExecutor)
                           throws javax.servlet.ServletException

This method provides a place from which to add form handler input during the logout operation. Out of the box, the form handler properties that are set are:

To add additional input, call one of the variants of FormHandlerExecutor.addInput(String, Object).

Parameters:

pExecutor - the form handler executor to which the input should be added

Throws:

javax.servlet.ServletException - if a problem occurred whilst adding input to the executor

getLockKey

public java.io.Serializable getLockKey()

Need to provide a lock key based on the current user profile id

Specified by:

getLockKey in interface LockKeyProvider

Returns:

String lock key

getRepresentationModelBuilder

protected RepresentationModel.Builder getRepresentationModelBuilder(java.lang.Object pState)

Gets the RepresentationModel.Builder with the given object acting as the state.

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state

getRepresentationModelBuilderWithEmbeddedDetails

protected RepresentationModel.Builder getRepresentationModelBuilderWithEmbeddedDetails(java.lang.Object pState)
                                                                                throws RestException

Gets the RepresentationModel.Builder with the given object acting as the state.

Also includes embedded addresses.

Parameters:

pState - the state that will be added to the representation model

Returns:

RepresentationModel.Builder containing the state and the embedded cart

Throws:

RestException

getAddressesUri

protected java.lang.String getAddressesUri()

Build a resource URI for the Addresses.

Returns:

Resource URI for Addresses.

update

public java.net.URI update(atg.service.jaxrs.ResourceUpdateInfo pRestResourceUpdateInfo)
                    throws RestException

This method specifically handles updates to any embedded resources, all contained with pRestResourceUpdateInfo. It will call updateEmbeddedResources() to update any of the updateable resources configured on this resource

Specified by:

update in interface UpdateableRestResource

Parameters:

pRestResourceUpdateInfo - - currentUser update object, containing update data (request inputs and any existing repository data) to be applied to its updateable embedded resources

Returns:

URI - self link to any newly created item, or null if none created

Throws:

RestException - - if an issue occurs performing the update