org.forgerock.android.auth

Class PushNotification.PushNotificationBuilder

java.lang.Object

org.forgerock.android.auth.PushNotification.PushNotificationBuilder

Enclosing class:

PushNotification

public static class PushNotification.PushNotificationBuilder
extends java.lang.Object

Builder class responsible for producing Notifications.

Constructor Summary

Constructors

Constructor and Description
PushNotificationBuilder()

Method Summary

Modifier and Type	Method and Description
protected PushNotification	build() Build the notification.
PushNotification.PushNotificationBuilder	setAmlbCookie(java.lang.String amlbCookie) Set the he AM load balance cookie with this notification.
PushNotification.PushNotificationBuilder	setApproved(boolean approved) Sets whether the authentication the notification is related to was approved.
PushNotification.PushNotificationBuilder	setChallenge(java.lang.String challenge) Set the challenge that was sent with this notification.
PushNotification.PushNotificationBuilder	setMechanismUID(java.lang.String mechanismUID) Sets the mechanism unique Id.
PushNotification.PushNotificationBuilder	setMessageId(java.lang.String messageId) Sets the message id that was received with this notification.
PushNotification.PushNotificationBuilder	setPending(boolean pending) Sets whether the authentication the notification is related to has been handled.
PushNotification.PushNotificationBuilder	setTimeAdded(java.util.Calendar timeAdded) Sets the date that the notification was received.
PushNotification.PushNotificationBuilder	setTimeExpired(java.util.Calendar timeExpired) Sets the date that the notification will automatically fail.
PushNotification.PushNotificationBuilder	setTtl(long ttl) Sets the time to live for the notification.

Methods inherited from class java.lang.Object

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

Constructor Detail

PushNotificationBuilder

public PushNotificationBuilder()

Method Detail

setMechanismUID

public PushNotification.PushNotificationBuilder setMechanismUID(java.lang.String mechanismUID)

Sets the mechanism unique Id.

Parameters:

mechanismUID - the mechanism unique Id.

Returns:

The current builder.

setMessageId

public PushNotification.PushNotificationBuilder setMessageId(java.lang.String messageId)

Sets the message id that was received with this notification.

Parameters:

messageId - The messageId that was received.

Returns:

The current builder.

setChallenge

public PushNotification.PushNotificationBuilder setChallenge(java.lang.String challenge)

Set the challenge that was sent with this notification.

Parameters:

challenge - The base64 encoded challenge.

Returns:

The current builder.

setAmlbCookie

public PushNotification.PushNotificationBuilder setAmlbCookie(java.lang.String amlbCookie)

Set the he AM load balance cookie with this notification.

Parameters:

amlbCookie - the load balance cookie.

Returns:

The current builder.

setTimeAdded

public PushNotification.PushNotificationBuilder setTimeAdded(java.util.Calendar timeAdded)

Sets the date that the notification was received.

Parameters:

timeAdded - The date received in UTC.

Returns:

The current builder.

setTimeExpired

public PushNotification.PushNotificationBuilder setTimeExpired(java.util.Calendar timeExpired)

Sets the date that the notification will automatically fail.

Parameters:

timeExpired - The expiry date.

Returns:

The current builder.

setTtl

public PushNotification.PushNotificationBuilder setTtl(long ttl)

Sets the time to live for the notification.

Parameters:

ttl - The expiry date.

Returns:

The current builder.

setApproved

public PushNotification.PushNotificationBuilder setApproved(boolean approved)

Sets whether the authentication the notification is related to was approved.

Parameters:

approved - True if the authentication was approved, false otherwise.

Returns:

The current builder.

setPending

public PushNotification.PushNotificationBuilder setPending(boolean pending)

Sets whether the authentication the notification is related to has been handled.

Parameters:

pending - True if the authentication has not been handled, false otherwise.

Returns:

The current builder.

build

protected PushNotification build()
                          throws InvalidNotificationException

Build the notification.

Returns:

The final notification.

Throws:

InvalidNotificationException - if timeAdded or mechanismUID are not provided