|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.userauthenticator.UserAuthenticatorManager
public final class UserAuthenticatorManager
System-wide singleton manager to handle user authenticators loaded on the device.
UserAuthenticator
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 |
---|
public static UserAuthenticatorManager getInstance()
The calling process must be entitled to the User Authenticator application control permission.
ControlledAccessException
- if the application does not have sufficient permission to perform this operationpublic boolean isUserAuthenticatorEnabled()
public int getAuthenticatorType()
public boolean registerUserAuthenticator(UserAuthenticator authenticator)
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.
authenticator
- User authenticator you want to register with the
framework.
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
authenticatorpublic void initiateUnlockSequence()
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.
ControlledAccessException
- if the application does not have
sufficient permission to perform this operation.
IllegalStateException
- if the method is called before system
startup completes.public void initiateLockSequence()
The calling process must be entitled to the User Authenticator and Device settings application control permission.
ControlledAccessException
- if the application does not have
sufficient permission to perform this operation.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.