/*
 * $Id: MockPrincipal.java 471754 2006-11-06 14:55:09Z husted $
 *
 * 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.struts.mock;

import java.security.Principal;

/**
 * <p>Mock <strong>Principal</strong> object for low-level unit tests of
 * Struts controller components.  Coarser grained tests should be implemented
 * in terms of the Cactus framework, instead of the mock object classes.</p>
 *
 * <p><strong>WARNING</strong> - Only the minimal set of methods needed to
 * create unit tests is provided, plus additional methods to configure this
 * object as necessary.  Methods for unsupported operations will throw
 * <code>UnsupportedOperationException</code>.</p>
 *
 * <p><strong>WARNING</strong> - Because unit tests operate in a single
 * threaded environment, no synchronization is performed.</p>
 *
 * @version $Rev: 471754 $ $Date: 2005-05-07 12:11:38 -0400 (Sat, 07 May 2005)
 *          $
 */
public class MockPrincipal implements Principal {

    private final String name;
    private final String[] roles;

    /** MockPrincipal */
    public MockPrincipal() {
        super();
        this.name = "";
        this.roles = new String[0];
    }

    /**
     * @param val String
     */
    public MockPrincipal(final String val) {
        super();
        this.name = val;
        this.roles = new String[0];
    }

    /**
     * @param val1 String
     * @param val2 String[]
     */
    public MockPrincipal(final String val1, final String[] val2) {
        super();
        this.name = val1;
        this.roles = val2.clone();
    }

    /**
     * @see java.security.Principal#getName()
     */
    @Override
    public String getName() {
        return this.name;
    }

    /**
     * @param role String
     * @return boolean
     */
    public boolean isUserInRole(final String role) {
        for (int i = 0; i < this.roles.length; i++) {
            if (role.equals(this.roles[i])) {
                return true;
            }
        }

        return false;
    }

    /**
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object o) {
        if (o == null) {
            return false;
        }

        if (!(o instanceof Principal)) {
            return false;
        }

        Principal p = (Principal) o;

        if (this.name == null) {
            return p.getName() == null;
        }
        return this.name.equals(p.getName());
    }

    /**
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        if (this.name == null) {
            return "".hashCode();
        }
        return this.name.hashCode();
    }
}
