Interface ConnectorFactory.ConnectorDescriptor
-
- Enclosing interface:
- ConnectorFactory
public static interface ConnectorFactory.ConnectorDescriptor
ConnectorFactory.ConnectorDescriptor
s describe availableConnector
s aConnectorFactory
may provide.A
ConnectorFactory
may support connecting to different SSH agents. Agents are identified by name; a user can choose a specific agent for instance via theIdentityAgent
setting in~/.ssh/config
.OpenSSH knows two built-in names: "none" for not using any agent, and "SSH_AUTH_SOCK" for using an agent that communicates over a Unix domain socket given by the value of environment variable
SSH_AUTH_SOCK
. Other agents can be specified in OpenSSH by specifying the socket file directly. (The "standard" OpenBSD OpenSSH knows only this communication mechanism.) "SSH_AUTH_SOCK" is also the default in OpenBSD OpenSSH if nothing is configured.A particular
TheConnectorFactory
may support more communication mechanisms or different agents. For instance, a factory on Windows might support Pageant, Win32-OpenSSH, or even git bash ssh-agent, and might accept internal names like "pageant", "openssh", "SSH_AUTH_SOCK" inConnectorFactory.create(String, File)
to choose among them.ConnectorFactory.ConnectorDescriptor
interface and theConnectorFactory.getSupportedConnectors()
andConnectorFactory.getDefaultConnector()
methods provide a way for code using aConnectorFactory
to learn what the factory supports and thus implement some way by which a user can influence the default behavior ifIdentityAgent
is not set orConnectorFactory.create(String, File)
is called withidentityAgent == null
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getDisplayName()
Retrieves a display name for aConnector
, suitable for showing in a UI.String
getIdentityAgent()
Retrieves the internal name of a supportedConnector
.
-