Class SshAgentSocketListener

java.lang.Object
com.sshtools.j2ssh.agent.SshAgentSocketListener

public class SshAgentSocketListener extends Object
Version:
$Revision: 1.20 $
Author:
$author$
  • Constructor Details

    • SshAgentSocketListener

      public SshAgentSocketListener(String location, KeyStore keystore) throws AgentNotAvailableException
      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:15342
      keystore - the keystore for agent operation
      Throws:
      AgentNotAvailableException - if the location specifies an invalid location
  • Method Details

    • getState

      public StartStopState 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

      protected KeyStore 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

      public static void main(String[] args)
      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