org.apache.sshd.server.subsystem

Interface SubsystemFactory

All Superinterfaces:

NamedResource

public interface SubsystemFactory
extends NamedResource

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from interface org.apache.sshd.common.NamedResource

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Method Summary

Modifier and Type	Method and Description
Command	createSubsystem(ChannelSession channel)
static Command	createSubsystem(ChannelSession channel, Collection<? extends SubsystemFactory> factories, String name)

Methods inherited from interface org.apache.sshd.common.NamedResource

findByName, findFirstMatchByName, getName, getNameList, getNames, ofName, removeByName, safeCompareByName

Method Detail

createSubsystem

Command createSubsystem(ChannelSession channel)
                 throws IOException

Parameters:

channel - The ChannelSession through which the command has been received

Returns:

a non null Command instance representing the subsystem to be run

Throws:

IOException - if failed to create the instance

createSubsystem

static Command createSubsystem(ChannelSession channel,
                               Collection<? extends SubsystemFactory> factories,
                               String name)
                        throws IOException

Parameters:

channel - The ChannelSession through which the command has been received

factories - The available SubsystemFactory-ies - ignored if null/empty

name - Requested subsystem name

Returns:

The created Command instance representing the subsystem to be run - null if no match found

Throws:

IOException - If found a matching factory but failed to create the command instance