View Javadoc

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 info.magnolia.cms.security.auth.Entity;
37  import info.magnolia.cms.security.auth.GroupList;
38  import info.magnolia.cms.security.auth.RoleList;
39  import info.magnolia.context.MgnlContext;
40  
41  import java.util.Collection;
42  import java.util.Iterator;
43  import java.util.Set;
44  import java.io.Serializable;
45  
46  import javax.security.auth.Subject;
47  
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  
52  /**
53   *
54   * @author philipp
55   * @author Sameer Charles
56   * @version $Revision:2558 $ ($Author:scharles $)
57   */
58  public class ExternalUser extends AbstractUser implements Serializable {
59      private static final Logger log = LoggerFactory.getLogger(ExternalUser.class);
60  
61      /**
62       * user properties
63       */
64      private Entity userDetails;
65  
66      /**
67       * user roles
68       */
69      private RoleList roleList;
70  
71      /**
72       * user groups
73       */
74      private GroupList groupList;
75  
76      /**
77       * @param subject as created by login module
78       */
79      protected ExternalUser(Subject subject) {
80          final Set<Entity> principalDetails = subject.getPrincipals(Entity.class);
81          final Iterator<Entity> entityIterator = principalDetails.iterator();
82          this.userDetails = entityIterator.next();
83  
84          final Set<RoleList> principalRoles = subject.getPrincipals(RoleList.class);
85          final Iterator<RoleList> roleListIterator = principalRoles.iterator();
86          this.roleList = roleListIterator.next();
87  
88          final Set<GroupList> principalGroups = subject.getPrincipals(GroupList.class);
89          final Iterator<GroupList> groupListIterator = principalGroups.iterator();
90          this.groupList = groupListIterator.next();
91      }
92  
93      public boolean hasRole(String roleName) {
94          return this.roleList.has(roleName);
95      }
96  
97      public void removeRole(String roleName) {
98          throw new UnsupportedOperationException("not implemented for this ExternalUser");
99      }
100 
101     public void addRole(String roleName) {
102         throw new UnsupportedOperationException("not implemented for this ExternalUser");
103     }
104 
105     /**
106      * Is this user in a specified group?
107      * @return true if in group
108      */
109     public boolean inGroup(String groupName) {
110         return this.groupList.has(groupName);
111     }
112 
113     /**
114      * Remove a group. Implementation is optional
115      */
116     public void removeGroup(String groupName) throws UnsupportedOperationException {
117         throw new UnsupportedOperationException("not implemented for this ExternalUser");
118     }
119 
120     /**
121      * Adds this user to a group. Implementation is optional
122      */
123     public void addGroup(String groupName) throws UnsupportedOperationException {
124         throw new UnsupportedOperationException("not implemented for this ExternalUser");
125     }
126 
127     public boolean isEnabled() {
128         return true;
129     }
130 
131     public void setEnabled(boolean enabled) {
132     }
133 
134     public String getLanguage() {
135         String language = (String) this.userDetails.getProperty(Entity.LANGUAGE);
136         if (null == language) {
137             language = MgnlContext.getSystemContext().getLocale().getLanguage();
138         }
139         return language;
140     }
141 
142     public String getName() {
143         return (String) this.userDetails.getProperty(Entity.NAME);
144     }
145 
146     /**
147      * get user password
148      * @return password string
149      */
150     public String getPassword() {
151         return (String) this.userDetails.getProperty(Entity.PASSWORD);
152     }
153 
154     public String getProperty(String propertyName) {
155         throw new UnsupportedOperationException("not implemented for this ExternalUser");
156     }
157 
158     public void setProperty(String propertyName, String value) {
159         throw new UnsupportedOperationException("not implemented for this ExternalUser");
160     }
161 
162     public Collection<String> getGroups() {
163         return this.groupList.getList();
164     }
165 
166     public Collection<String> getAllGroups() {
167         return this.getGroups();
168     }
169 
170     public Collection<String> getRoles() {
171         return this.roleList.getList();
172     }
173 
174     public Collection<String> getAllRoles() {
175         return this.getRoles();
176     }
177 }