java.lang.Object

com.sshtools.j2ssh.transport.Service

com.sshtools.j2ssh.authentication.AuthenticationProtocolClient

public class AuthenticationProtocolClient extends Service

Version:: $Revision: 1.27 $
Author:: $author$

Field Summary

Fields inherited from class com.sshtools.j2ssh.transport.Service
ACCEPTING_SERVICE, messageStore, REQUESTING_SERVICE, startMode, state, transport
Constructor Summary

Constructors

Constructor

Description

AuthenticationProtocolClient()

Creates a new AuthenticationProtocolClient object.
Method Summary

Modifier and Type

Method

Description

void

addEventListener(AuthenticationProtocolListener listener)

int

authenticate(SshAuthenticationClient auth, Service serviceToStart)

List

getAvailableAuths(String username, String serviceName)

String

getBannerMessage(int timeout)

byte[]

getSessionIdentifier()

protected void

onServiceAccept()

Called when the service is accepted by the remote server.

protected void

onServiceInit(int startMode)

Called when the service is intialized.

protected void

onServiceRequest()

protected void

onStart()

Called when the service is started.

void

readAuthenticationState()

SshMessage

readMessage(int messageId)

SshMessage

readMessage(int[] messageId)

void

registerMessage(Class cls, int messageId)

void

sendMessage(SshMessage msg)

Methods inherited from class com.sshtools.j2ssh.transport.Service
getServiceName, getState, init, sendServiceAccept, start, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- AuthenticationProtocolClient
  
  public AuthenticationProtocolClient()
  
  Creates a new AuthenticationProtocolClient object.
Method Details
- onServiceAccept
  
  protected void onServiceAccept() throws IOException
  
  Description copied from class: Service
  
  Called when the service is accepted by the remote server.
  
  Specified by:
  
  onServiceAccept in class Service
  
  Throws:
  
  IOException
- onStart
  
  protected void onStart()
  
  Description copied from class: Service
  
  Called when the service is started.
  
  Specified by:
  
  onStart in class Service
- onServiceInit
  
  protected void onServiceInit(int startMode) throws IOException
  
  Description copied from class: Service
  
  Called when the service is intialized.
  
  Specified by:
  
  onServiceInit in class Service
  
  Parameters:
  
  startMode -
  
  Throws:
  
  IOException
  
  IOException
- onServiceRequest
  
  protected void onServiceRequest() throws IOException
  
  Specified by:
  
  onServiceRequest in class Service
  
  Throws:
  
  IOException
  
  IOException
- addEventListener
  
  public void addEventListener(AuthenticationProtocolListener listener)
  
  Parameters:
  
  listener -
- getAvailableAuths
  
  public List getAvailableAuths(String username, String serviceName) throws IOException
  
  Parameters:
  
  username -
  
  serviceName -
  
  Returns:
  
  Throws:
  
  IOException
  
  SshException
- authenticate
  
  public int authenticate(SshAuthenticationClient auth, Service serviceToStart) throws IOException
  
  Parameters:
  
  auth -
  
  serviceToStart -
  
  Returns:
  
  Throws:
  
  IOException
  
  SshException
- sendMessage
  
  public void sendMessage(SshMessage msg) throws IOException
  
  Parameters:
  
  msg -
  
  Throws:
  
  IOException
- getSessionIdentifier
  
  public byte[] getSessionIdentifier()
  
  Returns:
- registerMessage
  
  public void registerMessage(Class cls, int messageId)
  
  Parameters:
  
  cls -
  
  messageId -
- readMessage
  
  public SshMessage readMessage(int messageId) throws TerminatedStateException, IOException
  
  Parameters:
  
  messageId -
  
  Returns:
  
  Throws:
  
  TerminatedStateException
  
  IOException
- readMessage
  
  public SshMessage readMessage(int[] messageId) throws TerminatedStateException, IOException
  
  Parameters:
  
  messageId -
  
  Returns:
  
  Throws:
  
  TerminatedStateException
  
  IOException
- readAuthenticationState
  
  public void readAuthenticationState() throws IOException, TerminatedStateException
  
  Throws:
  
  IOException
  
  TerminatedStateException
- getBannerMessage
  
  public String getBannerMessage(int timeout) throws IOException
  
  Parameters:
  
  timeout -
  
  Returns:
  
  Throws:
  
  IOException
  
  SshException

Class AuthenticationProtocolClient

Field Summary

Fields inherited from class com.sshtools.j2ssh.transport.Service

Constructor Summary

Method Summary

Methods inherited from class com.sshtools.j2ssh.transport.Service

Methods inherited from class java.lang.Object

Constructor Details

AuthenticationProtocolClient

Method Details

onServiceAccept

onStart

onServiceInit

onServiceRequest

addEventListener

getAvailableAuths

authenticate

sendMessage

getSessionIdentifier

registerMessage

readMessage

readMessage

readAuthenticationState

getBannerMessage