org.apache.catalina.mbeans.UserMBean Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.mbeans;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import org.apache.catalina.Group;
import org.apache.catalina.Role;
import org.apache.catalina.User;
import org.apache.tomcat.util.modeler.BaseModelMBean;
import org.apache.tomcat.util.modeler.ManagedBean;
import org.apache.tomcat.util.modeler.Registry;
import org.apache.tomcat.util.res.StringManager;
/**
*
* A ModelMBean implementation for the org.apache.catalina.User component.
*
*
* @author Craig R. McClanahan
*/
public class UserMBean extends BaseModelMBean {
private static final StringManager sm = StringManager.getManager(UserMBean.class);
// ----------------------------------------------------- Instance Variables
/**
* The configuration information registry for our managed beans.
*/
protected final Registry registry = MBeanUtils.createRegistry();
/**
* The ManagedBean information describing this MBean.
*/
protected final ManagedBean managed = registry.findManagedBean("User");
// ------------------------------------------------------------- Attributes
/**
* @return the MBean Names of all groups this user is a member of.
*/
public String[] getGroups() {
User user = (User) this.resource;
List results = new ArrayList<>();
Iterator groups = user.getGroups();
while (groups.hasNext()) {
Group group = null;
try {
group = groups.next();
ObjectName oname = MBeanUtils.createObjectName(managed.getDomain(), group);
results.add(oname.toString());
} catch (MalformedObjectNameException e) {
throw new IllegalArgumentException(sm.getString("userMBean.createError.group", group), e);
}
}
return results.toArray(new String[0]);
}
/**
* @return the MBean Names of all roles assigned to this user.
*/
public String[] getRoles() {
User user = (User) this.resource;
List results = new ArrayList<>();
Iterator roles = user.getRoles();
while (roles.hasNext()) {
Role role = null;
try {
role = roles.next();
ObjectName oname = MBeanUtils.createObjectName(managed.getDomain(), role);
results.add(oname.toString());
} catch (MalformedObjectNameException e) {
throw new IllegalArgumentException(sm.getString("userMBean.createError.role", role), e);
}
}
return results.toArray(new String[0]);
}
// ------------------------------------------------------------- Operations
/**
* Add a new {@link Group} to those this user belongs to.
*
* @param groupname Group name of the new group
*/
public void addGroup(String groupname) {
User user = (User) this.resource;
if (user == null) {
return;
}
Group group = user.getUserDatabase().findGroup(groupname);
if (group == null) {
throw new IllegalArgumentException(sm.getString("userMBean.invalidGroup", groupname));
}
user.addGroup(group);
}
/**
* Add a new {@link Role} to those this user belongs to.
*
* @param rolename Role name of the new role
*/
public void addRole(String rolename) {
User user = (User) this.resource;
if (user == null) {
return;
}
Role role = user.getUserDatabase().findRole(rolename);
if (role == null) {
throw new IllegalArgumentException(sm.getString("userMBean.invalidRole", rolename));
}
user.addRole(role);
}
/**
* Remove a {@link Group} from those this user belongs to.
*
* @param groupname Group name of the old group
*/
public void removeGroup(String groupname) {
User user = (User) this.resource;
if (user == null) {
return;
}
Group group = user.getUserDatabase().findGroup(groupname);
if (group == null) {
throw new IllegalArgumentException(sm.getString("userMBean.invalidGroup", groupname));
}
user.removeGroup(group);
}
/**
* Remove a {@link Role} from those this user belongs to.
*
* @param rolename Role name of the old role
*/
public void removeRole(String rolename) {
User user = (User) this.resource;
if (user == null) {
return;
}
Role role = user.getUserDatabase().findRole(rolename);
if (role == null) {
throw new IllegalArgumentException(sm.getString("userMBean.invalidRole", rolename));
}
user.removeRole(role);
}
}