redback-authentication/redback-authentication-api/src/main/java/org/apache/archiva/redback/authentication/AuthenticationResult.java

package org.apache.archiva.redback.authentication;

/*
 * 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.
 */

import org.apache.archiva.redback.users.User;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * AuthenticationResult: wrapper object for information that comes back from the authentication system
 *
 * @author Jesse McConnell
 */
public class AuthenticationResult
    implements Serializable
{

    private static final long serialVersionUID = 354054054054L;

    private boolean isAuthenticated;

    private String principal;

    /**
     * as we can search the User store it here for reuse.
     *
     * @since 2.1
     */
    private User user;

    // TODO: why aren't these just thrown from the authenticate() method?
    private Exception exception;

    private List<AuthenticationFailureCause> authenticationFailureCauses;

    public AuthenticationResult()
    {
        this.isAuthenticated = false;
        this.principal = null;
        this.exception = null;
    }

    public AuthenticationResult( boolean authenticated, String principal, Exception exception )
    {
        isAuthenticated = authenticated;
        this.principal = principal;
        this.exception = exception;
    }

    public AuthenticationResult( boolean authenticated, String principal, Exception exception,
                                 List<AuthenticationFailureCause> authenticationFailureCauses )
    {
        isAuthenticated = authenticated;
        this.principal = principal;
        this.exception = exception;
        this.authenticationFailureCauses = authenticationFailureCauses;
    }

    public boolean isAuthenticated()
    {
        return isAuthenticated;
    }

    public String getPrincipal()
    {
        return principal;
    }

    public Exception getException()
    {
        return exception;
    }

    public List<AuthenticationFailureCause> getAuthenticationFailureCauses()
    {
        if ( authenticationFailureCauses == null )
        {
            this.authenticationFailureCauses = new ArrayList<AuthenticationFailureCause>();
        }
        return authenticationFailureCauses;
    }

    /**
     * <b>can be <code>null</code></b>
     */
    public User getUser()
    {
        return user;
    }

    public void setUser( User user )
    {
        this.user = user;
    }

    public AuthenticationResult user( User user )
    {
        this.setUser( user );
        return this;
    }

    public String toString()
    {
        StringBuilder sb = new StringBuilder();
        sb.append( "AuthenticationResult[" );
        sb.append( "principal=" ).append( principal );
        sb.append( ",isAuthenticated=" ).append( Boolean.toString( isAuthenticated ) );
        sb.append( ",exception=" );
        if ( exception != null )
        {
            sb.append( exception.getClass().getName() );
            sb.append( " : " ).append( exception.getMessage() );
        }
        else
        {
            sb.append( "<null>" );
        }
        sb.append( ']' );
        return sb.toString();
    }
}