Apache Mina SSHD 2.15.0 · org.apache.sshd.common.FactoryManager

Field Summary

Modifier and Type	Field and Description
public static final String	DEFAULT_VERSION The default `REPORTED_VERSION` of `FactoryManager#getVersion()` if the built-in version information cannot be accessed

Method Summary

Modifier and Type	Method and Description
public SshAgentFactory	Returns: The `SshAgentFactory` getAgentFactory() Retrieve the agent factory for creating `SshAgent` objects.
public default AgentForwardingFilter	getAgentForwardingFilter()
public List<? extends ChannelFactory>	Returns: A list of `ChannelFactory`-ies, never `null` getChannelFactories() Retrieve the list of named factories for `Channel` objects.
public FileSystemFactory	Returns: a valid `FileSystemFactory` instance or `null` if file based interactions are not supported on this server getFileSystemFactory() Retrieve the `FileSystemFactory` to be used to traverse the file system.
public ForwarderFactory	Returns: The `ForwarderFactory` getForwarderFactory() Retrieve the forwarder factory used to support forwarding.
public ForwardingFilter	Returns: The `ForwardingFilter` or `null` getForwardingFilter() Retrieve the `ForwardingFilter` to be used by the SSH server.
public List<RequestHandler<ConnectionService>>	Returns: a list of named `GlobalRequestHandler` getGlobalRequestHandlers() Retrieve the list of global request handlers.
public IoServiceFactory	getIoServiceFactory()
public Factory<? extends Random>	Returns: The `Random` factory, never `null` getRandomFactory() Retrieve the `Random` factory to be used.
public ScheduledExecutorService	Returns: The `ScheduledExecutorService`, never `null` getScheduledExecutorService() Retrieve the `ScheduledExecutorService` to be used.
public List<? extends ServiceFactory>	Returns: a list of named `Service` factories, never `null` getServiceFactories() Retrieve the list of SSH `Service` factories.
public default TcpForwardingFilter	getTcpForwardingFilter()
public String	Returns: the version of the software getVersion() An upper case string identifying the version of the software used on client or server side.
public default X11ForwardingFilter	getX11ForwardingFilter()
public default <T> T	resolveAttribute(AttributeRepository.AttributeKey<T> The key of the attribute; must not be `null`. key) Overrides default org.apache.sshd.common.AttributeRepository.resolveAttribute. Attempts to resolve the associated value by going up the store's hierarchy (if any)
public static < The generic attribute type T> T	Returns: Associated value - `null` if not found resolveAttribute(FactoryManager The `FactoryManager` - ignored if `null` manager, AttributeRepository.AttributeKey<T> The attribute key - never `null` key)

Inherited from org.apache.sshd.common.AttributeStore:: clearAttributes computeAttributeIfAbsent removeAttribute setAttribute
Inherited from org.apache.sshd.common.channel.ChannelListenerManager:: addChannelListener getChannelListenerProxy removeChannelListener
Inherited from org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager:: getChannelStreamWriterResolver resolveChannelStreamWriter resolveChannelStreamWriterResolver setChannelStreamWriterResolver
Inherited from org.apache.sshd.common.forward.PortForwardingEventListenerManager:: addPortForwardingEventListener getPortForwardingEventListenerProxy removePortForwardingEventListener
Inherited from org.apache.sshd.common.io.IoServiceEventListenerManager:: getIoServiceEventListener setIoServiceEventListener
Inherited from org.apache.sshd.common.kex.KexFactoryManager:: getCipherFactories getCipherFactoriesNameList getCipherFactoriesNames getCompressionFactories getCompressionFactoriesNameList getCompressionFactoriesNames getKeyExchangeFactories getMacFactories getMacFactoriesNameList getMacFactoriesNames setCipherFactories setCipherFactoriesNameList setCipherFactoriesNames setCipherFactoriesNames setCompressionFactories setCompressionFactoriesNameList setCompressionFactoriesNames setCompressionFactoriesNames setKeyExchangeFactories setMacFactories setMacFactoriesNameList setMacFactoriesNames setMacFactoriesNames
Inherited from org.apache.sshd.common.session.ReservedSessionMessagesManager:: getReservedSessionMessagesHandler setReservedSessionMessagesHandler
Inherited from org.apache.sshd.common.session.SessionDisconnectHandlerManager:: getSessionDisconnectHandler setSessionDisconnectHandler
Inherited from org.apache.sshd.common.session.SessionHeartbeatController:: disableSessionHeartbeat getSessionHeartbeatInterval getSessionHeartbeatType setSessionHeartbeat setSessionHeartbeat
Inherited from org.apache.sshd.common.session.SessionListenerManager:: addSessionListener getSessionListenerProxy removeSessionListener
Inherited from org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager:: getUnknownChannelReferenceHandler resolveUnknownChannelReferenceHandler setUnknownChannelReferenceHandler

