wamblee.org Git - utils/blob - security/src/main/java/org/wamblee/usermgt/UserMgtException.java

   1 /*
   2  * Copyright 2005 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.wamblee.usermgt;
  18
  19 import java.util.EnumMap;
  20
  21 /**
  22  * User management exception.
  23  *
  24  * @author Erik Brakkee
  25  */
  26 public class UserMgtException extends Exception {
  27
  28     static final long serialVersionUID = 5585349754997507529L;
  29
  30     /**
  31      * Possible causes for the exception.
  32      *
  33      */
  34     public enum Reason {
  35         UNKNOWN_USER,
  36         UNKNOWN_GROUP,
  37         DUPLICATE_USER,
  38         DUPLICATE_GROUP,
  39         USER_ALREADY_IN_GROUP,
  40         USER_NOT_IN_GROUP,
  41         TRIVIAL_RENAME,
  42         INVALID_PASSWORD,
  43         GROUP_STILL_OCCUPIED,
  44         USER_MUST_BE_IN_A_GROUP,
  45         INVALID_USERNAME,
  46         INVALID_GROUPNAME
  47     }
  48
  49     /**
  50      * Mapping of enum to exception message text.
  51      */
  52     private static final EnumMap<Reason,String> MESSAGES = new EnumMap<Reason,String>(Reason.class);
  53
  54     static {
  55         MESSAGES.put(Reason.UNKNOWN_USER, "Unknown user");
  56         MESSAGES.put(Reason.UNKNOWN_GROUP, "Unknown group");
  57         MESSAGES.put(Reason.DUPLICATE_USER, "Duplicate user");
  58         MESSAGES.put(Reason.DUPLICATE_GROUP, "Duplicate group");
  59         MESSAGES.put(Reason.USER_ALREADY_IN_GROUP, "User already in group");
  60         MESSAGES.put(Reason.USER_NOT_IN_GROUP, "User not in group");
  61         MESSAGES.put(Reason.TRIVIAL_RENAME, "Trivial rename");
  62         MESSAGES.put(Reason.INVALID_PASSWORD, "Invalid password");
  63         MESSAGES.put(Reason.GROUP_STILL_OCCUPIED, "Group still occupied");
  64         MESSAGES.put(Reason.USER_MUST_BE_IN_A_GROUP, "User must be in at least one group");
  65         MESSAGES.put(Reason.INVALID_USERNAME, "Invalid user name");
  66         MESSAGES.put(Reason.INVALID_GROUPNAME, "Invalid group name");
  67     }
  68
  69     /**
  70      * Cause of the exception.
  71      */
  72     private Reason cause;
  73
  74     /**
  75      * User or null if no user is relevant for the problem.
  76      */
  77     private User user;
  78
  79     /**
  80      * Group or null if no group is relevant for the problem.
  81      */
  82     private Group group;
  83
  84     public UserMgtException(Reason aCause, String aMessage) {
  85         super(MESSAGES.get(aCause) + ": " + aMessage);
  86         cause = aCause;
  87     }
  88
  89     public UserMgtException(Reason aCause, User aUser) {
  90         this(aCause, "for user '" + aUser.getName() + "'");
  91         user = aUser;
  92     }
  93
  94     public UserMgtException(Reason aCause, Group aGroup) {
  95         this(aCause, "for group '" + aGroup.getName() + "'");
  96         group = aGroup;
  97     }
  98
  99     public UserMgtException(Reason aCause, User aUser, Group aGroup) {
 100         this(aCause, "for user '" + aUser.getName() + "' and group '" + aGroup.getName() + "'");
 101         user = aUser;
 102         group = aGroup;
 103     }
 104
 105     /**
 106      * Gets the cause of the problem.
 107      * @return Cause.
 108      */
 109     public Reason getReason() {
 110         return cause;
 111     }
 112
 113     /**
 114      * Gets the user for which the problem occurred.
 115      * @return User or null if not applicable.
 116      */
 117     public User getUser() {
 118         return user;
 119     }
 120
 121     /**
 122      * Gets the group for which the problem occured.
 123      * @return Group or null if not applicable.
 124      */
 125     public Group getGroup() {
 126         return group;
 127     }
 128 }