org.apache.guacamole.net.event.TunnelCloseEvent 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.GuacamoleTunnel;
import org.apache.guacamole.net.auth.AuthenticatedUser;
import org.apache.guacamole.net.auth.Credentials;

/**
 * An event which is triggered whenever a tunnel is being closed. The tunnel
 * being closed can be accessed through getTunnel(), and the UserContext
 * associated with the request which is closing the tunnel can be retrieved
 * with getUserContext().
 * 
 * If a {@link org.apache.guacamole.net.event.listener.Listener} throws
 * a GuacamoleException when handling an event of this type, the request to close
 * the tunnel is effectively vetoed and will remain connected.
 */
public class TunnelCloseEvent implements UserEvent, CredentialEvent, TunnelEvent {

    /**
     * The AuthenticatedUser associated with the user that is closing the
     * tunnel, if any.
     */
    private final AuthenticatedUser authenticatedUser;

    /**
     * The credentials associated with the request that closed the tunnel, if
     * any.
     */
    private final Credentials credentials;

    /**
     * The tunnel being closed.
     */
    private final GuacamoleTunnel tunnel;

    /**
     * Creates a new TunnelCloseEvent which represents the closing of the
     * given tunnel via a request associated with the given credentials.
     *
     * @param authenticatedUser
     *     The AuthenticatedUser associated with the user that is closing the
     *     tunnel, if any.
     *
     * @param credentials
     *     The credentials associated with the request that closed the
     *     tunnel. Note that these credentials are not necessarily the same as
     *     the credentials provided when the user authenticated.
     *
     * @param tunnel
     *     The tunnel being closed.
     */
    public TunnelCloseEvent(AuthenticatedUser authenticatedUser,
            Credentials credentials, GuacamoleTunnel tunnel) {
        this.authenticatedUser = authenticatedUser;
        this.credentials = credentials;
        this.tunnel = tunnel;
    }

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

    @Override
    public Credentials getCredentials() {
        return credentials;
    }

    @Override
    public GuacamoleTunnel getTunnel() {
        return tunnel;
    }

}