com.jscape.inet.ssh.authentication
Interface AuthenticationRequest

All Superinterfaces:

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

All Known Implementing Classes:

AbstractAuthenticationRequest, AbstractComplexRequest, SuccessiveAttemptRequest, UserDataBasedRequest

public interface AuthenticationRequest
extends Task, java.lang.Cloneable

Represents user authentication request abstraction.

Version:

1.0

Author:

Alex

See Also:

Source code

Method Summary

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 client) Sets underlayed SSH transport session.
void	setUser(User user) Sets target user.

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

cancel, isDone, isStarted

Methods inherited from interface java.lang.Runnable

run

Method Detail

getUser

User getUser()

Returns user to be authenticated.

Returns:

user to be authenticated

setUser

void setUser(User user)

Sets target user.

Parameters:

user - user to be authenticated

getServiceName

java.lang.String getServiceName()

Returns target SSH service name.

Returns:

target SSH service name

setServiceName

void setServiceName(java.lang.String name)

Sets target SSH service name.

Parameters:

name - target SSH service name

getTransportSession

TransportClient getTransportSession()

Returns underlayed SSH transport session.

Returns:

underlayed SSH transport session

setTransportSession

void setTransportSession(TransportClient client)

Sets underlayed SSH transport session.

Parameters:

client - underlayed SSH transport session

isSuccessful

boolean isSuccessful()

Checks if request was successful.

Returns:

true if request was successful; false otherwise

isValid

boolean isValid()

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

Returns:

true if request is ready for execution; false otherwise

getBanner

java.lang.String getBanner()

Returns server authentication banner if any.

Returns:

server authentication banner

getError

java.lang.Throwable getError()

clone

java.lang.Object clone()

Clones request instance.

Returns:

request copy