Top Fields Methods
org.apache.sshd.server.subsystem

public Interface SubsystemFactory

extends NamedResource
Imports
java.io.IOException, java.util.Collection, org.apache.sshd.common.NamedResource, org.apache.sshd.server.channel.ChannelSession, org.apache.sshd.server.command.Command
Author
Apache MINA SSHD Project

Field Summary

Inherited from org.apache.sshd.common.NamedResource:
BY_NAME_COMPARATORNAME_EXTRACTOR

Method Summary

Modifier and TypeMethod and Description
public Command

Returns:

a non null Command instance representing the subsystem to be run
createSubsystem(ChannelSession
The ChannelSession through which the command has been received
channel)

public static Command

Returns:

The created Command instance representing the subsystem to be run - null if no match found
createSubsystem(ChannelSession
The ChannelSession through which the command has been received
channel, Collection<? extends SubsystemFactory>
The available SubsystemFactory-ies - ignored if null/empty
factories, String
Requested subsystem name
name)

Inherited from org.apache.sshd.common.NamedResource:
findByNamefindFirstMatchByNamegetNamegetNameListgetNamesofNameremoveByNamesafeCompareByName

Method Detail

createSubsystemback to summary
public Command createSubsystem(ChannelSession channel) throws IOException
Parameters
channel:ChannelSession

The ChannelSession through which the command has been received

Returns:Command

a non null Command instance representing the subsystem to be run

Exceptions
IOException:
if failed to create the instance
createSubsystemback to summary
public static Command createSubsystem(ChannelSession channel, Collection<? extends SubsystemFactory> factories, String name) throws IOException
Parameters
channel:ChannelSession

The ChannelSession through which the command has been received

factories:Collection<? extends SubsystemFactory>

The available SubsystemFactory-ies - ignored if null/empty

name:String

Requested subsystem name

Returns:Command

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

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