com.sshtools.j2ssh.agent

Class SshAgentSocketListener


public class SshAgentSocketListener
extends java.lang.Object

Version:
$Revision: 1.20 $
Author:
$author$

Constructor Summary

SshAgentSocketListener(String location, KeyStore keystore)
Creates a new SshAgentSocketListener object.

Method Summary

static int
configureNewLocation()
Configure a new random port for the agent listener.
protected KeyStore
getKeystore()
Gets the underlying keystore for this agent listener.
int
getPort()
The current port of the agent listener
StartStopState
getState()
Get the agent listeners state
static void
main(String[] args)
The main entry point for the application.
void
start()
Starts the agent listener thread
void
stop()
Stops the agent listener

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

configureNewLocation

public static int configureNewLocation()
Configure a new random port for the agent listener.
Returns:
the random port for this agent.

getKeystore

protected KeyStore getKeystore()
Gets the underlying keystore for this agent listener.
Returns:
the keystore

getPort

public int getPort()
The current port of the agent listener
Returns:
the integer port

getState

public StartStopState getState()
Get the agent listeners state
Returns:
the current state of the listener

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

start

public void start()
Starts the agent listener thread

stop

public void stop()
Stops the agent listener

Copyright © 2002-2003 Lee David Painter & Contributors. All Rights Reserved.