Top Fields Constructors Methods
org.apache.sshd.common.helpers

public abstract Class AbstractFactoryManager

extends AbstractKexFactoryManager
implements FactoryManager
Class Inheritance
All Implemented Interfaces
org.apache.sshd.common.FactoryManager, org.apache.sshd.common.session.SessionHeartbeatController, org.apache.sshd.common.PropertyResolver, org.apache.sshd.common.AttributeStore, org.apache.sshd.common.AttributeRepository, org.apache.sshd.common.io.IoServiceEventListenerManager, org.apache.sshd.common.forward.PortForwardingEventListenerManager, org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager, org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager, org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver, org.apache.sshd.common.channel.ChannelListenerManager, org.apache.sshd.common.session.SessionDisconnectHandlerManager, org.apache.sshd.common.session.ReservedSessionMessagesManager, org.apache.sshd.common.session.SessionListenerManager, org.apache.sshd.common.kex.KexFactoryManager, org.apache.sshd.common.kex.extension.KexExtensionHandlerManager, org.apache.sshd.common.signature.SignatureFactoriesManager, org.apache.sshd.common.signature.SignatureFactoriesHolder
Known Direct Subclasses
org.apache.sshd.server.SshServer, org.apache.sshd.client.SshClient
Imports
java.util.Collection, .Collections, .HashSet, .List, .Map, .Objects, java.util.concurrent.ConcurrentHashMap, .CopyOnWriteArraySet, .ScheduledExecutorService, .ScheduledFuture, .TimeUnit, java.util.function.Function, org.apache.sshd.agent.SshAgentFactory, org.apache.sshd.common.AttributeRepository, .Factory, .FactoryManager, .PropertyResolver, .PropertyResolverUtils, .ServiceFactory, .SyspropsMapWrapper, org.apache.sshd.common.channel.ChannelFactory, .ChannelListener, .RequestHandler, org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver, org.apache.sshd.common.config.VersionProperties, org.apache.sshd.common.file.FileSystemFactory, org.apache.sshd.common.forward.ForwarderFactory, .PortForwardingEventListener, org.apache.sshd.common.io.DefaultIoServiceFactoryFactory, .IoServiceEventListener, .IoServiceFactory, .IoServiceFactoryFactory, org.apache.sshd.common.kex.AbstractKexFactoryManager, org.apache.sshd.common.random.Random, org.apache.sshd.common.session.ConnectionService, .ReservedSessionMessagesHandler, .SessionDisconnectHandler, .SessionListener, .UnknownChannelReferenceHandler, org.apache.sshd.common.session.helpers.AbstractSessionFactory, .SessionTimeoutListener, org.apache.sshd.common.util.EventListenerUtils, .ValidateUtils, org.apache.sshd.common.util.threads.ThreadUtils, org.apache.sshd.core.CoreModuleProperties, org.apache.sshd.server.forward.ForwardingFilter

Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected SshAgentFactory
private final Map<AttributeRepository.AttributeKey<?>, Object>
protected List<? extends ChannelFactory>
protected final ChannelListener
protected final Collection<ChannelListener>
private ChannelStreamWriterResolver
private IoServiceEventListener
protected ScheduledExecutorService
protected FileSystemFactory
protected ForwarderFactory
protected ForwardingFilter
protected List<RequestHandler<ConnectionService>>
protected IoServiceFactory
protected IoServiceFactoryFactory
private PropertyResolver
private final Map<String, Object>
protected Factory<? extends Random>
private ReservedSessionMessagesHandler
protected List<? extends ServiceFactory>
private SessionDisconnectHandler
protected final SessionListener
protected final Collection<SessionListener>
protected SessionTimeoutListener
protected boolean
protected ScheduledFuture<?>
protected final PortForwardingEventListener
protected final Collection<PortForwardingEventListener>
private UnknownChannelReferenceHandler

Constructor Summary

AccessConstructor and Description
protected

Method Summary

Modifier and TypeMethod and Description
public void
public void
public void
public Collection<AttributeRepository.AttributeKey<?>>
protected void
public void
clearAttributes()

Implements org.apache.sshd.common.AttributeStore.clearAttributes.

Removes all currently stored user-defined attributes

public <T> T
computeAttributeIfAbsent(AttributeRepository.AttributeKey<T>
The key of the attribute; must not be null.
key
,
Function<? super AttributeRepository.AttributeKey<T>, ? extends T>
The (never null) mapping function to use if value not already mapped. If returns null then value is not mapped to the provided key.
resolver
)

