org.openmrs.api
Class APIAuthenticationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.openmrs.api.APIException
                  extended by org.openmrs.api.APIAuthenticationException
All Implemented Interfaces:
java.io.Serializable

public class APIAuthenticationException
extends APIException

Represents often fatal errors that occur within the API infrastructure involving a user's lack of privileges. In certain presentation environments, this exception is caught and the user is redirected to the login page where they can provide new or higher credentials.

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Constructor Summary
APIAuthenticationException()
          Default empty constructor.
APIAuthenticationException(java.lang.String message)
          Common constructor taking in a message to give the user some context as to where/why the authentication failed.
APIAuthenticationException(java.lang.String message, java.lang.Throwable cause)
          Common constructor taking in a message to give the user some context as to where/why the authentication failed.
APIAuthenticationException(java.lang.Throwable cause)
          Constructor giving the user a further cause exception reason that caused this authentication failure
 
Method Summary
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

APIAuthenticationException

public APIAuthenticationException()
Default empty constructor. It is more common to use the APIAuthenticationException(String) constructor to provide some context to the user as to where/why the authentication has failed


APIAuthenticationException

public APIAuthenticationException(java.lang.String message)
Common constructor taking in a message to give the user some context as to where/why the authentication failed.

Parameters:
message - String describing where/why the authentication failed

APIAuthenticationException

public APIAuthenticationException(java.lang.String message,
                                  java.lang.Throwable cause)
Common constructor taking in a message to give the user some context as to where/why the authentication failed.

Parameters:
message - String describing where/why the authentication failed
cause - error further up the stream that caused this authentication failure

APIAuthenticationException

public APIAuthenticationException(java.lang.Throwable cause)
Constructor giving the user a further cause exception reason that caused this authentication failure

Parameters:
cause - error further up the stream that caused this authentication failure

OpenMRS-1.7.x

Generated Apr 27 2012 10:06 PM. NOTE - these libraries are in active development and subject to change