InitializationState Enum Reference

Enumerator describing the current initialization state of the library.

Inherits Serializable.

Public Attributes
	INITIAL
	State of the runtime prior to initialization. More...
	AUTHENTICATION_SETUP_REQUIRED
	The runtime requires a new application password be set. More...
	AUTHENTICATION_REQUIRED
	The runtime requires the correct application password to be entered. More...
	REGISTRATION
	The runtime requires user registration. More...
	TOKENVALIDATION
	The users identity token is being validated by BlackBerry Identity. More...
	ACTIVE
	The security library is active. More...
	TOKENEXPIRED
	The users Identity Token has expired. More...
	DEACTIVATING
	The security library is being deactivated.
	ERROR
	The library is in an error state.

Static Public Attributes
static final String	KEY_SERIALIZABLE = "com.blackberry.security.InitializationState"
	Key for InitializationState value.
static final String	KEY_ERRORTYPE = "com.blackberry.security.ErrorType"
	Key for ErrorType value reflecting possible error condition.
static final String	KEY_HTTPSTATUSCODE = "com.blackberry.security.HTTPStatusCode"
	Key for http status code integer value (which can be 0)
static final String	KEY_BIOMETRY_CANCELLED = "com.blackberry.security.BiometryCancelled"
	Key for boolean notification of cancellation of biometric input (which is true if cancelled)

Member Data Documentation

INITIAL

INITIAL

This is the initial state of the runtime prior to calling SecurityControl.enableSecurity.

AUTHENTICATION_SETUP_REQUIRED

AUTHENTICATION_SETUP_REQUIRED

The runtime has been initialized with application authentication enabled. To control access to secure storage a new application password must be set by calling setPassword.

AUTHENTICATION_REQUIRED

AUTHENTICATION_REQUIRED

A valid application password is required to enable access to the runtime's programmatic interfaces and secure storage. Use enterPassword.

REGISTRATION

REGISTRATION

The runtime needs to be registered with BlackBerry by supplying an identity token belonging to the user. See SecurityControl.provideToken.

TOKENVALIDATION

TOKENVALIDATION

The token provided using SecurityControl.provideToken is currently being validated by BlackBerry Identity.

ACTIVE

ACTIVE

The security library is active and detecting threats. The runtime is registered with BlackBerry and able to retrieve the latest threat models.

TOKENEXPIRED

TOKENEXPIRED

A valid token is required to return the library to an active state.