All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.anaptecs.jeaf.services.usermanagement.UserManagementMessages Maven / Gradle / Ivy

There is a newer version: 1.8.0
Show newest version
package com.anaptecs.jeaf.services.usermanagement;

import com.anaptecs.jeaf.xfun.annotations.MessageResource;
import com.anaptecs.jeaf.xfun.api.XFun;
import com.anaptecs.jeaf.xfun.api.errorhandling.ErrorCode;
import com.anaptecs.jeaf.xfun.api.messages.LocalizedString;
import com.anaptecs.jeaf.xfun.api.messages.MessageID;
import com.anaptecs.jeaf.xfun.api.messages.MessageRepository;

/**
 * Class for error codes for JEAF User Management Service
 *
 * @author JEAF Development Team
 * @version 1.0
 */
@MessageResource(path = "UserManagementMessages.xml")
public final class UserManagementMessages {
  /**
   * Constant for XML file that contains all messages that are defined within this class.
   */
  private static final String MESSAGE_RESOURCE = "UserManagementMessages.xml";

  /**
   * Error code is used to indicate that an encryption algorithm is not supported.
   */
  public static final ErrorCode NO_SUCH_ALGORITHM_ERROR;

  /**
   * Error code is used to indicate that an encoding isn't possible.
   */
  public static final ErrorCode UNSUPPORTED_ENCODING_ERROR;

  /**
   * Error code is used to indicate that the login failed because the password is invalid.
   */
  public static final ErrorCode INVALID_PASSWORD;

  /**
   * Error code is used to indicate that the assignment failed because the authorization is invalid.
   */
  public static final ErrorCode INVALID_AUTHORIZATION;

  /**
   * Error code is used to indicate that the assignment failed because the userAccount is invalid.
   */
  public static final ErrorCode INVALID_USERACCOUNT;

  /**
   * Error code is used to indicate that the assignment failed because the RoleAssociation is invalid.
   */
  public static final ErrorCode INVALID_ROLEASSOCIATION;

  /**
   * Error code is used to indicate that the login failed because the password is expired.
   */
  public static final ErrorCode PASSWORD_EXPIRED;

  /**
   * Error code is used to indicate that the login failed because the UserAccount has been locked.
   */
  public static final ErrorCode ACCOUNT_LOCKED;

  /**
   * Error code is used to indicate that the login failed because the UserAccount is expired.
   */
  public static final ErrorCode ACCOUNT_EXPIRED;

  /**
   * Error code is used to indicate that the login failed because the UserAccoutn does not exist.
   */
  public static final ErrorCode ACCOUNT_DOES_NOT_EXIST;

  /**
   * Error code is used to indicate that the search got more than one result but the Object is unique.
   */
  public static final ErrorCode OBJECT_NOT_UNIQUE;

  /**
   * Error code is used to indicate that the object already exists on the database.
   */
  public static final ErrorCode OBJECT_ALREADY_EXISTS;

  /**
   * Error code is used to indicate that the JEAFLoginModule is used in a not supported runtime environment.
   */
  public static final ErrorCode UNSUPPORTED_RUNTIME;

  /**
   * Information about which AuthorizationType was imported.
   */
  public static final MessageID IMPORTED_AUTHORIZATIONTYPES;

  /**
   * Information about which RoleDefinition was imported.
   */
  public static final MessageID IMPORTED_ROLEDEFINITIONS;

  /**
   * Information about which AuthorizationType was skipped.
   */
  public static final MessageID SKIPPED_AUTHORIZATIONTYPES;

  /**
   * Information about which RoleDefinition was skipped.
   */
  public static final MessageID SKIPPED_ROLEDEFINITIONS;

  /**
   * Information about which Person was imported.
   */
  public static final MessageID IMPORTED_PERSONS;

  /**
   * Information about which UserAccount was imported.
   */
  public static final MessageID IMPORTED_USERACCOUNTS;

  /**
   * Information about which UserAccount was updated
   */
  public static final MessageID UPDATED_USERACCOUNTS;

  /**
   * Error code is used to indicate that the activation failed because the UserAccoutn is already activated.
   */
  public static final ErrorCode ACCOUNT_ALREADY_ACTIVATED;

  /**
   * Error code is used to indicate that the login failed because an incorrect token was used for activation.
   */
  public static final ErrorCode WRONG_ACTIVATION_TOKEN;

  /**
   * Error code is used to indicate that the search for an address type failed.
   */
  public static final ErrorCode ADDRESS_TYPE_NOT_FOUND;

  /**
   * Error code is used to indicate that the search for a role definition failed.
   */
  public static final ErrorCode ROLE_DEFINITION_NOT_FOUND;

  /**
   * Error code is used to indicate that the address subtype is no address subtype of the address type.
   */
  public static final ErrorCode INVALID_ADDRESS_SUBTYPE;

