org.forgerock.caf.authentication.framework

Class AuthStatusUtils

java.lang.Object

org.forgerock.caf.authentication.framework.AuthStatusUtils

public final class AuthStatusUtils
extends Object

Utility class providing utility methods for determining the meaning behind each of the different AuthStatus values.

Since:

1.5.0

Method Summary

Modifier and Type	Method and Description
static String	asString(javax.security.auth.message.AuthStatus authStatus) Converts the given AuthStatus into its String representation.
static boolean	isFailure(javax.security.auth.message.AuthStatus authStatus) Returns true if the given AuthStatus value is AuthStatus.FAILURE.
static boolean	isNull(javax.security.auth.message.AuthStatus authStatus) Returns true if the given AuthStatus value is null.
static boolean	isSendContinue(javax.security.auth.message.AuthStatus authStatus) Returns true if the given AuthStatus value is AuthStatus.SEND_CONTINUE.
static boolean	isSendFailure(javax.security.auth.message.AuthStatus authStatus) Returns true if the given AuthStatus value is AuthStatus.SEND_FAILURE.
static boolean	isSendSuccess(javax.security.auth.message.AuthStatus authStatus) Returns true if the given AuthStatus value is AuthStatus.SEND_SUCCESS.
static boolean	isSuccess(javax.security.auth.message.AuthStatus authStatus) Returns true if the given AuthStatus value is AuthStatus.SUCCESS.

Methods inherited from class java.lang.Object

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

Method Detail

asString

public static String asString(javax.security.auth.message.AuthStatus authStatus)

Converts the given AuthStatus into its String representation.

Parameters:

authStatus - The AuthStatus.

Returns:

An AuthStatus String.

isSuccess

public static boolean isSuccess(javax.security.auth.message.AuthStatus authStatus)

Returns true if the given AuthStatus value is AuthStatus.SUCCESS.

Parameters:

authStatus - The AuthStatus value.

Returns:

true if the given AuthStatus value is AuthStatus.SUCCESS.

isSendSuccess

public static boolean isSendSuccess(javax.security.auth.message.AuthStatus authStatus)

Returns true if the given AuthStatus value is AuthStatus.SEND_SUCCESS.

Parameters:

authStatus - The AuthStatus value.

Returns:

true if the given AuthStatus value is AuthStatus.SEND_SUCCESS.

isSendContinue

public static boolean isSendContinue(javax.security.auth.message.AuthStatus authStatus)

Returns true if the given AuthStatus value is AuthStatus.SEND_CONTINUE.

Parameters:

authStatus - The AuthStatus value.

Returns:

true if the given AuthStatus value is AuthStatus.SEND_CONTINUE.

isSendFailure

public static boolean isSendFailure(javax.security.auth.message.AuthStatus authStatus)

Returns true if the given AuthStatus value is AuthStatus.SEND_FAILURE.

Parameters:

authStatus - The AuthStatus value.

Returns:

true if the given AuthStatus value is AuthStatus.SEND_FAILURE.

isFailure

public static boolean isFailure(javax.security.auth.message.AuthStatus authStatus)

Returns true if the given AuthStatus value is AuthStatus.FAILURE.

Parameters:

authStatus - The AuthStatus value.

Returns:

true if the given AuthStatus value is AuthStatus.FAILURE.

isNull

public static boolean isNull(javax.security.auth.message.AuthStatus authStatus)

Returns true if the given AuthStatus value is null.

Parameters:

authStatus - The AuthStatus value.

Returns:

true if the given AuthStatus value is null.