org.melati.poem
Class AccessPoemException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.melati.poem.PoemException
                  org.melati.poem.AccessPoemException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AccessibleCreationException, ColumnRenamePoemException, CreationAccessPoemException, PersistentAccessPoemException, TableRenamePoemException

public class AccessPoemException
extends PoemException

Thrown when an authorisation problem occurs, that is when a User does not have the required Capability or is not in a Group with the required Capability to access a restricted object.

See Also:

Serialized Form

Field Summary

Capability	capability The required Capability.
AccessToken	token The User's Token.

Fields inherited from class org.melati.poem.PoemException

subException

Constructor Summary

AccessPoemException()
Constructor.

AccessPoemException(AccessPoemException e)
Constructor.

AccessPoemException(AccessToken token, Capability capability)
Constructor.

AccessPoemException(Exception problem, AccessToken token, Capability capability)
Constructor.

Method Summary

String	getActionDescription()
String	getMessage() The detail message which may be null.
AccessToken	getToken()

Methods inherited from class org.melati.poem.PoemException

getCoreMessage, initCause, innermostException, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

token

public AccessToken token

The User's Token.

capability

public Capability capability

The required Capability.

Constructor Detail

AccessPoemException

public AccessPoemException(Exception problem,
                           AccessToken token,
                           Capability capability)

Constructor.

AccessPoemException

public AccessPoemException(AccessToken token,
                           Capability capability)

Constructor.

AccessPoemException

public AccessPoemException(AccessPoemException e)

Constructor.

AccessPoemException

public AccessPoemException()

Constructor.

Method Detail

getActionDescription

public String getActionDescription()

Returns:

null

getMessage

public String getMessage()

Description copied from class: PoemException

The detail message which may be null.

Overrides:

getMessage in class PoemException

Returns:

The detail message

See Also:

Throwable.getMessage()

getToken

public AccessToken getToken()

Returns:

the AccessToken