Package org.forgerock.openam.authentication.callbacks

Class PollingWaitCallback

java.lang.Object

org.forgerock.openam.authentication.callbacks.PollingWaitCallback

All Implemented Interfaces:

Callback

@Supported
public final class PollingWaitCallback
extends Object
implements Callback

Class representative of a PollingWaitCallback Callback Object which instructs a client to wait for the given period and then resubmit their request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PollingWaitCallback.PollingWaitCallbackBuilder	Builder object for the PollingWaitCallback.

Method Summary

Modifier and Type	Method	Description
static PollingWaitCallback.PollingWaitCallbackBuilder	builder()	Gets a new PollingWaitCallbackBuilder to use for construction of a PollingWaitCallback.
String	getMessage()	Gets the message associated with this callback.
String	getWaitTime()	Gets the wait time associated with this callback.

Methods inherited from class java.lang.Object

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

Method Details

getWaitTime

@Supported
public String getWaitTime()

Gets the wait time associated with this callback.

Returns:

the wait time in milliseconds to use as a String.

getMessage

@Supported
public String getMessage()

Gets the message associated with this callback.

Returns:

the message to display.

builder

@Supported
public static PollingWaitCallback.PollingWaitCallbackBuilder builder()

Gets a new PollingWaitCallbackBuilder to use for construction of a PollingWaitCallback.

Returns:

a new PollingWaitCallbackBuilder.