001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/mbeans/UserMBean.java,v 1.3 2002/02/03 00:56:57 craigmcc Exp $
003: * $Revision: 1.3 $
004: * $Date: 2002/02/03 00:56:57 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 2002 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina.mbeans;
065:
066: import java.util.ArrayList;
067: import java.util.Iterator;
068: import javax.management.MalformedObjectNameException;
069: import javax.management.MBeanException;
070: import javax.management.MBeanServer;
071: import javax.management.ObjectName;
072: import javax.management.RuntimeOperationsException;
073: import org.apache.catalina.Group;
074: import org.apache.catalina.Role;
075: import org.apache.catalina.User;
076: import org.apache.catalina.UserDatabase;
077: import org.apache.commons.modeler.BaseModelMBean;
078: import org.apache.commons.modeler.ManagedBean;
079: import org.apache.commons.modeler.Registry;
080:
081: /**
082: * <p>A <strong>ModelMBean</strong> implementation for the
083: * <code>org.apache.catalina.User</code> component.</p>
084: *
085: * @author Craig R. McClanahan
086: * @version $Revision: 1.3 $ $Date: 2002/02/03 00:56:57 $
087: */
088:
089: public class UserMBean extends BaseModelMBean {
090:
091: // ----------------------------------------------------------- Constructors
092:
093: /**
094: * Construct a <code>ModelMBean</code> with default
095: * <code>ModelMBeanInfo</code> information.
096: *
097: * @exception MBeanException if the initializer of an object
098: * throws an exception
099: * @exception RuntimeOperationsException if an IllegalArgumentException
100: * occurs
101: */
102: public UserMBean() throws MBeanException,
103: RuntimeOperationsException {
104:
105: super ();
106:
107: }
108:
109: // ----------------------------------------------------- Instance Variables
110:
111: /**
112: * The configuration information registry for our managed beans.
113: */
114: protected Registry registry = MBeanUtils.createRegistry();
115:
116: /**
117: * The <code>MBeanServer</code> in which we are registered.
118: */
119: protected MBeanServer mserver = MBeanUtils.createServer();
120:
121: /**
122: * The <code>ManagedBean</code> information describing this MBean.
123: */
124: protected ManagedBean managed = registry.findManagedBean("User");
125:
126: // ------------------------------------------------------------- Attributes
127:
128: /**
129: * Return the MBean Names of all groups this user is a member of.
130: */
131: public String[] getGroups() {
132:
133: User user = (User) this .resource;
134: ArrayList results = new ArrayList();
135: Iterator groups = user.getGroups();
136: while (groups.hasNext()) {
137: Group group = null;
138: try {
139: group = (Group) groups.next();
140: ObjectName oname = MBeanUtils.createObjectName(managed
141: .getDomain(), group);
142: results.add(oname.toString());
143: } catch (MalformedObjectNameException e) {
144: throw new IllegalArgumentException(
145: "Cannot create object name for group " + group);
146: }
147: }
148: return ((String[]) results.toArray(new String[results.size()]));
149:
150: }
151:
152: /**
153: * Return the MBean Names of all roles assigned to this user.
154: */
155: public String[] getRoles() {
156:
157: User user = (User) this .resource;
158: ArrayList results = new ArrayList();
159: Iterator roles = user.getRoles();
160: while (roles.hasNext()) {
161: Role role = null;
162: try {
163: role = (Role) roles.next();
164: ObjectName oname = MBeanUtils.createObjectName(managed
165: .getDomain(), role);
166: results.add(oname.toString());
167: } catch (MalformedObjectNameException e) {
168: throw new IllegalArgumentException(
169: "Cannot create object name for role " + role);
170: }
171: }
172: return ((String[]) results.toArray(new String[results.size()]));
173:
174: }
175:
176: // ------------------------------------------------------------- Operations
177:
178: /**
179: * Add a new {@link Group} to those this user belongs to.
180: *
181: * @param groupname Group name of the new group
182: */
183: public void addGroup(String groupname) {
184:
185: User user = (User) this .resource;
186: if (user == null) {
187: return;
188: }
189: Group group = user.getUserDatabase().findGroup(groupname);
190: if (group == null) {
191: throw new IllegalArgumentException("Invalid group name '"
192: + groupname + "'");
193: }
194: user.addGroup(group);
195:
196: }
197:
198: /**
199: * Add a new {@link Role} to those this user belongs to.
200: *
201: * @param rolename Role name of the new role
202: */
203: public void addRole(String rolename) {
204:
205: User user = (User) this .resource;
206: if (user == null) {
207: return;
208: }
209: Role role = user.getUserDatabase().findRole(rolename);
210: if (role == null) {
211: throw new IllegalArgumentException("Invalid role name '"
212: + rolename + "'");
213: }
214: user.addRole(role);
215:
216: }
217:
218: /**
219: * Remove a {@link Group} from those this user belongs to.
220: *
221: * @param groupname Group name of the old group
222: */
223: public void removeGroup(String groupname) {
224:
225: User user = (User) this .resource;
226: if (user == null) {
227: return;
228: }
229: Group group = user.getUserDatabase().findGroup(groupname);
230: if (group == null) {
231: throw new IllegalArgumentException("Invalid group name '"
232: + groupname + "'");
233: }
234: user.removeGroup(group);
235:
236: }
237:
238: /**
239: * Remove a {@link Role} from those this user belongs to.
240: *
241: * @param rolename Role name of the old role
242: */
243: public void removeRole(String rolename) {
244:
245: User user = (User) this .resource;
246: if (user == null) {
247: return;
248: }
249: Role role = user.getUserDatabase().findRole(rolename);
250: if (role == null) {
251: throw new IllegalArgumentException("Invalid role name '"
252: + rolename + "'");
253: }
254: user.removeRole(role);
255:
256: }
257:
258: }
|