  /**
   * Error code is used to indicate that the state is no state of the country.
   */
  public static final ErrorCode INVALID_STATE;

  /**
   * Error code is used to indicate that the password doesn't macth a certain pattern.
   */
  public static final ErrorCode INVALID_PASSWORD_PATTERN;

  /**
   * Error code is used to indicate that a user account can not be created as the login name is already in use.
   */
  public static final ErrorCode ACCOUNT_ALREADY_EXISTS;

  /**
   * 
   */
  public static final ErrorCode EMAIL_ADDRESS_ALREADY_EXISTS;

  /**
   * Error code is used to indicate that the update of the linked person failed because an incorrect token was used for
   * the update.
   */
  public static final ErrorCode WRONG_LINK_STATUS_TOKEN;

  /**
   * Messages with this message id are traced when a new instance of a JEAF Login Module is created.
   */
  public static final MessageID SECURITY_DOMAIN;

  /**
   * Messages with this message id are traced a user tries to login.
   */
  public static final MessageID TRYING_LOGIN;

  /**
   * Messages with this message id are traced if the login of user was successful.
   */
  public static final MessageID LOGIN_SUCCESSFUL;

  /**
   * Messages with this message id are traced if the login of user a anonymous user was successful.
   */
  public static final MessageID ANONYMOUS_LOGIN;

  /**
   * Messages with this message id are traced if the login of user a anonymous user was successful.
   */
  public static final MessageID COMMIT_SUCCESSFUL;

  /**
   * Messages with this message id are traced if if the workaround for a principal propagation bug in JBoss is enabled.
   */
  public static final MessageID PRINCIPAL_PROPAGATION_WORKAROUND_MESSAGE;

  /**
   * Exceptions with this error code are thrown if the workaround for a principal propagation bug in JBoss is not
   * working due to a wrong configuration of the application server.
   */
  public static final ErrorCode NO_JEAF_USER_PRINCIPAL_FOUND;

  /**
   * Exceptions with this error code are thrown if the wrong principal provider implementation is used in combination
   * with JSE Login Module.
   */
  public static final ErrorCode WRONG_PRINCIPAL_PROVIDER;

  /**
   * Messages with this message id are traced when JEAF's Login Module reloads a user principal.
   */
  public static final MessageID RELOADING_PRINCIPAL;

  /**
   * Messages with this error code occur if problem was deteced during migration.
   */
  public static final ErrorCode MIGRATION_ISSUE;

  /**
   * Exceptions with this error code are thrown if a the current principal is not of type JEAFUserPrincipal.
   */
  public static final ErrorCode WRONG_PRINCIPAL_IMPL;

  /**
   * Exceptions with this error code are thrown if the check for an specific authorization fails.
   */
  public static final ErrorCode INSUFFICENT_AUTHORIZATION;

  /**
   * Messages with this message id are traced right before the the check for an authorization of a specific user is
   * performed.
   */
  public static final MessageID ENFORCING_AUTHORIZATION;

  /**
   * Exceptions with this error code are thrown if character encoding is not supported.
   */
  public static final ErrorCode UNABLE_TO_SEND_MAIL;

  /**
   * Error code is used to indicate that no login name was set.
   */
  public static final ErrorCode NO_LOGIN_NAME;

  /**
   * Error code is used to indicate that the search for an address type failed.
   */
  public static final ErrorCode ORGANIZATION_UNIT_TYPE_NOT_FOUND;

  /**
   * Constant for mail notification
   */
  public static final LocalizedString PASSWORD_MAIL_CONTENT_INVALID_ACCOUNT;

  /**
   * Error code is used to indicate that the resetting of the password failed due to a locked user account.
   */
  public static final ErrorCode RESET_PASSWORD_LOCKED_USER_ACCOUNT;

  /**
   * Exceptions with this error code are thrown if during the load process of a authorization import resource an
   * exception occurs.
   */
  public static final ErrorCode UNABLE_TO_LOAD_AUTHORIZATION_RESOURCE;

  /**
   * Exceptions with this error code are thrown if during the load process of a userAccount resource an exception
   * occurs.
   */
  public static final ErrorCode UNABLE_TO_PARSE_DATE_STRING;

  /**
   * Exceptions with this error code are thrown if during the load process of a userAccount a person is missing.
   */
  public static final ErrorCode UNABLE_TO_CREATE_USER_ACCOUNT;

