com.gemalto.idp.mobile.oob.registration

Class OobRegistrationRequest

java.lang.Object

com.gemalto.idp.mobile.oob.registration.OobRegistrationRequest

public class OobRegistrationRequest
extends java.lang.Object

OOB registration request object.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OobRegistrationRequest.RegistrationMethod Registration methods.

Constructor Summary

Constructors

Constructor and Description
OobRegistrationRequest(java.lang.String userId, java.lang.String userAliasForClient, OobRegistrationRequest.RegistrationMethod registrationMethod, SecureString registrationParameter) Constructs the OOB registration request object: Variant w/o any notification endpoints set.
OobRegistrationRequest(java.lang.String userId, java.lang.String userAliasForClient, OobRegistrationRequest.RegistrationMethod registrationMethod, SecureString registrationParameter, java.util.List<OobNotificationProfile> notificationProfiles) Constructs the OOB registration request object: Variant with the notification endpoints set.

Method Summary

Modifier and Type	Method and Description
java.util.List<OobNotificationProfile>	getNotificationProfiles() Retrieves the list of notification profiles to be initially configured to the user upon the registration.
OobRegistrationRequest.RegistrationMethod	getRegistrationMethod() Retrieves the result of the registration operation.
SecureString	getRegistrationParameter() Retrieves the value of the registration code.
java.lang.String	getUserAliasForClient() Retrieves the human readable alias for this client.
java.lang.String	getUserId() Retrieves the ID of the user who registers to the OOBS.

Methods inherited from class java.lang.Object

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

Constructor Detail

OobRegistrationRequest

public OobRegistrationRequest(java.lang.String userId,
                              java.lang.String userAliasForClient,
                              OobRegistrationRequest.RegistrationMethod registrationMethod,
                              SecureString registrationParameter)

Constructs the OOB registration request object: Variant w/o any notification endpoints set.

Parameters:

userId - The ID of the user who registers to the OOBS.

userAliasForClient - Human readable alias for this client.

registrationMethod - The registration method to be used for the registration to the OOBS.

registrationParameter - The registration parameter. Its meaning depends on the value of the registration method - see previous parameter.

OobRegistrationRequest

public OobRegistrationRequest(java.lang.String userId,
                              java.lang.String userAliasForClient,
                              OobRegistrationRequest.RegistrationMethod registrationMethod,
                              SecureString registrationParameter,
                              java.util.List<OobNotificationProfile> notificationProfiles)

Constructs the OOB registration request object: Variant with the notification endpoints set.

Parameters:

userId - The ID of the user who registers to the OOBS.

userAliasForClient - Human readable alias for this client.

registrationMethod - The registration method to be used for the registration to the OOBS.

registrationParameter - The registration parameter. Its meaning depends on the value of the registration method - see previous parameter.

notificationProfiles - The notification endpoints to initially add to the currently being registered user. The notification endpoints can later be changed using the OobNotificationManager. Passing null here makes this method to behave like the one w/o any notification endpoints.

Method Detail

getUserId

public java.lang.String getUserId()

Retrieves the ID of the user who registers to the OOBS.

Returns:

The user ID, never null.

getUserAliasForClient

public java.lang.String getUserAliasForClient()

Retrieves the human readable alias for this client.

Returns:

The user alias, never null.

getNotificationProfiles

public java.util.List<OobNotificationProfile> getNotificationProfiles()

Retrieves the list of notification profiles to be initially configured to the user upon the registration.

Returns:

The notification profiles.

getRegistrationMethod

public OobRegistrationRequest.RegistrationMethod getRegistrationMethod()

Retrieves the result of the registration operation.

Returns:

The result of the registration operation, never null.

getRegistrationParameter

public SecureString getRegistrationParameter()

Retrieves the value of the registration code.

Returns:

The registration code or null.