@Encoded public class PersonHandler extends AbstractConfigBasedClassicHandler
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_MEMBER_ID
The constant PARAMETER_MEMBER_ID
|
static java.lang.String | PARAMETER_SCOPED_BY_ORGS_I_CAN_ADMIN
The constant PARAMETER_SCOPED_BY_ORGS_I_CAN_ADMIN
|
static java.lang.String | PARAMETER_USER_ID
The constant PARAMETER_USER_ID
|
static java.lang.String | PARAMETER_USER_ID_DESCRIPTION
The constant PARAMETER_USER_ID_DESCRIPTION
|
static java.lang.String | RESOURCE_MAPPING_KEY
The Constant RESOURCE_MAPPING_KEY.
|
static java.lang.String | RESOURCE_NAME
Resource name for person.
|
Constructor and Description |
---|
PersonHandler() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response | assignRoleByAdmin(java.lang.String storeId, java.lang.String userId)
This allows an administrator to assign role(s) to a registered user.
|
javax.ws.rs.core.Response | deleteContextAttributeForPerson(java.lang.String jobName, java.lang.String values, java.lang.String storeId, java.lang.String responseFormat)
Deletes one or more context attributes of an existing person.
|
javax.ws.rs.core.Response | findByQuery(java.lang.String storeId, java.lang.String queryName)
This allows an administrator to find users based on a query name.
|
javax.ws.rs.core.Response | findByUserId(java.lang.String storeId, java.lang.String userId)
This allows an administrator to find user information by user identifier.
|
javax.ws.rs.core.Response | findByUserIdWAssignedRolesDetailsProfileName(java.lang.String storeId, java.lang.String userId)
Internal method findByUserIdWAssignedRolesDetailsProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findByUserIdWRolesOfUserAllProfileName(java.lang.String storeId, java.lang.String userId)
Internal method findByUserIdWRolesOfUserAllProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findByUserIdWRolesOfUserInOrgsICanAdminProfileName(java.lang.String storeId, java.lang.String userId)
Internal method findByUserIdWRolesOfUserInOrgsICanAdminProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findByUserIdWUserRegistrationDetailsProfileName(java.lang.String storeId, java.lang.String userId)
Internal method findByUserIdWUserRegistrationDetailsProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findByUserIdWUserRegistrationSummaryProfileName(java.lang.String storeId, java.lang.String userId)
Internal method findByUserIdWUserRegistrationSummaryProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findByUserIdWUserTopLevelOrganizationsAdministered(java.lang.String storeId, java.lang.String userId)
Internal method findByUserIdWUserTopLevelOrganizationsAdministered for documentation ONLY.
|
javax.ws.rs.core.Response | findOptOutBySelf(java.lang.String storeId)
Find personal opt-out.
|
javax.ws.rs.core.Response | findOptOutBySelfWOptOutAllProfileName(java.lang.String storeId)
Internal method findOptOutBySelfWOptOutAllProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findOptOutBySelfWOptOutSmsProfileName(java.lang.String storeId)
Internal method findOptOutBySelfWOptOutSmsProfileName for documentation ONLY.
|
javax.ws.rs.core.Response | findPersonBySelf(java.lang.String storeId, java.lang.String responseFormat)
This method retrieves user data for the logged in user using Member service.
|
java.lang.String | getFormattingGroupName()
This method returns the format group name to locate JSP template.
|
PersonHelper | getHelper()
This method returns the BOD helper used to get product data
|
java.lang.String | getResourceName() |
void | initializeActionRegistry(OperationRegistry registry) |
void | initializeQueryRegistry(OperationRegistry registry)
Initializes the registry mapping between the query names and the methods being called to handle requests.
|
javax.ws.rs.core.Response | performActionByAdmin(java.lang.String storeId, java.lang.String userId)
Performs an action on a person.
|
void | postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap) |
protected javax.ws.rs.core.Response | registerPerson(javax.servlet.http.HttpServletRequest request, java.lang.String responseFormat)
This method invokes the BOD service to register a user.
|
javax.ws.rs.core.Response | registerPerson(java.lang.String storeId, java.lang.String responseFormat)
Registers a new user.
|
protected javax.ws.rs.core.Response | registerPersonByAdmin(java.lang.String storeId, java.lang.String responseFormat)
This method invokes the controller command to register a user by an administrator.
|
javax.ws.rs.core.Response | registerPersonOnUserRegistrationAdminAdd(java.lang.String storeId, java.lang.String responseFormat)
Internal method registerPersonOnUserRegistrationAdminAdd for documentation ONLY.
|
protected javax.ws.rs.core.Response | renderGetPerson(java.lang.String expression, java.lang.String accessProfile, java.lang.String responseFormat)
This method will invoke Member service to get person data and generate REST response.
|
protected javax.ws.rs.core.Response | renderUpdatePerson(java.util.Map<java.lang.String,java.lang.Object> resultData, java.lang.String responseFormat, org.apache.wink.common.http.HttpStatus status)
Render response data for processing or changing data using a Map instead of DataObject.
|
javax.ws.rs.core.Response | unassignRoleByAdmin(java.lang.String storeId, java.lang.String userId)
This allows an administrator to unassign role(s) from a registered user.
|
javax.ws.rs.core.Response | updateMemberUser(java.lang.String storeId, java.lang.String userId)
Updates user to be included/excluded from a member group or to be unassigned
|
javax.ws.rs.core.Response | updatePerson(java.lang.String storeId, java.lang.String responseFormat)
Update user account data for a registered shopper.
|
javax.ws.rs.core.Response | updatePersonByAdmin(java.lang.String storeId, java.lang.String userId)
This allows an administrator to update account data for a registered user.
|
javax.ws.rs.core.Response | updatePersonOnUserRegistrationUpdate(java.lang.String storeId, java.lang.String responseFormat)
Internal method updatePersonOnUserRegistrationUpdate for documentation ONLY.
|
protected javax.ws.rs.core.Response | updateUserRegistration(java.lang.String storeId, java.lang.String responseFormat)
This method will updateUserRegistration information using the UserRegistrationUpdateCmd.
|
javax.ws.rs.core.Response | usersICanAdmin(java.lang.String storeId)
This allows an administrator to find users in organizations that he/she can administer.
|
javax.ws.rs.core.Response | usersICanAdminWUserListDetailsProfileName(java.lang.String storeId)
Internal method usersICanAdminWUserListDetailsProfileName for documentation ONLY.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String RESOURCE_NAME
public static final java.lang.String RESOURCE_MAPPING_KEY
public static final java.lang.String FORMAT_GROUP_NAME
public static final java.lang.String PARAMETER_USER_ID
public static final java.lang.String PARAMETER_USER_ID_DESCRIPTION
public static final java.lang.String PARAMETER_MEMBER_ID
public static final java.lang.String PARAMETER_SCOPED_BY_ORGS_I_CAN_ADMIN
public void initializeQueryRegistry(OperationRegistry registry)
public void initializeActionRegistry(OperationRegistry registry)
public java.lang.String getResourceName()
public java.lang.String getFormattingGroupName()
public PersonHelper getHelper()
public javax.ws.rs.core.Response findPersonBySelf(java.lang.String storeId, java.lang.String responseFormat)
public javax.ws.rs.core.Response findByUserId(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response findByUserIdWUserRegistrationDetailsProfileName(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response findByUserIdWUserRegistrationSummaryProfileName(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response findByUserIdWAssignedRolesDetailsProfileName(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response findByUserIdWUserTopLevelOrganizationsAdministered(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response findByUserIdWRolesOfUserAllProfileName(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response findByUserIdWRolesOfUserInOrgsICanAdminProfileName(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response usersICanAdmin(java.lang.String storeId)
public javax.ws.rs.core.Response usersICanAdminWUserListDetailsProfileName(java.lang.String storeId)
public javax.ws.rs.core.Response findByQuery(java.lang.String storeId, java.lang.String queryName)
public javax.ws.rs.core.Response findOptOutBySelf(java.lang.String storeId)
public javax.ws.rs.core.Response findOptOutBySelfWOptOutSmsProfileName(java.lang.String storeId)
public javax.ws.rs.core.Response findOptOutBySelfWOptOutAllProfileName(java.lang.String storeId)
public javax.ws.rs.core.Response registerPerson(java.lang.String storeId, java.lang.String responseFormat)
public javax.ws.rs.core.Response registerPersonOnUserRegistrationAdminAdd(java.lang.String storeId, java.lang.String responseFormat)
protected javax.ws.rs.core.Response registerPerson(javax.servlet.http.HttpServletRequest request, java.lang.String responseFormat) throws java.lang.Exception
protected javax.ws.rs.core.Response registerPersonByAdmin(java.lang.String storeId, java.lang.String responseFormat) throws java.lang.Exception
public javax.ws.rs.core.Response updatePerson(java.lang.String storeId, java.lang.String responseFormat)
Supporting 2 scenarios to reset a shopper's password:
While unauthenticated: If you do not know the password and want to reset password, you will pass in a Map with the following keys.
b) Two-step process: Beginning in 7.0.0.9, the CMDREG.PROPERTIES of ResetPasswordGuestCmd can be updated to include inSessionValidationCode=true to enable the following flow. (Note: A guest identity must be obtained before this two-step process can be invoked):
public javax.ws.rs.core.Response updatePersonOnUserRegistrationUpdate(java.lang.String storeId, java.lang.String responseFormat)
public javax.ws.rs.core.Response updatePersonByAdmin(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response assignRoleByAdmin(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response unassignRoleByAdmin(java.lang.String storeId, java.lang.String userId)
public javax.ws.rs.core.Response performActionByAdmin(java.lang.String storeId, java.lang.String userId)
protected javax.ws.rs.core.Response updateUserRegistration(java.lang.String storeId, java.lang.String responseFormat)
public javax.ws.rs.core.Response deleteContextAttributeForPerson(java.lang.String jobName, java.lang.String values, java.lang.String storeId, java.lang.String responseFormat)
protected javax.ws.rs.core.Response renderGetPerson(java.lang.String expression, java.lang.String accessProfile, java.lang.String responseFormat)
protected javax.ws.rs.core.Response renderUpdatePerson(java.util.Map<java.lang.String,java.lang.Object> resultData, java.lang.String responseFormat, org.apache.wink.common.http.HttpStatus status)
public void postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)
public javax.ws.rs.core.Response updateMemberUser(java.lang.String storeId, java.lang.String userId)