|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
net.rim.device.api.userauthenticator.UserAuthenticationException
net.rim.device.api.userauthenticator.UserAuthenticationAccessDeniedException
public class UserAuthenticationAccessDeniedException
Thrown when the user is unable to authenticate with a user authenticator.
This exception can cover cases of a failure to authenticate because improper credentials have been provided (incorrect password, non-matching biometrics).
Field Summary | ||
---|---|---|
|
static int |
ACTION_NONE
Show no indication to the user that the authenticator has denied access. |
|
static int |
ACTION_SHOW_UI
Show a message to the user to confirm that the authenticator has denied access. |
Constructor Summary | ||
---|---|---|
|
UserAuthenticationAccessDeniedException()
Construct a user authentication denied access exception. |
|
|
UserAuthenticationAccessDeniedException(String message,
int suggestedAction)
Construct a user authentication denied access exception with a descriptive message and a suggested action. |
Method Summary | ||
---|---|---|
|
int |
getSuggestedAction()
Retrieve this exception's suggested action. |
Methods inherited from class java.lang.Throwable |
---|
getMessage, printStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int ACTION_SHOW_UI
This is the default action.
public static final int ACTION_NONE
This action should be provided if the authenticator has already notified the user of the denial in some manner.
Constructor Detail |
---|
public UserAuthenticationAccessDeniedException()
This, default, constructor invokes
UserAuthenticationAccessDeniedException.UserAuthenticationAccessDeniedException(String,int)
providing null for the message, and UserAuthenticationAccessDeniedException.ACTION_SHOW_UI
for the
action. As a result, this constructor will show a default message to the
user (an appropriately localized version of "Incorrect Password").
public UserAuthenticationAccessDeniedException(String message, int suggestedAction)
Using this constructor causes the security framework that catches this exception to take the suggested action.
UserAuthenticationAccessDeniedException.ACTION_SHOW_UI
, then the
security framework will present the provided descriptive message to the
user.
UserAuthenticationAccessDeniedException.ACTION_NONE
, then the security
framework will not show any UI, because it presumes that the user
authenticator has already alerted the user.
message
- Message to describe why the user's authentication attempt
has been denied; examples may include "Incorrect Password" or "Your
proximity token is not within range of your BlackBerry". If you provide
null, and the message must be shown to the user, then a default phrase
will be used (see UserAuthenticationAccessDeniedException.ACTION_SHOW_UI
).suggestedAction
- Action that the catcher of this exception should
take; one of the ACTION static members defined in this interface.Method Detail |
---|
public int getSuggestedAction()
|
|||||||||
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.