Package com.sshtools.j2ssh.agent
Class SshAgentSocketListener
java.lang.Object
com.sshtools.j2ssh.agent.SshAgentSocketListener
- Version:
- $Revision: 1.20 $
- Author:
- $author$
-
Constructor Summary
ConstructorsConstructorDescriptionSshAgentSocketListener
(String location, KeyStore keystore) Creates a new SshAgentSocketListener object. -
Method Summary
Modifier and TypeMethodDescriptionstatic int
Configure a new random port for the agent listener.protected KeyStore
Gets the underlying keystore for this agent listener.int
getPort()
The current port of the agent listenergetState()
Get the agent listeners statestatic void
The main entry point for the application.void
start()
Starts the agent listener threadvoid
stop()
Stops the agent listener
-
Constructor Details
-
SshAgentSocketListener
Creates a new SshAgentSocketListener object.- Parameters:
location
- the location of the listening agent. This should be a random port on the localhost such as localhost:15342keystore
- the keystore for agent operation- Throws:
AgentNotAvailableException
- if the location specifies an invalid location
-
-
Method Details
-
getState
Get the agent listeners state- Returns:
- the current state of the listener
-
start
public void start()Starts the agent listener thread -
getPort
public int getPort()The current port of the agent listener- Returns:
- the integer port
-
stop
public void stop()Stops the agent listener -
getKeystore
Gets the underlying keystore for this agent listener.- Returns:
- the keystore
-
configureNewLocation
public static int configureNewLocation()Configure a new random port for the agent listener.- Returns:
- the random port for this agent.
-
main
The main entry point for the application. This method currently accepts the -start parameter which will look for the sshtools.agent system property. To configure the agent and to get a valid location call with -configure, set the system sshtools.home system property and start.- Parameters:
args
- the programs arguments
-