com.ibm.commerce.rest.member.handler

Class LoginIdentityHandler

java.lang.Object

com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

com.ibm.commerce.rest.member.handler.LoginIdentityHandler

All Implemented Interfaces:

DocumentedResourceHandler, IResourceHandler

@Path(value="store/{storeId}/loginidentity")
 @Encoded
public class LoginIdentityHandler
extends AbstractResourceHandler

This class provides RESTful services to login and logout a registered shopper using user name and password. It calls Person noun to perform the services.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	FORMAT_GROUP_NAME The constant FORMAT_GROUP_NAME.
static java.lang.String	PARAMETER_GENERATE_LTPA response format
static java.lang.String	PARAMETER_GENERATE_LTPA_DESCRIPTION response format description
static java.lang.String	RESOURCE_NAME The Constant RESOURCE_NAME.

Fields inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

APPLICATION_ATOM_XML, APPLICATION_JSON, APPLICATION_XHTML_XML, APPLICATION_XML, CHANGE_VERB, PARAMETER_ACTION, PARAMETER_ACTION_DESCRIPTION, PARAMETER_CATALOG_ID, PARAMETER_CATALOG_ID_DESCRIPTION, PARAMETER_CURRENCY, PARAMETER_CURRENCY_DESCRIPTION, PARAMETER_FOR_USER, PARAMETER_FOR_USER_DESCRIPTION, PARAMETER_FOR_USER_ID, PARAMETER_FOR_USER_ID_DESCRIPTION, PARAMETER_LANG_ID, PARAMETER_LANG_ID_DESCRIPTION, PARAMETER_LOCALE, PARAMETER_LOCALE_DESCRIPTION, PARAMETER_MODE, PARAMETER_MODE_DESCRIPTION, PARAMETER_PAGE_NUMBER, PARAMETER_PAGE_NUMBER_DESCRIPTION, PARAMETER_PAGE_SIZE, PARAMETER_PAGE_SIZE_DESCRIPTION, PARAMETER_PROFILE_NAME, PARAMETER_PROFILE_NAME_DESCRIPTION, PARAMETER_QUERY, PARAMETER_QUERY_DESCRIPTION, PARAMETER_RESET_PASSWORD_DESCRIPTION, PARAMETER_RESPONSE_FORMAT, PARAMETER_RESPONSE_FORMAT_DESCRIPTION, PARAMETER_STORE_ID, PARAMETER_STORE_ID_DESCRIPTION, PARAMETER_WORKSPACE_IDENTIFIER, PARAMETER_WORKSPACE_IDENTIFIER_DESCRIPTION, PARAMETER_WORKSPACE_NAME, PARAMETER_WORKSPACE_NAME_DESCRIPTION, PARAMETER_WORKSPACE_TASK, PARAMETER_WORKSPACE_TASK_DESCRIPTION, PARAMETER_WORKSPACE_TASKGROUP, PARAMETER_WORKSPACE_TASKGROUP_DESCRIPTION, PROCESS_VERB, RESPONSE_200_DESCRIPTION, RESPONSE_201_DESCRIPTION, RESPONSE_204_DESCRIPTION, RESPONSE_400_DESCRIPTION, RESPONSE_401_DESCRIPTION, RESPONSE_403_DESCRIPTION, RESPONSE_404_DESCRIPTION, RESPONSE_500_DESCRIPTION

Constructor Summary

Constructors

Constructor and Description
LoginIdentityHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExternalResourceName() Get the resource name to show externally.
java.lang.String	getFormattingGroupName() This method returns the format group name to locate JSP template.
java.lang.String	getResourceName() This method returns the name of the resource used primarily to determine the representation of the resource.
javax.ws.rs.core.Response	login(java.lang.String storeId, java.lang.String responseFormat) Login a registered user using user name and password.
javax.ws.rs.core.Response	login(java.lang.String storeId, java.lang.String generateLTPAToken, java.lang.String responseFormat) Login a registered user using user name and password.
java.util.Map	loginUser(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler callbackHandler, java.util.Map inputData) This method authenticates a user by using login name and password.
java.util.Map	loginUser(BusinessContextType bContext, javax.security.auth.callback.CallbackHandler callbackHandler, java.lang.String username, java.lang.String password) This method authenticates a user by using login name and password.
javax.ws.rs.core.Response	logout(java.lang.String storeId, java.lang.String responseFormat) Logout a registered shopper.
javax.ws.rs.core.Response	logout(java.lang.String storeId, java.lang.String generateLTPAToken, java.lang.String responseFormat) Logout a registered shopper.

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractResourceHandler

createMapForProvider, createMapForProvider, generateResponseForEntireDataObject, getMapFromRequest, getStoreId, getUserId, isRequestInPreviewMode, mergeMapsForProvider, prepareAndValidate

Methods inherited from class com.ibm.commerce.foundation.rest.resourcehandler.AbstractBaseResourceHandler

