qpid/java/broker/src/main/java/org/apache/qpid/server/security/auth/sasl/UsernamePrincipal.java

/*
 *
 * 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.qpid.server.security.auth.sasl;

import javax.security.auth.Subject;
import java.security.Principal;
import java.util.Set;

/** A principal that is just a wrapper for a simple username. */
public class UsernamePrincipal implements Principal
{
    private final String _name;

    public UsernamePrincipal(String name)
    {
        if (name == null)
        {
            throw new IllegalArgumentException("name cannot be null");
        }
        _name = name;
    }

    public String getName()
    {
        return _name;
    }

    public String toString()
    {
        return _name;
    }

    /**
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode()
    {
        final int prime = 31;
        return prime * _name.hashCode();
    }

    /**
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
        {
            return true;
        }
        else
        {
            if (obj instanceof UsernamePrincipal)
            {
                UsernamePrincipal other = (UsernamePrincipal) obj;
                return _name.equals(other._name);
            }
            else
            {
                return false;
            }
        }
    }

    public static UsernamePrincipal getUsernamePrincipalFromSubject(final Subject authSubject)
    {
        if (authSubject == null)
        {
            throw new IllegalArgumentException("No authenticated subject.");
        }

        final Set<UsernamePrincipal> principals = authSubject.getPrincipals(UsernamePrincipal.class);
        if (principals.size() != 1)
        {
            throw new IllegalArgumentException("Can't find single UsernamePrincipal in authenticated subject");
        }
        return principals.iterator().next();
    }
}