/*************************************************************************
 *                                                                       *
 *  CESeCore: CE Security Core                                           *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.cesecore.mock.authentication.tokens;

import java.security.Principal;
import java.util.Arrays;
import java.util.HashSet;

import org.cesecore.authentication.tokens.AuthenticationToken;
import org.cesecore.authentication.tokens.AuthenticationTokenMetaData;
import org.cesecore.authentication.tokens.UsernamePrincipal;
import org.cesecore.authorization.user.AccessUserAspect;

/**
 * This mock of an authentication token is to provide a simple token to test authentication/authorization based
 * on a username. It shouldn't be used outside that context, and shouldn't be used to avoid proper authorization tests.
 * 
 * @version $Id: UsernameBasedAuthenticationToken.java 25590 2017-03-23 12:14:30Z samuellb $
 */
public class UsernameBasedAuthenticationToken extends AuthenticationToken{
    
    public static final UsernameBasedAuthenticationTokenMetaData metaData = new UsernameBasedAuthenticationTokenMetaData();
    
    private static final long serialVersionUID = -8284027258387832870L;

    private String username;
    
    public UsernameBasedAuthenticationToken(final UsernamePrincipal principal) {
        super(new HashSet<Principal>(Arrays.asList(principal)), null);
        this.username = principal.getName();
    }

    @Override
    public boolean matches(AccessUserAspect accessUser) {
        return username.equals(accessUser.getMatchValue());
    }
    
    @Override
    public int getPreferredMatchKey() {
        return 0; // doesn't use match keys
    }
    
    /** Returns the username */
    @Override
    public String getPreferredMatchValue() {
        return username;
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((username == null) ? 0 : username.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (getClass() != obj.getClass())
            return false;
        UsernameBasedAuthenticationToken other = (UsernameBasedAuthenticationToken) obj;
        if (username == null) {
            if (other.username != null)
                return false;
        } else if (!username.equals(other.username))
            return false;
        return true;
    }

    @Override
    protected String generateUniqueId() {
        return generateUniqueId(username);
    }

    @Override
    public AuthenticationTokenMetaData getMetaData() {
        return metaData;
    }
}