com.jscape.inet.ssh.authentication.requests
Class AbstractAuthenticationRequest

java.lang.Object
  com.jscape.util.task.AbstractTask
      com.jscape.inet.ssh.authentication.requests.AbstractAuthenticationRequest

All Implemented Interfaces:

AuthenticationRequest, Task, java.lang.Cloneable, java.lang.Runnable

Direct Known Subclasses:

AbstractComplexRequest

public abstract class AbstractAuthenticationRequest
extends com.jscape.util.task.AbstractTask
implements AuthenticationRequest

Common authentication request implementation.

Version:

1.0

Author:

Alex

See Also:

Source code

Nested Class Summary

Nested classes/interfaces inherited from class com.jscape.util.task.AbstractTask

com.jscape.util.task.AbstractTask.Listener, com.jscape.util.task.AbstractTask.TaskCanceledException

Method Summary

abstract java.lang.Object	clone() Clones request instance.
java.lang.String	getBanner() Returns server authentication banner if any.
java.lang.Throwable	getError()
java.lang.String	getServiceName() Returns target SSH service name.
TransportClient	getTransportSession() Returns underlayed SSH transport session.
User	getUser() Returns user to be authenticated.
boolean	isSuccessful() Checks if request was successful.
boolean	isValid() Checks if all needed request parameters are set and request is ready for execution.
void	setServiceName(java.lang.String name) Sets target SSH service name.
void	setTransportSession(TransportClient session) Sets underlayed SSH transport session.
void	setUser(User user) Sets target user.

Methods inherited from class com.jscape.util.task.AbstractTask

cancel, getListener, getName, isCanceled, isDone, isStarted, resetCancel, run, setListener, waitUntilDone, waitUntilDone, waitUntilDoneOrCanceled, waitUntilStarted, waitUntilStarted

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.jscape.util.task.Task

cancel, isDone, isStarted

Methods inherited from interface java.lang.Runnable

run

Method Detail

getUser

public User getUser()

Description copied from interface: AuthenticationRequest

Returns user to be authenticated.

Specified by:

getUser in interface AuthenticationRequest

Returns:

user to be authenticated

setUser

public void setUser(User user)

Description copied from interface: AuthenticationRequest

Sets target user.

Specified by:

setUser in interface AuthenticationRequest

Parameters:

user - user to be authenticated

getServiceName

public java.lang.String getServiceName()

Description copied from interface: AuthenticationRequest

Returns target SSH service name.

Specified by:

getServiceName in interface AuthenticationRequest

Returns:

target SSH service name

setServiceName

public void setServiceName(java.lang.String name)

Description copied from interface: AuthenticationRequest

Sets target SSH service name.

Specified by:

setServiceName in interface AuthenticationRequest

Parameters:

name - target SSH service name

getTransportSession

public TransportClient getTransportSession()

Description copied from interface: AuthenticationRequest

Returns underlayed SSH transport session.

Specified by:

getTransportSession in interface AuthenticationRequest

Returns:

underlayed SSH transport session

setTransportSession

public void setTransportSession(TransportClient session)

Description copied from interface: AuthenticationRequest

Sets underlayed SSH transport session.

Specified by:

setTransportSession in interface AuthenticationRequest

Parameters:

session - underlayed SSH transport session

isSuccessful

public boolean isSuccessful()

Description copied from interface: AuthenticationRequest

Checks if request was successful.

Specified by:

isSuccessful in interface AuthenticationRequest

Returns:

true if request was successful; false otherwise

isValid

public boolean isValid()

Description copied from interface: AuthenticationRequest

Checks if all needed request parameters are set and request is ready for execution.

Specified by:

isValid in interface AuthenticationRequest

Returns:

true if request is ready for execution; false otherwise

getBanner

public java.lang.String getBanner()

Description copied from interface: AuthenticationRequest

Returns server authentication banner if any.

Specified by:

getBanner in interface AuthenticationRequest

Returns:

server authentication banner

getError

public java.lang.Throwable getError()

Specified by:

getError in interface AuthenticationRequest

clone

public abstract java.lang.Object clone()

Description copied from interface: AuthenticationRequest

Clones request instance.

Specified by:

clone in interface AuthenticationRequest

Overrides:

clone in class java.lang.Object

Returns:

request copy