guacamole-ext/src/main/java/org/apache/guacamole/net/event/AuthenticationSuccessEvent.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.guacamole.net.event;

import org.apache.guacamole.net.auth.AuthenticatedUser;
import org.apache.guacamole.net.auth.AuthenticationProvider;
import org.apache.guacamole.net.auth.Credentials;

/**
 * An event which is triggered whenever a user's credentials pass
 * authentication. The credentials that passed authentication are included
 * within this event, and can be retrieved using getCredentials().
 * <p>
 * If a {@link org.apache.guacamole.net.event.listener.Listener} throws
 * a GuacamoleException when handling an event of this type, successful authentication
 * is effectively <em>vetoed</em> and will be subsequently processed as though the
 * authentication failed.
 */
public class AuthenticationSuccessEvent implements UserEvent, CredentialEvent,
        AuthenticationProviderEvent {

    /**
     * The AuthenticatedUser identifying the user that successfully
     * authenticated.
     */
    private final AuthenticatedUser authenticatedUser;

    /**
     * Whether the successful authentication attempt represented by this event
     * is related to an established Guacamole session.
     */
    private final boolean existingSession;
    
    /**
     * Creates a new AuthenticationSuccessEvent which represents a successful
     * authentication attempt by the user identified by the given
     * AuthenticatedUser object. The authentication attempt is presumed to be
     * a fresh authentication attempt unrelated to an established session (a
     * login attempt).
     *
     * @param authenticatedUser
     *     The AuthenticatedUser identifying the user that successfully
     *     authenticated.
     */
    public AuthenticationSuccessEvent(AuthenticatedUser authenticatedUser) {
        this(authenticatedUser, false);
    }

    /**
     * Creates a new AuthenticationSuccessEvent which represents a successful
     * authentication attempt by the user identified by the given
     * AuthenticatedUser object. Whether the authentication attempt is
     * related to an established session (a periodic re-authentication attempt
     * that updates session status) or not (a fresh login attempt) is
     * determined by the value of the provided flag.
     *
     * @param authenticatedUser
     *     The AuthenticatedUser identifying the user that successfully
     *     authenticated.
     *
     * @param existingSession
     *     Whether this AuthenticationSuccessEvent represents an
     *     re-authentication attempt that updates the status of an established
     *     Guacamole session.
     */
    public AuthenticationSuccessEvent(AuthenticatedUser authenticatedUser, boolean existingSession) {
        this.authenticatedUser = authenticatedUser;
        this.existingSession = existingSession;
    }

    @Override
    public AuthenticatedUser getAuthenticatedUser() {
        return authenticatedUser;
    }

    @Override
    public Credentials getCredentials() {
        return getAuthenticatedUser().getCredentials();
    }

    @Override
    public AuthenticationProvider getAuthenticationProvider() {
        return getAuthenticatedUser().getAuthenticationProvider();
    }

    /**
     * Returns whether the successful authentication attempt represented by
     * this event is related to an established Guacamole session. During normal
     * operation, the Guacamole web application will periodically
     * re-authenticate with the server to verify its authentication token and
     * update the session state, in which case the value returned by this
     * function will be true. If the user was not already authenticated and has
     * just initially logged in, false is returned.
     *
     * @return
     *     true if this AuthenticationSuccessEvent is related to a Guacamole
     *     session that was already established, false otherwise.
     */
    public boolean isExistingSession() {
        return existingSession;
    }

}