org.apache.guacamole.net.auth.DelegatingConnectionGroup 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.auth;

import java.util.Collections;
import java.util.Map;
import java.util.Set;
import org.apache.guacamole.GuacamoleException;
import org.apache.guacamole.net.GuacamoleTunnel;
import org.apache.guacamole.protocol.GuacamoleClientInformation;

/**
 * ConnectionGroup implementation which simply delegates all function calls to
 * an underlying ConnectionGroup.
 */
public class DelegatingConnectionGroup implements ConnectionGroup {

    /**
     * The wrapped ConnectionGroup.
     */
    private final ConnectionGroup connectionGroup;

    /**
     * The tokens which should apply strictly to the next call to
     * {@link #connect(org.apache.guacamole.protocol.GuacamoleClientInformation)}.
     * This storage is intended as a temporary bridge allowing the old version
     * of connect() to be overridden while still resulting in the same behavior
     * as older versions of DelegatingConnectionGroup. This storage
     * should be removed once support for the old, deprecated connect() is
     * removed.
     */
    private final ThreadLocal> currentTokens =
            new ThreadLocal>() {

        @Override
        protected Map initialValue() {
            return Collections.emptyMap();
        }

    };

    /**
     * Wraps the given ConnectionGroup such that all function calls against this
     * DelegatingConnectionGroup will be delegated to it.
     *
     * @param connectionGroup
     *     The ConnectionGroup to wrap.
     */
    public DelegatingConnectionGroup(ConnectionGroup connectionGroup) {
        this.connectionGroup = connectionGroup;
    }

    /**
     * Returns the underlying ConnectionGroup wrapped by this
     * DelegatingConnectionGroup.
     *
     * @return
     *     The ConnectionGroup wrapped by this DelegatingConnectionGroup.
     */
    protected ConnectionGroup getDelegateConnectionGroup() {
        return connectionGroup;
    }

    @Override
    public String getIdentifier() {
        return connectionGroup.getIdentifier();
    }

    @Override
    public void setIdentifier(String identifier) {
        connectionGroup.setIdentifier(identifier);
    }

    @Override
    public String getName() {
        return connectionGroup.getName();
    }

    @Override
    public void setName(String name) {
        connectionGroup.setName(name);
    }

    @Override
    public String getParentIdentifier() {
        return connectionGroup.getParentIdentifier();
    }

    @Override
    public void setParentIdentifier(String parentIdentifier) {
        connectionGroup.setParentIdentifier(parentIdentifier);
    }

    @Override
    public void setType(Type type) {
        connectionGroup.setType(type);
    }

    @Override
    public Type getType() {
        return connectionGroup.getType();
    }

    @Override
    public Set getConnectionIdentifiers() throws GuacamoleException {
        return connectionGroup.getConnectionIdentifiers();
    }

    @Override
    public Set getConnectionGroupIdentifiers() throws GuacamoleException {
        return connectionGroup.getConnectionGroupIdentifiers();
    }

    @Override
    public Map getAttributes() {
        return connectionGroup.getAttributes();
    }

    @Override
    public void setAttributes(Map attributes) {
        connectionGroup.setAttributes(attributes);
    }

    @Override
    @Deprecated
    public GuacamoleTunnel connect(GuacamoleClientInformation info)
            throws GuacamoleException {
        return connectionGroup.connect(info, currentTokens.get());
    }

    @Override
    public GuacamoleTunnel connect(GuacamoleClientInformation info,
            Map tokens) throws GuacamoleException {

        // Make received tokens available within the legacy connect() strictly
        // in context of the current connect() call
        try {
            currentTokens.set(tokens);
            return connect(info);
        }
        finally {
            currentTokens.remove();
        }

    }

    @Override
    public int getActiveConnections() {
        return connectionGroup.getActiveConnections();
    }

}