Field Detail

DEFAULT_VERSION	back to summary
public static final String DEFAULT_VERSION The default `REPORTED_VERSION` of `FactoryManager#getVersion()` if the built-in version information cannot be accessed

Method Detail

getAgentFactory back to summary

getAgentFactory	back to summary
public SshAgentFactory getAgentFactory() Retrieve the agent factory for creating `SshAgent` objects. Returns:SshAgentFactory The `SshAgentFactory`

public SshAgentFactory getAgentFactory()

Retrieve the agent factory for creating SshAgent objects.

Returns:SshAgentFactory: The SshAgentFactory

getAgentForwardingFilter	back to summary
public default AgentForwardingFilter getAgentForwardingFilter()

getChannelFactories back to summary

getChannelFactories	back to summary
public List<? extends ChannelFactory> getChannelFactories() Retrieve the list of named factories for `Channel` objects. Returns:List<? extends ChannelFactory> A list of `ChannelFactory`-ies, never `null`

public List<? extends ChannelFactory> getChannelFactories()

Retrieve the list of named factories for Channel objects.

Returns:List<? extends ChannelFactory>: A list of ChannelFactory-ies, never null

getFileSystemFactory back to summary

getFileSystemFactory	back to summary
public FileSystemFactory getFileSystemFactory() Retrieve the `FileSystemFactory` to be used to traverse the file system. Returns:FileSystemFactory a valid `FileSystemFactory` instance or `null` if file based interactions are not supported on this server

public FileSystemFactory getFileSystemFactory()

Retrieve the FileSystemFactory to be used to traverse the file system.

Returns:FileSystemFactory: a valid FileSystemFactory instance or null if file based interactions are not supported on this server

getForwarderFactory back to summary

getForwarderFactory	back to summary
public ForwarderFactory getForwarderFactory() Retrieve the forwarder factory used to support forwarding. Returns:ForwarderFactory The `ForwarderFactory`

public ForwarderFactory getForwarderFactory()

Retrieve the forwarder factory used to support forwarding.

Returns:ForwarderFactory: The ForwarderFactory

getForwardingFilter back to summary

getForwardingFilter	back to summary
public ForwardingFilter getForwardingFilter() Retrieve the `ForwardingFilter` to be used by the SSH server. If no filter has been configured (i.e. this method returns `null`), then all forwarding requests will be rejected. Returns:ForwardingFilter The `ForwardingFilter` or `null`

public ForwardingFilter getForwardingFilter()

Retrieve the ForwardingFilter to be used by the SSH server. If no filter has been configured (i.e. this method returns null), then all forwarding requests will be rejected.

Returns:ForwardingFilter: The ForwardingFilter or null

getGlobalRequestHandlers back to summary

getGlobalRequestHandlers	back to summary
public List<RequestHandler<ConnectionService>> getGlobalRequestHandlers() Retrieve the list of global request handlers. Returns:List<RequestHandler<ConnectionService>> a list of named `GlobalRequestHandler`

