com.gemalto.idp.mobile.otp

Enum OtpConfiguration.TokenRootPolicy

java.lang.Object

java.lang.Enum<OtpConfiguration.TokenRootPolicy>

com.gemalto.idp.mobile.otp.OtpConfiguration.TokenRootPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OtpConfiguration.TokenRootPolicy>

Enclosing class:

OtpConfiguration

public static enum OtpConfiguration.TokenRootPolicy
extends java.lang.Enum<OtpConfiguration.TokenRootPolicy>

The token behavior policy of the Mobile Protector SDK when the physical device is detected as being rooted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL A RootPolicyException is thrown when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.
IGNORE No action is taken when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.
REMOVE_ALL_TOKENS A RootPolicyException is thrown and all tokens are silently removed when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.
REMOVE_TOKEN A RootPolicyException is thrown and the associated token is silently removed when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.

Method Summary

Modifier and Type	Method and Description
static OtpConfiguration.TokenRootPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OtpConfiguration.TokenRootPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IGNORE

public static final OtpConfiguration.TokenRootPolicy IGNORE

No action is taken when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.

FAIL

public static final OtpConfiguration.TokenRootPolicy FAIL

A RootPolicyException is thrown when calling a method in the Mobile Protector SDK that detects if the physical device is rooted. Notice! This is the default root policy.

REMOVE_TOKEN

public static final OtpConfiguration.TokenRootPolicy REMOVE_TOKEN

A RootPolicyException is thrown and the associated token is silently removed when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.

REMOVE_ALL_TOKENS

public static final OtpConfiguration.TokenRootPolicy REMOVE_ALL_TOKENS

A RootPolicyException is thrown and all tokens are silently removed when calling a method in the Mobile Protector SDK that detects if the physical device is rooted.

Method Detail

values

public static OtpConfiguration.TokenRootPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OtpConfiguration.TokenRootPolicy c : OtpConfiguration.TokenRootPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OtpConfiguration.TokenRootPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null