Overrides default org.apache.sshd.common.AttributeStore.computeAttributeIfAbsent.

If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.

protected SessionTimeoutListener
public SshAgentFactory
getAgentFactory()

Implements org.apache.sshd.common.FactoryManager.getAgentFactory.

Retrieve the agent factory for creating SshAgent objects.

public <T> T
getAttribute(AttributeRepository.AttributeKey<T>
The key of the attribute; must not be null.
key
)

Implements org.apache.sshd.common.AttributeRepository.getAttribute.

Returns the value of the user-defined attribute.

public int
public List<? extends ChannelFactory>
getChannelFactories()

Implements org.apache.sshd.common.FactoryManager.getChannelFactories.

Retrieve the list of named factories for Channel objects.

public ChannelListener
public ChannelStreamWriterResolver
public FileSystemFactory
getFileSystemFactory()

Implements org.apache.sshd.common.FactoryManager.getFileSystemFactory.

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

public ForwarderFactory
getForwarderFactory()

Implements org.apache.sshd.common.FactoryManager.getForwarderFactory.

Retrieve the forwarder factory used to support forwarding.

public ForwardingFilter
getForwardingFilter()

Implements org.apache.sshd.common.FactoryManager.getForwardingFilter.

Retrieve the ForwardingFilter to be used by the SSH server.

public List<RequestHandler<ConnectionService>>
getGlobalRequestHandlers()

Implements org.apache.sshd.common.FactoryManager.getGlobalRequestHandlers.

Retrieve the list of global request handlers.

public IoServiceEventListener
public IoServiceFactory
public IoServiceFactoryFactory
public int
public PropertyResolver
public PortForwardingEventListener
public Map<String, Object>
getProperties()

Implements org.apache.sshd.common.PropertyResolver.getProperties.

A map of properties that can be used to configure the SSH server or client.

public Factory<? extends Random>
getRandomFactory()

Implements org.apache.sshd.common.FactoryManager.getRandomFactory.

Retrieve the Random factory to be used.

public ReservedSessionMessagesHandler
public ScheduledExecutorService
getScheduledExecutorService()

Implements org.apache.sshd.common.FactoryManager.getScheduledExecutorService.

Retrieve the ScheduledExecutorService to be used.

public List<? extends ServiceFactory>
getServiceFactories()

Implements org.apache.sshd.common.FactoryManager.getServiceFactories.

Retrieve the list of SSH Service factories.

public SessionDisconnectHandler
public SessionListener
public UnknownChannelReferenceHandler
public String
getVersion()

Implements org.apache.sshd.common.FactoryManager.getVersion.

An upper case string identifying the version of the software used on client or server side.

public <T> T
removeAttribute(AttributeRepository.AttributeKey<T>
The key of the attribute; must not be null.
key
)

Implements org.apache.sshd.common.AttributeStore.removeAttribute.

Removes the user-defined attribute

public void
public void
public void
protected void
public UnknownChannelReferenceHandler
resolveUnknownChannelReferenceHandler()

Implements org.apache.sshd.common.session.UnknownChannelReferenceHandlerManager.resolveUnknownChannelReferenceHandler.

Check if current manager has a specific handler set for it - if not, try and resolve one from the "parent" container (if any)

public void
public <T> T
setAttribute(AttributeRepository.AttributeKey<T>
The key of the attribute; must not be null.
key
,
T
The value of the attribute; must not be null.
value
)

Implements org.apache.sshd.common.AttributeStore.setAttribute.

Sets a user-defined attribute.

public void
setChannelFactories(List<? extends ChannelFactory> channelFactories)

public void
public void
public void
public void
public void
public void
public void
public void
setNioWorkers(int nioWorkers)

public void
public void
setRandomFactory(Factory<? extends Random> randomFactory)

public void
public void
public void
setScheduledExecutorService(ScheduledExecutorService executor, boolean shutdownExecutor)

public void
setServiceFactories(List<? extends ServiceFactory> serviceFactories)

public void
public void
protected void
protected void
Inherited from org.apache.sshd.common.kex.AbstractKexFactoryManager:
getCipherFactoriesgetCompressionFactoriesgetDelegategetKexExtensionHandlergetKeyExchangeFactoriesgetMacFactoriesgetSignatureFactoriesresolveEffectiveFactoriesresolveEffectiveProvidersetCipherFactoriessetCompressionFactoriessetKexExtensionHandlersetKeyExchangeFactoriessetMacFactoriessetSignatureFactories