public List<RequestHandler<ConnectionService>> getGlobalRequestHandlers()

Retrieve the list of global request handlers.

Returns:List<RequestHandler<ConnectionService>>: a list of named GlobalRequestHandler

getIoServiceFactory	back to summary
public IoServiceFactory getIoServiceFactory()

getRandomFactory back to summary

getRandomFactory	back to summary
public Factory<? extends Random> getRandomFactory() Retrieve the `Random` factory to be used. Returns:Factory<? extends Random> The `Random` factory, never `null`

public Factory<? extends Random> getRandomFactory()

Retrieve the Random factory to be used.

Returns:Factory<? extends Random>: The Random factory, never null

getScheduledExecutorService back to summary

getScheduledExecutorService	back to summary
public ScheduledExecutorService getScheduledExecutorService() Retrieve the `ScheduledExecutorService` to be used. Returns:ScheduledExecutorService The `ScheduledExecutorService`, never `null`

public ScheduledExecutorService getScheduledExecutorService()

Retrieve the ScheduledExecutorService to be used.

Returns:ScheduledExecutorService: The ScheduledExecutorService, never null

getServiceFactories back to summary

getServiceFactories	back to summary
public List<? extends ServiceFactory> getServiceFactories() Retrieve the list of SSH `Service` factories. Returns:List<? extends ServiceFactory> a list of named `Service` factories, never `null`

public List<? extends ServiceFactory> getServiceFactories()

Retrieve the list of SSH Service factories.

Returns:List<? extends ServiceFactory>: a list of named Service factories, never null

getTcpForwardingFilter	back to summary
public default TcpForwardingFilter getTcpForwardingFilter()

getVersion back to summary

getVersion	back to summary
public String getVersion() An upper case string identifying the version of the software used on client or server side. This version includes the name and version of the software and usually looks like this: `SSHD-CORE-1.0` Returns:String the version of the software

public String getVersion()

An upper case string identifying the version of the software used on client or server side. This version includes the name and version of the software and usually looks like this: SSHD-CORE-1.0

Returns:String: the version of the software

getX11ForwardingFilter	back to summary
public default X11ForwardingFilter getX11ForwardingFilter()

resolveAttribute back to summary

resolveAttribute	back to summary
public default <T> T resolveAttribute(AttributeRepository.AttributeKey<T> key) Overrides default org.apache.sshd.common.AttributeRepository.resolveAttribute. Doc from org.apache.sshd.common.AttributeRepository.resolveAttribute. Attempts to resolve the associated value by going up the store's hierarchy (if any) Parameters <T> The generic attribute type key:AttributeRepository.AttributeKey<T> The key of the attribute; must not be `null`. Returns:T `null` if there is no value associated with the specified key either in this repository or any of its ancestors (if any available) Annotations @Override

public default <T> T resolveAttribute(AttributeRepository.AttributeKey<T> key)

Overrides default org.apache.sshd.common.AttributeRepository.resolveAttribute.

Doc from org.apache.sshd.common.AttributeRepository.resolveAttribute.

Attempts to resolve the associated value by going up the store's hierarchy (if any)

Parameters

<T>: The generic attribute type
key:AttributeRepository.AttributeKey<T>: The key of the attribute; must not be null.

Returns:T

null if there is no value associated with the specified key either in this repository or any of its ancestors (if any available)

Annotations

@Override

resolveAttribute	back to summary
public static <T> T resolveAttribute(FactoryManager manager, AttributeRepository.AttributeKey<T> key) Parameters <T> The generic attribute type manager:FactoryManager The `FactoryManager` - ignored if `null` key:AttributeRepository.AttributeKey<T> The attribute key - never `null` Returns:T Associated value - `null` if not found

public Interface FactoryManager

Field Summary

Method Summary

Field Detail

Method Detail