org.apache.guacamole.net.event.AuthenticationSuccessEvent Maven / Gradle / Ivy

Go to download
/*
 * 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.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().
 * 
 * If a {@link org.apache.guacamole.net.event.listener.Listener} throws
 * a GuacamoleException when handling an event of this type, successful authentication
 * is effectively vetoed and will be subsequently processed as though the
 * authentication failed.
 */
public class AuthenticationSuccessEvent implements UserEvent, CredentialEvent {

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

    /**
     * Creates a new AuthenticationSuccessEvent which represents a successful
     * authentication attempt by the user identified by the given
     * AuthenticatedUser object.
     *
     * @param authenticatedUser
     *     The AuthenticatedUser identifying the user that successfully
     *     authenticated.
     */
    public AuthenticationSuccessEvent(AuthenticatedUser authenticatedUser) {
        this.authenticatedUser = authenticatedUser;
    }

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

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

}