com.sshtools.j2ssh.authentication
Class AuthenticationProtocolState

java.lang.Object
  |
  +--com.sshtools.j2ssh.authentication.AuthenticationProtocolState

public class AuthenticationProtocolState
extends java.lang.Object

Holds the state of the authentication protocol.

Version:
1.0
Author:
Lee David Painter ( lee@sshtools.com )

Field Summary
static int COMPLETE
          Description of the Field
static int FAILED
          Description of the Field
static int INITIALIZING
          Description of the Field
static int PARTIAL
          Description of the Field
static int READY
          Description of the Field
 
Constructor Summary
AuthenticationProtocolState()
           Constructor for the state object.
 
Method Summary
 int getState()
           Gets the current state.
 void updateState(int state)
           Update to the state supplied.
 int waitForState(int waitForState)
           Synchronized method to wait for a state update.
 int waitForStateUpdate()
          Description of the Method
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INITIALIZING

public static final int INITIALIZING
Description of the Field

See Also:
Constant Field Values

READY

public static final int READY
Description of the Field

See Also:
Constant Field Values

FAILED

public static final int FAILED
Description of the Field

See Also:
Constant Field Values

PARTIAL

public static final int PARTIAL
Description of the Field

See Also:
Constant Field Values

COMPLETE

public static final int COMPLETE
Description of the Field

See Also:
Constant Field Values
Constructor Detail

AuthenticationProtocolState

public AuthenticationProtocolState()

Constructor for the state object.

Method Detail

getState

public int getState()

Gets the current state.

Returns:

updateState

public void updateState(int state)
                 throws InvalidStateException

Update to the state supplied.

Parameters:
state - The new state
Throws:
InvalidStateException - Description of the Exception

waitForState

public int waitForState(int waitForState)

Synchronized method to wait for a state update.

Parameters:
waitForState - Description of the Parameter
Returns:
The new state

waitForStateUpdate

public int waitForStateUpdate()
Description of the Method

Returns:
Description of the Return Value


Copyright © 2002 Sshtools.com. All Rights Reserved.