addError, createMapForProviderWithResultData, documentApi, generateResponseFromHttpStatusCodeAndRespData, getActionRegistry, getBooleanParameterValue, getClassDescription, getDoubleParameterValue, getDoubleParameterValues, getEnumeratedParameterValue, getErrorCodeFromMessage, getFormattedMessage, getFormattedMessageWithLocale, getInstrumentor, getIntegerParameterValue, getIntegerParameterValues, getLongParameterValue, getLongParameterValues, getParameterValue, getParameterValue, getParameterValues, getQueryRegistry, getRequest, getResponse, getUriInfo, handleException, initializeActionRegistry, initializeQueryRegistry, performAction, postProcess, preProcess, registerOperationWithMethodSignature, runQuery, staticConvertStreamToString, throwInvalidQueryNameException, throwInvalidQueryNameException, throwRestException, throwRestExceptionIfErrorsAreDetected, validatePageNumberPageSize

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

RESOURCE_NAME

public static final java.lang.String RESOURCE_NAME

The Constant RESOURCE_NAME.

See Also:

Constant Field Values

FORMAT_GROUP_NAME

public static final java.lang.String FORMAT_GROUP_NAME

The constant FORMAT_GROUP_NAME.

See Also:

Constant Field Values

PARAMETER_GENERATE_LTPA

public static final java.lang.String PARAMETER_GENERATE_LTPA

response format

See Also:

Constant Field Values

PARAMETER_GENERATE_LTPA_DESCRIPTION

public static final java.lang.String PARAMETER_GENERATE_LTPA_DESCRIPTION

response format description

See Also:

Constant Field Values

Constructor Detail

LoginIdentityHandler

public LoginIdentityHandler()

Method Detail

getResourceName

public java.lang.String getResourceName()

Description copied from interface: IResourceHandler

This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

Returns:

the resource name

getFormattingGroupName

public java.lang.String getFormattingGroupName()

This method returns the format group name to locate JSP template.

Specified by:

getFormattingGroupName in interface IResourceHandler

Overrides:

getFormattingGroupName in class AbstractBaseResourceHandler

Returns:

formatting group name

login

@POST
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response login(@PathParam(value="storeId")
                                                                                                                                                                                                              java.lang.String storeId,
                                                                                                                                                                                                              @QueryParam(value="generateLTPAToken")
                                                                                                                                                                                                              java.lang.String generateLTPAToken,
                                                                                                                                                                                                              @QueryParam(value="responseFormat")
                                                                                                                                                                                                              java.lang.String responseFormat)

Login a registered user using user name and password.

Parameters:

storeId - store id

generateLTPAToken - the flag to generate LTPA token or not

responseFormat - response format (only JSON is supported)

Returns:

Response containing a Map.

login

@POST
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response login(@PathParam(value="storeId")
                                                                                                                                                                                                              java.lang.String storeId,
                                                                                                                                                                                                              @QueryParam(value="responseFormat")
                                                                                                                                                                                                              java.lang.String responseFormat)

Login a registered user using user name and password.

Parameters:

storeId - store id

responseFormat - response format (only JSON is supported)

Returns:

Response containing a Map.

logout

@DELETE
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Path(value="@self")
public javax.ws.rs.core.Response logout(@PathParam(value="storeId")
                                                                                                                                                                              java.lang.String storeId,
                                                                                                                                                                              @QueryParam(value="generateLTPAToken")
                                                                                                                                                                              java.lang.String generateLTPAToken,
                                                                                                                                                                              @QueryParam(value="responseFormat")
                                                                                                                                                                              java.lang.String responseFormat)

Logout a registered shopper. The authentication tokens obtained during login must be sent back with the request header.

Parameters:

storeId - the store id

generateLTPAToken - the flag to remove LTPA token or not

responseFormat - the response format

Returns:

the response

logout

@DELETE
 @Produces(value={"application/json","application/xml","application/xhtml+xml","application/atom+xml"})
 @Path(value="@self")
public javax.ws.rs.core.Response logout(@PathParam(value="storeId")
                                                                                                                                                                              java.lang.String storeId,
                                                                                                                                                                              @QueryParam(value="responseFormat")
                                                                                                                                                                              java.lang.String responseFormat)

Logout a registered shopper. The authentication tokens obtained during login must be sent back with the request header.

Parameters:

storeId - the store id

responseFormat - the response format

Returns:

the response

loginUser

public java.util.Map loginUser(BusinessContextType bContext,
                               javax.security.auth.callback.CallbackHandler callbackHandler,
                               java.util.Map inputData)
                        throws PersonException

This method authenticates a user by using login name and password.

Parameters:

bContext - the business context

callbackHandler - the callback handler

inputData - The map containing user name and password

Returns:

the map

Throws:

PersonException - the person exception

loginUser

public java.util.Map loginUser(BusinessContextType bContext,
                               javax.security.auth.callback.CallbackHandler callbackHandler,
                               java.lang.String username,
                               java.lang.String password)
                        throws PersonException

This method authenticates a user by using login name and password.

Parameters:

bContext - the b context

callbackHandler - the callback handler

username - the username

password - the password

Returns:

the map

Throws:

PersonException - the person exception

getExternalResourceName

public java.lang.String getExternalResourceName()

Description copied from class: AbstractBaseResourceHandler

Get the resource name to show externally. This defaults to the value returned by getResourceName if this method isn't overridden.

Overrides:

getExternalResourceName in class AbstractBaseResourceHandler

Returns:

The external resource name.