(no commit message)
[utils] / security / usermgt / src / main / java / org / wamblee / security / authentication / UserMgtException.java
1 /*
2  * Copyright 2005-2010 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 package org.wamblee.security.authentication;
17
18 import java.util.EnumMap;
19
20 /**
21  * User management exception.
22  * 
23  * @author Erik Brakkee
24  */
25 public class UserMgtException extends RuntimeException {
26     static final long serialVersionUID = 5585349754997507529L;
27
28     /**
29      * Mapping of enum to exception message text.
30      */
31     private static final EnumMap<Reason, String> MESSAGES = new EnumMap<Reason, String>(
32         Reason.class);
33
34     static {
35         MESSAGES.put(Reason.UNKNOWN_USER, "Unknown user");
36         MESSAGES.put(Reason.UNKNOWN_GROUP, "Unknown group");
37         MESSAGES.put(Reason.DUPLICATE_USER, "Duplicate user");
38         MESSAGES.put(Reason.DUPLICATE_GROUP, "Duplicate group");
39         MESSAGES.put(Reason.USER_ALREADY_IN_GROUP, "User already in group");
40         MESSAGES.put(Reason.USER_NOT_IN_GROUP, "User not in group");
41         MESSAGES.put(Reason.INVALID_PASSWORD, "Invalid password");
42         MESSAGES.put(Reason.GROUP_STILL_OCCUPIED, "Group still occupied");
43         MESSAGES.put(Reason.USER_MUST_BE_IN_A_GROUP,
44             "User must be in at least one group");
45         MESSAGES.put(Reason.INVALID_USERNAME, "Invalid user name");
46         MESSAGES.put(Reason.INVALID_GROUPNAME, "Invalid group name");
47     }
48
49     /**
50      * Cause of the exception.
51      */
52     private Reason cause;
53
54     /**
55      * User or null if no user is relevant for the problem.
56      */
57     private User user;
58
59     /**
60      * Group or null if no group is relevant for the problem.
61      */
62     private Group group;
63
64     /**
65      * Creates a new UserMgtException object.
66      * 
67      */
68     public UserMgtException(Reason aCause, String aMessage) {
69         super(MESSAGES.get(aCause) + ": " + aMessage);
70         cause = aCause;
71     }
72
73     /**
74      * Creates a new UserMgtException object.
75      * 
76      */
77     public UserMgtException(Reason aCause, User aUser) {
78         this(aCause, "for user '" + aUser.getName() + "'");
79         user = aUser;
80     }
81
82     /**
83      * Creates a new UserMgtException object.
84      * 
85      */
86     public UserMgtException(Reason aCause, Group aGroup) {
87         this(aCause, "for group '" + aGroup.getName() + "'");
88         group = aGroup;
89     }
90
91     /**
92      * Creates a new UserMgtException object.
93      * 
94      */
95     public UserMgtException(Reason aCause, User aUser, Group aGroup) {
96         this(aCause, "for user '" + aUser.getName() + "' and group '" +
97             aGroup.getName() + "'");
98         user = aUser;
99         group = aGroup;
100     }
101
102     /**
103      * Gets the cause of the problem.
104      * 
105      * @return Cause.
106      */
107     public Reason getReason() {
108         return cause;
109     }
110
111     /**
112      * Gets the user for which the problem occurred.
113      * 
114      * @return User or null if not applicable.
115      */
116     public User getUser() {
117         return user;
118     }
119
120     /**
121      * Gets the group for which the problem occured.
122      * 
123      * @return Group or null if not applicable.
124      */
125     public Group getGroup() {
126         return group;
127     }
128
129     /**
130      * Possible causes for the exception.
131      * 
132      */
133     public enum Reason {
134         UNKNOWN_USER, UNKNOWN_GROUP, DUPLICATE_USER, DUPLICATE_GROUP, USER_ALREADY_IN_GROUP, USER_NOT_IN_GROUP, INVALID_PASSWORD, GROUP_STILL_OCCUPIED, USER_MUST_BE_IN_A_GROUP, INVALID_USERNAME, INVALID_GROUPNAME;
135     }
136 }