com.adobe.livecycle.rca
Interface ExternalUserRegistration

public interface ExternalUserRegistration

Method Summary

ExternalUsersTO	getExternalUserTO(String authKey) This operation returns an ExternalUsersTO for an authkey.
Map	inviteExternalUsers(List externalUserTOList) This operation persists external user information and sends invitation email.
void	registerExternalUser(String authKey, String email, String password, String telephoneNo) This operation registers external user.

Method Detail

inviteExternalUsers

Map inviteExternalUsers(List externalUserTOList)
                        throws ICRException

This operation persists external user information and sends invitation email.

• It takes a list of ExternalUsersTO as input.
• It persists the data with email as primary key and tries to send invitation email to all unregistered users.
• The invitation email contains a link to user registration page appended by system generated string (authkey).
• It returns a map of ExternalUserTO along with the status. Status can have following values {USED, SUCCESS, EXCEPTION}.

Parameters:

externalUserTOList - List (Required Parameter)

Returns:

Map Map of ExternalUserTO along with the status.

Throws:

ICRException

registerExternalUser

void registerExternalUser(String authKey,
                          String email,
                          String password,
                          String telephoneNo)
                          throws ICRException

This operation registers external user.

• It validates the authkey. If authkey is already used or is not present in database, InvalidAuthKeyException is thrown
• For valid authey key, a local user is created in LC User Management
• The user will be created in domain configured at the dsc
• If domain is not configured a RuntimeException is thrown

Parameters:

authKey - System generated authkey generated while persisting external user information. (Required Parameter)

email - Email of the user. This will be userid of the registered user. (Required Parameter)

password - Password of the user. Registered user will use this password to access LC System. (Required Parameter)

telephoneNo - Telephone Number of the user.

Throws:

InvalidAuthKeyException

ICRException

getExternalUserTO

ExternalUsersTO getExternalUserTO(String authKey)
                                  throws ICRException

This operation returns an ExternalUsersTO for an authkey.

• It validates the authkey. If authkey is already used or is not present in database, InvalidAuthKeyException is thrown
• For valid authey key, ExternalUsersTO is returned

Parameters:

authKey - System generated authkey generated while persisting external user information. (Required Parameter)

Returns:

ExternalUsersTO

Throws:

InvalidAuthKeyException

ICRException