1 /**
2 * This file Copyright (c) 2003-2010 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.security;
35
36 import java.io.Serializable;
37 import java.util.Collection;
38
39 import javax.security.auth.Subject;
40
41 /**
42 * Represents a magnolia user.
43 *
44 * @author philipp
45 * @version $Revision:2558 $ ($Author:scharles $)
46 */
47 public interface User extends Serializable {
48
49 /**
50 * Is this user in a specified role?
51 * @param roleName the name of the role
52 * @return true if in role
53 */
54 boolean hasRole(String roleName);
55
56 /**
57 * Remove a role. Implementation is optional
58 */
59 void removeRole(String roleName) throws UnsupportedOperationException;
60
61 /**
62 * Adds a role to this user. Implementation is optional
63 * @param roleName the name of the role
64 */
65 void addRole(String roleName) throws UnsupportedOperationException;
66
67 /**
68 * Is this user in a specified group?
69 * @return true if in group
70 */
71 boolean inGroup(String groupName);
72
73 /**
74 * Remove a group. Implementation is optional
75 */
76 void removeGroup(String groupName) throws UnsupportedOperationException;
77
78 /**
79 * Adds this user to a group. Implementation is optional
80 */
81 void addGroup(String groupName) throws UnsupportedOperationException;
82
83 /**
84 * Returns false if the user was explicitly disabled. Implementations should return
85 * true by default if the status is unknown.
86 */
87 boolean isEnabled();
88
89 void setEnabled(boolean enabled);
90
91 /**
92 * get user language
93 * @return language string
94 */
95 String getLanguage();
96
97 /**
98 * get user name
99 * @return name string
100 */
101 String getName();
102
103 /**
104 * get user password
105 * @return password string
106 */
107 String getPassword();
108
109 /**
110 * Gets an arbitrary property from this user.
111 */
112 String getProperty(String propertyName);
113
114 /**
115 * Sets an arbitrary property for this user.
116 * Values are currently Strings; we'd need some kind of abstract encoding mechanism to allow other types if needed.
117 */
118 void setProperty(String propertyName, String value);
119
120 /**
121 * get groups that user is in
122 */
123 Collection<String> getGroups();
124
125 /**
126 * get all groups to which this user belongs to, collected recursively including
127 * */
128 Collection<String> getAllGroups();
129
130 /**
131 * get roles that are directly assigned to user
132 */
133 Collection<String> getRoles();
134
135 /**
136 * get all roles assigned to this user, collected recursively including groups/subgroups
137 * */
138 Collection<String> getAllRoles();
139
140 /**
141 * Returns the jaas subject if available.
142 */
143 Subject getSubject();
144
145 /**
146 * The jass login handler will set the subject
147 *
148 */
149 void setSubject(Subject subject);
150 }