com.sshtools.j2ssh.agent
Class AgentAuthenticationClient

java.lang.Object
  extended bycom.sshtools.j2ssh.authentication.SshAuthenticationClient
      extended bycom.sshtools.j2ssh.agent.AgentAuthenticationClient

public class AgentAuthenticationClient
extends SshAuthenticationClient

Provides an application with an authentication mechanism that links to the sshtools agent; the agent stores private keys and can hash and sign data for the public key authentication request.


Field Summary
protected  SshAgentClient agent
          DOCUMENT ME!
 
Constructor Summary
AgentAuthenticationClient()
          Creates a new AgentAuthenticationClient object.
 
Method Summary
 boolean acceptsKey(AuthenticationProtocolClient authentication, java.lang.String username, java.lang.String serviceToStart, SshPublicKey key)
          DOCUMENT ME!
 void authenticate(AuthenticationProtocolClient authentication, java.lang.String serviceToStart)
          DOCUMENT ME!
 boolean canAuthenticate()
          DOCUMENT ME!
 java.lang.String getMethodName()
          DOCUMENT ME!
 java.util.Properties getPersistableProperties()
          DOCUMENT ME!
 void setAgent(SshAgentClient agent)
           
 void setPersistableProperties(java.util.Properties properties)
          DOCUMENT ME!
 boolean showAuthenticationDialog(java.awt.Component parent)
          DOCUMENT ME!
 
Methods inherited from class com.sshtools.j2ssh.authentication.SshAuthenticationClient
canPrompt, getAuthenticationPrompt, getUsername, setAuthenticationPrompt, setUsername
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

agent

protected SshAgentClient agent
DOCUMENT ME!

Constructor Detail

AgentAuthenticationClient

public AgentAuthenticationClient()
Creates a new AgentAuthenticationClient object.

Method Detail

setAgent

public void setAgent(SshAgentClient agent)

getMethodName

public java.lang.String getMethodName()
DOCUMENT ME!

Specified by:
getMethodName in class SshAuthenticationClient
Returns:
DOCUMENT ME!

acceptsKey

public boolean acceptsKey(AuthenticationProtocolClient authentication,
                          java.lang.String username,
                          java.lang.String serviceToStart,
                          SshPublicKey key)
                   throws java.io.IOException
DOCUMENT ME!

Parameters:
authentication - DOCUMENT ME!
username - DOCUMENT ME!
serviceToStart - DOCUMENT ME!
key - DOCUMENT ME!
Returns:
DOCUMENT ME!
Throws:
java.io.IOException - DOCUMENT ME!

authenticate

public void authenticate(AuthenticationProtocolClient authentication,
                         java.lang.String serviceToStart)
                  throws java.io.IOException,
                         TerminatedStateException
DOCUMENT ME!

Specified by:
authenticate in class SshAuthenticationClient
Parameters:
authentication - DOCUMENT ME!
serviceToStart - DOCUMENT ME!
Throws:
java.io.IOException - DOCUMENT ME!
TerminatedStateException - DOCUMENT ME!
AuthenticationProtocolException - DOCUMENT ME!

showAuthenticationDialog

public boolean showAuthenticationDialog(java.awt.Component parent)
DOCUMENT ME!

Parameters:
parent - DOCUMENT ME!
Returns:
DOCUMENT ME!

getPersistableProperties

public java.util.Properties getPersistableProperties()
DOCUMENT ME!

Specified by:
getPersistableProperties in class SshAuthenticationClient
Returns:
DOCUMENT ME!

setPersistableProperties

public void setPersistableProperties(java.util.Properties properties)
DOCUMENT ME!

Specified by:
setPersistableProperties in class SshAuthenticationClient
Parameters:
properties - DOCUMENT ME!

canAuthenticate

public boolean canAuthenticate()
DOCUMENT ME!

Specified by:
canAuthenticate in class SshAuthenticationClient
Returns:
DOCUMENT ME!