com.iizix.server.user

Class UserException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.iizix.server.user.UserException

All Implemented Interfaces:

Serializable

public class UserException
extends Exception

User exception class used when a user is not permitted an action.

Author:

Christopher Mindus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserException(UserIdentifier userIdentifier, LoginResult authenticationResult) Creates a user exception with an empty detail message.
UserException(UserIdentifier userIdentifier, String message) Creates a user exception with a message.
UserException(UserIdentifier userIdentifier, String message, Throwable exception) Creates a user exception with a message and an exception cause.

Method Summary

Modifier and Type	Method and Description
LoginResult	getAuthenticationResult() Gets the authentication result causing the exception.
UserIdentifier	getUserIdentifier() Gets the User Identifier.

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

UserException

public UserException(UserIdentifier userIdentifier,
                     LoginResult authenticationResult)

Creates a user exception with an empty detail message.

Parameters:

userIdentifier - The user identifier.

authenticationResult - The authentication result causing the error.

Throws:

NullPointerException - if userIdentifier parameter is null.

UserException

public UserException(UserIdentifier userIdentifier,
                     String message)

Creates a user exception with a message.

Parameters:

userIdentifier - The user identifier.

message - the detail message.

Throws:

NullPointerException - if userIdentifier parameter is null.

UserException

public UserException(UserIdentifier userIdentifier,
                     String message,
                     Throwable exception)

Creates a user exception with a message and an exception cause.

Parameters:

userIdentifier - The user identifier.

message - the detail message.

exception - the exception, i.e. the real cause.

Throws:

NullPointerException - if userIdentifier parameter is null.

Method Detail

getUserIdentifier

public UserIdentifier getUserIdentifier()

Gets the User Identifier.

getAuthenticationResult

public LoginResult getAuthenticationResult()

Gets the authentication result causing the exception.

Returns:

The authentication result that caused the error, null if a nested exception caused it (use @{link Throwable.getCause() to retrieve it).