net.rim.device.api.userauthenticator
Class UserAuthenticationAccessDeniedException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          net.rim.device.api.userauthenticator.UserAuthenticationException
              net.rim.device.api.userauthenticator.UserAuthenticationAccessDeniedException

public class UserAuthenticationAccessDeniedException
extends UserAuthenticationException

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).

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

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

ACTION_SHOW_UI

public static final int ACTION_SHOW_UI

Show a message to the user to confirm that the authenticator has denied access.

This is the default action.

See Also:

Constant Field Values

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

ACTION_NONE

public static final int ACTION_NONE

Show no indication to the user that the authenticator has denied access.

This action should be provided if the authenticator has already notified the user of the denial in some manner.

See Also:

Constant Field Values

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

Constructor Detail

UserAuthenticationAccessDeniedException

public UserAuthenticationAccessDeniedException()

Construct a user authentication denied access exception.

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").

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

UserAuthenticationAccessDeniedException

public UserAuthenticationAccessDeniedException(String message,
                                               int suggestedAction)

Construct a user authentication denied access exception with a descriptive message and a suggested action.

Using this constructor causes the security framework that catches this exception to take the suggested action.

• If the suggested action is UserAuthenticationAccessDeniedException.ACTION_SHOW_UI, then the security framework will present the provided descriptive message to the user.
• If the suggested action is UserAuthenticationAccessDeniedException.ACTION_NONE, then the security framework will not show any UI, because it presumes that the user authenticator has already alerted the user.

Parameters:

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.

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 Detail

getSuggestedAction

public int getSuggestedAction()

Retrieve this exception's suggested action.

Returns:

One of the ACTION static member values defined in this interface.

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