org.apache.sshd.server.command.AbstractDelegatingCommandFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sshd-osgi
There is a newer version: 2.14.0
/*
 * 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.sshd.server.command;

import java.io.IOException;

import org.apache.sshd.common.util.ValidateUtils;
import org.apache.sshd.common.util.logging.AbstractLoggingBean;
import org.apache.sshd.server.channel.ChannelSession;

/**
 * A {@link CommandFactory} wrapper that delegates calls to a proxy
 *
 * @author Apache MINA SSHD Project
 */
public abstract class AbstractDelegatingCommandFactory extends AbstractLoggingBean implements CommandFactory {
    private final String name;
    /*
     * NOTE: we expose setters since there is no problem to change these settings between successive invocations of the
     * 'createCommand' method
     */
    private CommandFactory delegate;

    protected AbstractDelegatingCommandFactory(String name) {
        this.name = ValidateUtils.checkNotNullAndNotEmpty(
                name, "No delegating command factory name provided");
    }

    @Override
    public String toString() {
        return name;
    }

    public CommandFactory getDelegateCommandFactory() {
        return delegate;
    }

    public void setDelegateCommandFactory(CommandFactory factory) {
        delegate = factory;
    }

    @Override
    public Command createCommand(ChannelSession channel, String command) throws IOException {
        if (isSupportedCommand(channel, command)) {
            return executeSupportedCommand(channel, command);
        }

        CommandFactory factory = getDelegateCommandFactory();
        if (factory != null) {
            return factory.createCommand(channel, command);
        }

        return createUnsupportedCommand(channel, command);
    }

    /**
     * @param  channel The {@link ChannelSession} through which the command was received
     * @param  command The command about to be executed
     * @return         {@code true} if this command is supported by the command factory, {@code false} if it will be
     *                 passed on to the {@link #getDelegateCommandFactory() delegate} factory
     */
    public abstract boolean isSupportedCommand(ChannelSession channel, String command);

    protected abstract Command executeSupportedCommand(ChannelSession channel, String command);

    protected Command createUnsupportedCommand(ChannelSession channel, String command) {
        throw new IllegalArgumentException("Unknown command to execute: " + command);
    }
}