org.forgerock.android.auth.callback

Class AbstractValidatedCallback

java.lang.Object

org.forgerock.android.auth.callback.AbstractCallback

org.forgerock.android.auth.callback.AbstractValidatedCallback

All Implemented Interfaces:

java.io.Serializable, Callback

Direct Known Subclasses:

AttributeInputCallback, ValidatedPasswordCallback, ValidatedUsernameCallback

public abstract class AbstractValidatedCallback
extends AbstractCallback

Callbacks that accept user input often need to validate that input either on the client side, the server side or both. Such callbacks should extend this base class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractValidatedCallback.FailedPolicy

Field Summary

Fields inherited from class org.forgerock.android.auth.callback.AbstractCallback

_id, content, VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractValidatedCallback()
AbstractValidatedCallback(org.json.JSONObject jsonObject, int index)

Method Summary

Modifier and Type	Method and Description
java.util.List<AbstractValidatedCallback.FailedPolicy>	getFailedPolicies() Return the list of failed policies for this callback.
org.json.JSONObject	getPolicies() Return the validation policies that should be applied to the input collected by this callback.
abstract java.lang.String	getPrompt()
java.lang.Boolean	getValidateOnly()
protected void	setAttribute(java.lang.String name, java.lang.Object value)
void	setValidateOnly(boolean validateOnly)

Methods inherited from class org.forgerock.android.auth.callback.AbstractCallback

get_id, getContent, getContentAsJson, getInputValue, getInputValue, getName, setContent, setValue, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.android.auth.callback.Callback

getType

Constructor Detail

AbstractValidatedCallback

public AbstractValidatedCallback(org.json.JSONObject jsonObject,
                                 int index)
                          throws org.json.JSONException

Throws:

org.json.JSONException

AbstractValidatedCallback

public AbstractValidatedCallback()

Method Detail

setAttribute

protected void setAttribute(java.lang.String name,
                            java.lang.Object value)

Specified by:

setAttribute in class AbstractCallback

getPrompt

public abstract java.lang.String getPrompt()

setValidateOnly

public void setValidateOnly(boolean validateOnly)

getPolicies

public org.json.JSONObject getPolicies()

Return the validation policies that should be applied to the input collected by this callback. These policies are represented by a name string.

Returns:

validation policies

getFailedPolicies

public java.util.List<AbstractValidatedCallback.FailedPolicy> getFailedPolicies()

Return the list of failed policies for this callback.

Returns:

list of failed policies

getValidateOnly

public java.lang.Boolean getValidateOnly()