org.apache.catalina.users.MemoryUser 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.users;
import java.util.Iterator;
import java.util.concurrent.CopyOnWriteArrayList;
import org.apache.catalina.Group;
import org.apache.catalina.Role;
import org.apache.catalina.UserDatabase;
import org.apache.tomcat.util.buf.StringUtils;
import org.apache.tomcat.util.buf.StringUtils.Function;
import org.apache.tomcat.util.security.Escape;
/**
* Concrete implementation of {@link org.apache.catalina.User} for the
* {@link MemoryUserDatabase} implementation of {@link UserDatabase}.
*
* @author Craig R. McClanahan
* @since 4.1
*/
public class MemoryUser extends AbstractUser {
// ----------------------------------------------------------- Constructors
/**
* Package-private constructor used by the factory method in
* {@link MemoryUserDatabase}.
*
* @param database The {@link MemoryUserDatabase} that owns this user
* @param username Logon username of the new user
* @param password Logon password of the new user
* @param fullName Full name of the new user
*/
MemoryUser(MemoryUserDatabase database, String username,
String password, String fullName) {
super();
this.database = database;
setUsername(username);
setPassword(password);
setFullName(fullName);
}
// ----------------------------------------------------- Instance Variables
/**
* The {@link MemoryUserDatabase} that owns this user.
*/
protected final MemoryUserDatabase database;
/**
* The set of {@link Group}s that this user is a member of.
*/
protected final CopyOnWriteArrayList groups = new CopyOnWriteArrayList<>();
/**
* The set of {@link Role}s associated with this user.
*/
protected final CopyOnWriteArrayList roles = new CopyOnWriteArrayList<>();
// ------------------------------------------------------------- Properties
/**
* Return the set of {@link Group}s to which this user belongs.
*/
@Override
public Iterator getGroups() {
return groups.iterator();
}
/**
* Return the set of {@link Role}s assigned specifically to this user.
*/
@Override
public Iterator getRoles() {
return roles.iterator();
}
/**
* Return the {@link UserDatabase} within which this User is defined.
*/
@Override
public UserDatabase getUserDatabase() {
return this.database;
}
// --------------------------------------------------------- Public Methods
/**
* Add a new {@link Group} to those this user belongs to.
*
* @param group The new group
*/
@Override
public void addGroup(Group group) {
groups.addIfAbsent(group);
}
/**
* Add a new {@link Role} to those assigned specifically to this user.
*
* @param role The new role
*/
@Override
public void addRole(Role role) {
roles.addIfAbsent(role);
}
/**
* Is this user in the specified group?
*
* @param group The group to check
*/
@Override
public boolean isInGroup(Group group) {
return groups.contains(group);
}
/**
* Is this user specifically assigned the specified {@link Role}? This
* method does NOT check for roles inherited based on
* {@link Group} membership.
*
* @param role The role to check
*/
@Override
public boolean isInRole(Role role) {
return roles.contains(role);
}
/**
* Remove a {@link Group} from those this user belongs to.
*
* @param group The old group
*/
@Override
public void removeGroup(Group group) {
groups.remove(group);
}
/**
* Remove all {@link Group}s from those this user belongs to.
*/
@Override
public void removeGroups() {
groups.clear();
}
/**
* Remove a {@link Role} from those assigned to this user.
*
* @param role The old role
*/
@Override
public void removeRole(Role role) {
roles.remove(role);
}
/**
* Remove all {@link Role}s from those assigned to this user.
*/
@Override
public void removeRoles() {
roles.clear();
}
/**
* Return a String representation of this user in XML format.
*
* IMPLEMENTATION NOTE - For backwards compatibility,
* the reader that processes this entry will accept either
* username or name for the username
* property.
* @return the XML representation
*/
public String toXml() {
StringBuilder sb = new StringBuilder("() {
@Override public String apply(Group t) {
return Escape.xml(t.getGroupname());
}
}, sb);
sb.append("\"");
sb.append(" roles=\"");
StringUtils.join(roles, ',', new Function() {
@Override public String apply(Role t) {
return Escape.xml(t.getRolename());
}
}, sb);
sb.append("\"");
sb.append("/>");
return sb.toString();
}
/**
* Return a String representation of this user.
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder("User username=\"");
sb.append(Escape.xml(username));
sb.append("\"");
if (fullName != null) {
sb.append(", fullName=\"");
sb.append(Escape.xml(fullName));
sb.append("\"");
}
sb.append(", groups=\"");
StringUtils.join(groups, ',', new Function() {
@Override public String apply(Group t) {
return Escape.xml(t.getGroupname());
}
}, sb);
sb.append("\"");
sb.append(", roles=\"");
StringUtils.join(roles, ',', new Function() {
@Override public String apply(Role t) {
return Escape.xml(t.getRolename());
}
}, sb);
sb.append("\"");
return sb.toString();
}
}