Package org.forgerock.openam.auth.node.api

Class SuspendedTextOutputCallback

java.lang.Object

javax.security.auth.callback.TextOutputCallback

org.forgerock.openam.auth.node.api.SuspendedTextOutputCallback

All Implemented Interfaces:

Serializable, Callback

@Supported
public final class SuspendedTextOutputCallback
extends TextOutputCallback

Suspended text output callback extends TextOutputCallback to allow a custom message to be displayed to the user whilst informing the client that the current auth flow has been suspended. Note, this callback only makes sense in the context of being used in line with suspending the current tree, by means of Action#suspend(SuspensionHandler).

Since:

7.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SuspendedTextOutputCallback.Factory	Factory class for creating SuspendedTextOutputCallback instances.

Field Summary

Fields inherited from class javax.security.auth.callback.TextOutputCallback

ERROR, INFORMATION, WARNING

Method Summary

Modifier and Type	Method	Description
static SuspendedTextOutputCallback.Factory	factory()	Method to get a new SuspendedTextOutputCallback.Factory for creating SuspendedTextOutputCallback instances.

Methods inherited from class javax.security.auth.callback.TextOutputCallback

getMessage, getMessageType

Methods inherited from class java.lang.Object

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

Method Details

factory

@Supported
public static SuspendedTextOutputCallback.Factory factory()

Method to get a new SuspendedTextOutputCallback.Factory for creating SuspendedTextOutputCallback instances.

Returns:

a new SuspendedTextOutputCallback.Factory instance