er.rest

Class ERXBasicAuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.SecurityException

er.rest.ERXBasicAuthenticationException

All Implemented Interfaces:

Serializable

public class ERXBasicAuthenticationException
extends SecurityException

The ERXBasicAuthenticationException can be thrown when performing an action containing invalid credentials.

Usage:

 protected void checkAccess() throws SecurityException {
     if (invalidCredentials) {
         throw new ERXBasicAuthenticationException("Invalid credentials");
     }
 }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ERXBasicAuthenticationException(String message) Creates a ERXBasicAuthenticationException with the specified detail message and the default realm.
ERXBasicAuthenticationException(String message, String realm) Creates a ERXBasicAuthenticationException with the specified detail message and realm.
ERXBasicAuthenticationException(String message, Throwable cause) Creates a ERXBasicAuthenticationException with the specified detail message and cause using the default realm.
ERXBasicAuthenticationException(String message, Throwable cause, String realm) Creates a ERXBasicAuthenticationException with the specified detail message, cause and realm.

Method Summary

Modifier and Type	Method and Description
String	realm() The realm for which the credentials are used.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ERXBasicAuthenticationException

public ERXBasicAuthenticationException(String message)

Creates a ERXBasicAuthenticationException with the specified detail message and the default realm.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

ERXBasicAuthenticationException

public ERXBasicAuthenticationException(String message,
                                       String realm)

Creates a ERXBasicAuthenticationException with the specified detail message and realm.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

realm - the realm for which the credentials are used

ERXBasicAuthenticationException

public ERXBasicAuthenticationException(String message,
                                       Throwable cause)

Creates a ERXBasicAuthenticationException with the specified detail message and cause using the default realm.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

ERXBasicAuthenticationException

public ERXBasicAuthenticationException(String message,
                                       Throwable cause,
                                       String realm)

Creates a ERXBasicAuthenticationException with the specified detail message, cause and realm.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

realm - the realm for which the credentials are used

Method Detail

realm

public String realm()

The realm for which the credentials are used.

Returns:

Returns the realm representation.