Package org.ametys.plugins.core.user

Class UserManagementException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.ametys.plugins.core.user.UserManagementException

All Implemented Interfaces:

Serializable

public class UserManagementException
extends Exception

An exception describing an error that occurred during the process of a user management operation

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATABASE_ERROR	Error when a request to database failed
static final String	EMPTY_EMAIL	Error when user has no email
static final String	INVALID_MODIFICATION	Error user inputs are invalid
static final String	MAIL_ERROR	Error when failed to send email
static final String	NOT_UNIQUE_USER	Error when information provided match several users
static final String	PASSWORD_CHANGE_DISABLED	Error when password change is disabled for the population
static final String	POPULATION_UNKNOWN	Error when id of population provided does not match any user population
static final String	TOKEN_UNKNOWN	Error when the token provided by user does not exists
static final String	UNMODIFIABLE_USER_DIRECTORY	Error when the user directory is unmodifiable
static final String	USER_UNKNOWN	Error when login or email provided does not match any user

Constructor Summary

Constructors

Constructor	Description
UserManagementException(String status, String message)	Build a new exception.
UserManagementException(String status, String message, Throwable e)	Wrap a Throwable in a user management exception status of the exception should be described using a constant from UserManagementException

Method Summary

Modifier and Type	Method	Description
String	getStatus()	Get the reasons that lead to this exception.

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

Field Details

MAIL_ERROR

public static final String MAIL_ERROR

Error when failed to send email

See Also:

• Constant Field Values

USER_UNKNOWN

public static final String USER_UNKNOWN

Error when login or email provided does not match any user

See Also:

• Constant Field Values

POPULATION_UNKNOWN

public static final String POPULATION_UNKNOWN

Error when id of population provided does not match any user population

See Also:

• Constant Field Values

NOT_UNIQUE_USER

public static final String NOT_UNIQUE_USER

Error when information provided match several users

See Also:

• Constant Field Values

EMPTY_EMAIL

public static final String EMPTY_EMAIL

Error when user has no email

See Also:

• Constant Field Values

UNMODIFIABLE_USER_DIRECTORY

public static final String UNMODIFIABLE_USER_DIRECTORY

Error when the user directory is unmodifiable

See Also:

• Constant Field Values

TOKEN_UNKNOWN

public static final String TOKEN_UNKNOWN

Error when the token provided by user does not exists

See Also:

• Constant Field Values

INVALID_MODIFICATION

public static final String INVALID_MODIFICATION

Error user inputs are invalid

See Also:

• Constant Field Values

DATABASE_ERROR

public static final String DATABASE_ERROR

Error when a request to database failed

See Also:

• Constant Field Values

PASSWORD_CHANGE_DISABLED

public static final String PASSWORD_CHANGE_DISABLED

Error when password change is disabled for the population

See Also:

• Constant Field Values

Constructor Details

UserManagementException

public UserManagementException(String status,
 String message)

Build a new exception. status of the exception should be described using a constant from UserManagementException

Parameters:

status - the cause that lead to the exception.

message - an informative message

UserManagementException

public UserManagementException(String status,
 String message,
 Throwable e)

Wrap a Throwable in a user management exception status of the exception should be described using a constant from UserManagementException

Parameters:

status - the cause that lead to the exception.

message - an informative message

e - the original exception

Method Details

getStatus

public String getStatus()

Get the reasons that lead to this exception. This value should always be one of the constant from UserManagementException

Returns:

the status