  /**
   * Exceptions with this error code are thrown if during the load process of a userAccount a RoleDefinition could not
   * be found on the Database.
   */
  public static final ErrorCode ROLEDEFINITION_DOES_NOT_EXIST;
  /**
   * Static initializer contains initialization for all generated constants.
   */
  static {
    MessageRepository lRepository = XFun.getMessageRepository();
    lRepository.loadResource(MESSAGE_RESOURCE);
    // Handle all info messages.
    IMPORTED_AUTHORIZATIONTYPES = lRepository.getMessageID(4213);
    IMPORTED_ROLEDEFINITIONS = lRepository.getMessageID(4214);
    SKIPPED_AUTHORIZATIONTYPES = lRepository.getMessageID(4215);
    SKIPPED_ROLEDEFINITIONS = lRepository.getMessageID(4216);
    IMPORTED_PERSONS = lRepository.getMessageID(4217);
    IMPORTED_USERACCOUNTS = lRepository.getMessageID(4218);
    UPDATED_USERACCOUNTS = lRepository.getMessageID(4219);
    SECURITY_DOMAIN = lRepository.getMessageID(4230);
    TRYING_LOGIN = lRepository.getMessageID(4231);
    LOGIN_SUCCESSFUL = lRepository.getMessageID(4232);
    ANONYMOUS_LOGIN = lRepository.getMessageID(4233);
    COMMIT_SUCCESSFUL = lRepository.getMessageID(4234);
    PRINCIPAL_PROPAGATION_WORKAROUND_MESSAGE = lRepository.getMessageID(4235);
    RELOADING_PRINCIPAL = lRepository.getMessageID(4238);
    ENFORCING_AUTHORIZATION = lRepository.getMessageID(4242);
    // Handle all messages for errors.
    NO_SUCH_ALGORITHM_ERROR = lRepository.getErrorCode(4200);
    UNSUPPORTED_ENCODING_ERROR = lRepository.getErrorCode(4201);
    INVALID_PASSWORD = lRepository.getErrorCode(4202);
    INVALID_AUTHORIZATION = lRepository.getErrorCode(4203);
    INVALID_USERACCOUNT = lRepository.getErrorCode(4204);
    INVALID_ROLEASSOCIATION = lRepository.getErrorCode(4205);
    PASSWORD_EXPIRED = lRepository.getErrorCode(4206);
    ACCOUNT_LOCKED = lRepository.getErrorCode(4207);
    ACCOUNT_EXPIRED = lRepository.getErrorCode(4208);
    ACCOUNT_DOES_NOT_EXIST = lRepository.getErrorCode(4209);
    OBJECT_NOT_UNIQUE = lRepository.getErrorCode(4210);
    OBJECT_ALREADY_EXISTS = lRepository.getErrorCode(4211);
    UNSUPPORTED_RUNTIME = lRepository.getErrorCode(4212);
    ACCOUNT_ALREADY_ACTIVATED = lRepository.getErrorCode(4220);
    WRONG_ACTIVATION_TOKEN = lRepository.getErrorCode(4221);
    ADDRESS_TYPE_NOT_FOUND = lRepository.getErrorCode(4222);
    ROLE_DEFINITION_NOT_FOUND = lRepository.getErrorCode(4223);
    INVALID_ADDRESS_SUBTYPE = lRepository.getErrorCode(4224);
    INVALID_STATE = lRepository.getErrorCode(4225);
    INVALID_PASSWORD_PATTERN = lRepository.getErrorCode(4226);
    ACCOUNT_ALREADY_EXISTS = lRepository.getErrorCode(4227);
    EMAIL_ADDRESS_ALREADY_EXISTS = lRepository.getErrorCode(4228);
    WRONG_LINK_STATUS_TOKEN = lRepository.getErrorCode(4229);
    NO_JEAF_USER_PRINCIPAL_FOUND = lRepository.getErrorCode(4236);
    WRONG_PRINCIPAL_PROVIDER = lRepository.getErrorCode(4237);
    MIGRATION_ISSUE = lRepository.getErrorCode(4239);
    WRONG_PRINCIPAL_IMPL = lRepository.getErrorCode(4240);
    INSUFFICENT_AUTHORIZATION = lRepository.getErrorCode(4241);
    UNABLE_TO_SEND_MAIL = lRepository.getErrorCode(4243);
    NO_LOGIN_NAME = lRepository.getErrorCode(4244);
    ORGANIZATION_UNIT_TYPE_NOT_FOUND = lRepository.getErrorCode(4245);
    RESET_PASSWORD_LOCKED_USER_ACCOUNT = lRepository.getErrorCode(4247);
    UNABLE_TO_LOAD_AUTHORIZATION_RESOURCE = lRepository.getErrorCode(4248);
    UNABLE_TO_PARSE_DATE_STRING = lRepository.getErrorCode(4249);
    UNABLE_TO_CREATE_USER_ACCOUNT = lRepository.getErrorCode(4250);
    ROLEDEFINITION_DOES_NOT_EXIST = lRepository.getErrorCode(4251);
    // Handle all localized strings.
    PASSWORD_MAIL_CONTENT_INVALID_ACCOUNT = lRepository.getLocalizedString(4246);
  }

  /**
   * Constructor is private to ensure that no instances of this class will be created.
   */
  private UserManagementMessages( ) {
    // Nothing to do.
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy