atg.userprofiling.restresources

Class UserRestResource

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.userprofiling.restresources.UserRestResource

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, java.util.EventListener

@RestResource(id="atg.userprofiling.restresources.userRestResource")
public class UserRestResource
extends GenericService

This class represents a user resource. It has the functionality to create a user and update expired password.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CONFIRMATION_PASSWORD_PROPERTY
static java.lang.String	CREATE
ProfileTools	mProfileTools The ProfileTools component
static java.lang.String	NEW_PASSWORD_PROPERTY
static java.lang.String	OLD_PASSWORD_PROPERTY

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

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAddresses(java.lang.String pUserId) Gets the address rest subresource.
protected java.lang.String	getAddressesUri(java.lang.String pProfileId) Build a resource URI for the Addresses.
java.lang.String	getEmbeddedAddressesRelationshipName() Get the relationship name used when embedding the addresses resource.
java.lang.String[]	getIgnoreProperties() Gets the ignore properties.
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.
RepresentationModel	getUser(java.lang.String pUserId) Gets a user based on user id.
void	setEmbeddedAddressesRelationshipName(java.lang.String pEmbeddedAddressesRelationshipName) Configure the relationship name used for embedded addresses.
void	setIgnoreProperties(java.lang.String[] pIgnoreProperties) Sets the ignore properties.
void	setProfileTools(ProfileTools pProfileTools) Sets the ProfileTools component.
java.util.Map<java.lang.String,java.lang.Boolean>	updateExpiredPassword(org.json.JSONObject pInputJson) This end point should be used for updating a password.
protected void	validateProfile(RepositoryItem pProfile, java.lang.String pUserId) It validates the profile id against the supplied user id.

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

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

OLD_PASSWORD_PROPERTY

public static final java.lang.String OLD_PASSWORD_PROPERTY

See Also:

Constant Field Values

NEW_PASSWORD_PROPERTY

public static final java.lang.String NEW_PASSWORD_PROPERTY

See Also:

Constant Field Values

CONFIRMATION_PASSWORD_PROPERTY

public static final java.lang.String CONFIRMATION_PASSWORD_PROPERTY

See Also:

Constant Field Values

mProfileTools

public ProfileTools mProfileTools

The ProfileTools component

Constructor Detail

UserRestResource

public UserRestResource()

Method Detail

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

getIgnoreProperties

public java.lang.String[] getIgnoreProperties()

Gets the ignore properties.

Returns:

the ignore properties

setIgnoreProperties

public void setIgnoreProperties(java.lang.String[] pIgnoreProperties)

Sets the ignore properties.

Parameters:

pIgnoreProperties - the new ignore properties

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

updateExpiredPassword

@Endpoint(id="/users/updateExpiredPassword#POST",
          validatorId="users.updateExpiredPassword",
          filterId="users.updateExpiredPassword-Default")
public java.util.Map<java.lang.String,java.lang.Boolean> updateExpiredPassword(org.json.JSONObject pInputJson)
                                                                                                                                                                                                                                         throws RestException,
                                                                                                                                                                                                                                                atg.userprofiling.PasswordChangeException,
                                                                                                                                                                                                                                                RepositoryException,
                                                                                                                                                                                                                                                PropertyNotFoundException

This end point should be used for updating a password. If the password has expired, then login, old password, new password and confirmation password values are required, as part of the input data.

Parameters:

pInputJson - JSON representation of the password data

Returns:

a map containing a "success" entry if the password was successfully updated

Throws:

RestException - if something went wrong whilst updating an expired password

atg.userprofiling.PasswordChangeException - if something went wrong whilst updating an expired password

RepositoryException - if something went wrong whilst updating an expired password

PropertyNotFoundException - if something went wrong whilst updating an expired password

getUser

@Endpoint(id="/users/{userId}#GET",
          isSingular=true,
          filterId="users.id-Default",
          security="logged-in")
public RepresentationModel getUser(java.lang.String pUserId)
                                                                                                                                                                  throws RestException

Gets a user based on user id. It does not allow to access the resource if the current user id does not match with supplied user id.

Parameters:

pUserId - the user id

Returns:

a representation of the user

Throws:

RestException - if something went wrong whilst creating the representation model

getAddresses

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

Gets the address rest subresource.

Parameters:

pUserId - the user id

Returns:

the addresses

Throws:

RestException - if something went wrong whilst getting the addresses

validateProfile

protected void validateProfile(RepositoryItem pProfile,
                               java.lang.String pUserId)
                        throws RestException

It validates the profile id against the supplied user id. If the id matches then the validation is successful otherwise it throws a RestException with message as 'Access Denied' exception.

Parameters:

pProfile - the profile

pUserId - the user id

Throws:

RestException - if the given profile repository item does not match against the given user id

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 - if the RepresentationModel.Builder could not be created

getAddressesUri

protected java.lang.String getAddressesUri(java.lang.String pProfileId)
                                    throws RestException

Build a resource URI for the Addresses.

Parameters:

pProfileId - profile id

Returns:

Resource URI for Addresses

Throws:

RestException - if the addresses uri could not be created