com.sshtools.synergy.ssh.CompoundChannelFactory Maven / Gradle / Ivy

Go to download
package com.sshtools.synergy.ssh;

/*-
 * #%L
 * Common API
 * %%
 * Copyright (C) 2002 - 2024 JADAPTIVE Limited
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import com.sshtools.common.command.ExecutableCommand;
import com.sshtools.common.permissions.PermissionDeniedException;
import com.sshtools.common.ssh.ChannelOpenException;
import com.sshtools.common.ssh.SessionChannel;
import com.sshtools.common.ssh.SshConnection;
import com.sshtools.common.ssh.Subsystem;
import com.sshtools.common.ssh.UnsupportedChannelException;
import com.sshtools.common.ssh.components.ComponentFactory;

public class CompoundChannelFactory implements ChannelFactory {
	
	private final List> factories = new ArrayList<>();

	public CompoundChannelFactory() {
	}
	
	public CompoundChannelFactory(@SuppressWarnings("unchecked") ChannelFactory... factories) {
		this.factories.addAll(Arrays.asList(factories));
	}
	
	public CompoundChannelFactory(Collection> factories) {
		this.factories.addAll(factories);
	}
	
	public void addFactory(ChannelFactory factory) {
		factories.add(factory);
	}
	
	public void removeFactory(ChannelFactory factory) {
		factories.remove(factory);
	}
	
	public List> getFactories() {
		return Collections.unmodifiableList(factories);
	}

	@Override
	public ComponentFactory supportedCommands() {
		/* TODO: This is not great. We can't create a facade to this 
		 * method due to how it works. So the first factory in the
		 * list must be the one that provides support for commands.
		 */
		return factories.get(0).supportedCommands();
	}

	@Override
	public ChannelNG createChannel(String channeltype, SshConnection con)
			throws UnsupportedChannelException, PermissionDeniedException, ChannelOpenException {
		for(var f : factories) {
			try {
				return f.createChannel(channeltype, con);
			}
			catch(UnsupportedChannelException uce) {
				//
			}
		}
		throw new UnsupportedChannelException(String.format("%s is not a supported channel type", channeltype));
	}

	@Override
	public Subsystem createSubsystem(String name, SessionChannel session)
			throws UnsupportedChannelException, PermissionDeniedException {
		for(var f : factories) {
			try {
				return f.createSubsystem(name, session);
			}
			catch(UnsupportedChannelException uce) {
				//
			}
		}
		throw new UnsupportedChannelException(String.format("%s is not a supported subsystem", name));
	}

	@Override
	public ExecutableCommand executeCommand(SessionChannel channel, String[] args, Map environment)
			throws PermissionDeniedException, UnsupportedChannelException {
		for(var f : factories) {
			try {
				return f.executeCommand(channel, args, environment);
			}
			catch(UnsupportedChannelException uce) {
				//
			}
		}
		throw new UnsupportedChannelException(String.format("%s is not a supported command", args[0]));
	}

}