net.rim.device.api.userauthenticator
Class UserAuthenticatorManager

java.lang.Object
  net.rim.device.api.userauthenticator.UserAuthenticatorManager

public final class UserAuthenticatorManager
extends Object

System-wide singleton manager to handle user authenticators loaded on the device.

See Also:

UserAuthenticator

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Method Summary
	int	getAuthenticatorType() Retrieve the type of the currently active user authenticator.
	static UserAuthenticatorManager	getInstance() Retrieve reference to the singleton user authenticator manager.
	void	initiateLockSequence() Start the device lock sequence.
	void	initiateUnlockSequence() Start a device unlock sequence.
	boolean	isUserAuthenticatorEnabled() Determine if a user authenticator is currently enabled.
	boolean	registerUserAuthenticator(UserAuthenticator authenticator) Register a user authenticator with this manager.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static UserAuthenticatorManager getInstance()

Retrieve reference to the singleton user authenticator manager.

The calling process must be entitled to the User Authenticator application control permission.

Returns:

User authenticator manager.

Throws:

ControlledAccessException - if the application does not have sufficient permission to perform this operation

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

isUserAuthenticatorEnabled

public boolean isUserAuthenticatorEnabled()

Determine if a user authenticator is currently enabled.

Returns:

True if this manager currently has an active user authenticator; otherwise, false.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

getAuthenticatorType

public int getAuthenticatorType()

Retrieve the type of the currently active user authenticator.

Returns:

Mask of the authentication mechanism values supported by the currently active user authenticator, or 0, if this manager has no currently active authenticator.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

registerUserAuthenticator

public boolean registerUserAuthenticator(UserAuthenticator authenticator)

Register a user authenticator with this manager.

Use this method to register your user authenticator with the user authenticator framework. Once registered, the authenticator can be activated and initialized.

The calling process must be entitled to the User Authenticator application control permission.

Parameters:

authenticator - User authenticator you want to register with the framework.

Returns:

True if the framework successfully registers the user authenticator; otherwise, false.

Throws:

ControlledAccessException - if the application does not have sufficient permission to perform this operation

IllegalArgumentException - if called with an authenticator that is already registered or if called with a null authenticator

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

initiateUnlockSequence

public void initiateUnlockSequence()

Start a device unlock sequence.

The user will have to authenticate with the device (via device password and/or authentication credentials) in order to unlock the system.

The calling process must be entitled to the User Authenticator application control permission.

Note: this manager must have a currently active user authenticator before the unlock sequence can be started.

Throws:

ControlledAccessException - if the application does not have sufficient permission to perform this operation.

IllegalStateException - if the method is called before system startup completes.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

initiateLockSequence

public void initiateLockSequence()

Start the device lock sequence.

The calling process must be entitled to the User Authenticator and Device settings application control permission.

Throws:

ControlledAccessException - if the application does not have sufficient permission to perform this operation.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0