Apache Mina SSHD 2.15.0 · org.apache.sshd.client.auth.AbstractUserAuth

Modifier and Type	Field and Description
private boolean	cancellable
private ClientSession	clientSession
private final String	name
private String	service

Access	Constructor and Description
protected	AbstractUserAuth(String name)

Method Summary

Modifier and Type	Method and Description
public void	destroy() Implements org.apache.sshd.client.auth.UserAuth.destroy. Called to release any allocated resources
public ClientSession	getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.
public final String	getName() Implements org.apache.sshd.common.NamedResource.getName.
public String	getService()
public ClientSession	getSession() Implements org.apache.sshd.common.auth.UserAuthInstance.getSession.
public void	init(ClientSession The `ClientSession` session, String The requesting service name service) Implements org.apache.sshd.client.auth.UserAuth.init.
public boolean	isCancellable() Overrides default org.apache.sshd.client.auth.UserAuth.isCancellable. Tells whether the authentication protocol is cancellable currently.
public boolean	process(Buffer The `Buffer` to process - `null` if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required buffer) Implements org.apache.sshd.client.auth.UserAuth.process.
protected abstract boolean	processAuthDataRequest(ClientSession session, String service, Buffer buffer)
protected abstract boolean	sendAuthDataRequest(ClientSession session, String service)
protected void	setCancellable(boolean `true` if the protocol may be canceled in its current state; `false` if not cancellable) Sets whether the authentication protocol is currently cancellable.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

cancellable	back to summary
private boolean cancellable

clientSession	back to summary
private ClientSession clientSession

name	back to summary
private final String name

service	back to summary
private String service

AbstractUserAuth	back to summary
protected AbstractUserAuth(String name)

Method Detail

destroy	back to summary
public void destroy() Implements org.apache.sshd.client.auth.UserAuth.destroy. Doc from org.apache.sshd.client.auth.UserAuth.destroy. Called to release any allocated resources Annotations @Override

destroy

back to summary

public void destroy()

Implements org.apache.sshd.client.auth.UserAuth.destroy.

Doc from org.apache.sshd.client.auth.UserAuth.destroy.

Called to release any allocated resources

Annotations

@Override

getClientSession back to summary

getClientSession	back to summary
public ClientSession getClientSession() Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession. Returns:ClientSession Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession. The underlying `ClientSession` used Annotations @Override

public ClientSession getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

Returns:ClientSession

Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

The underlying ClientSession used

Annotations

@Override

getName	back to summary
public final String getName() Implements org.apache.sshd.common.NamedResource.getName. Returns:String Doc from org.apache.sshd.common.NamedResource.getName. The resource name Annotations @Override

getName

back to summary

public final String getName()

Implements org.apache.sshd.common.NamedResource.getName.

Returns:String

Doc from org.apache.sshd.common.NamedResource.getName.

The resource name

Annotations

@Override

getService	back to summary
public String getService()

getSession back to summary

getSession	back to summary
public ClientSession getSession() Implements org.apache.sshd.common.auth.UserAuthInstance.getSession. Returns:ClientSession Doc from org.apache.sshd.common.auth.UserAuthInstance.getSession. The current session for which the authentication is being tracked Note may be `null` if the instance has not been initialized yet Annotations @Override

public ClientSession getSession()

Implements org.apache.sshd.common.auth.UserAuthInstance.getSession.

Returns:ClientSession

Doc from org.apache.sshd.common.auth.UserAuthInstance.getSession.

The current session for which the authentication is being tracked

Note

may be null if the instance has not been initialized yet

Annotations

@Override

init back to summary

init	back to summary
public void init(ClientSession session, String service) throws Exception Implements org.apache.sshd.client.auth.UserAuth.init. Parameters session:ClientSession Doc from org.apache.sshd.client.auth.UserAuth.init. The `ClientSession` service:String Doc from org.apache.sshd.client.auth.UserAuth.init. The requesting service name Annotations @Override Exceptions Exception: Doc from org.apache.sshd.client.auth.UserAuth.init. If failed to initialize the mechanism

public void init(ClientSession session, String service) throws Exception

Implements org.apache.sshd.client.auth.UserAuth.init.

Parameters

session:ClientSession

Doc from org.apache.sshd.client.auth.UserAuth.init.

The ClientSession

service:String

Doc from org.apache.sshd.client.auth.UserAuth.init.

The requesting service name

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.sshd.client.auth.UserAuth.init.

If failed to initialize the mechanism

isCancellable back to summary

isCancellable	back to summary
public boolean isCancellable() Overrides default org.apache.sshd.client.auth.UserAuth.isCancellable. Doc from org.apache.sshd.client.auth.UserAuth.isCancellable. Tells whether the authentication protocol is cancellable currently. Returns:boolean `true` if the protocol can be canceled at its current state; `false` if not. Annotations @Override

public boolean isCancellable()

Overrides default org.apache.sshd.client.auth.UserAuth.isCancellable.

Doc from org.apache.sshd.client.auth.UserAuth.isCancellable.

Tells whether the authentication protocol is cancellable currently.

Returns:boolean

true if the protocol can be canceled at its current state; false if not.

Annotations

@Override

process back to summary

process	back to summary
public boolean process(Buffer buffer) throws Exception Implements org.apache.sshd.client.auth.UserAuth.process. Parameters buffer:Buffer Doc from org.apache.sshd.client.auth.UserAuth.process. The `Buffer` to process - `null` if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required Returns:boolean Doc from org.apache.sshd.client.auth.UserAuth.process. `true` if request handled - `false` if the next authentication mechanism should be used Annotations @Override Exceptions Exception: Doc from org.apache.sshd.client.auth.UserAuth.process. If failed to process the request

public boolean process(Buffer buffer) throws Exception

Implements org.apache.sshd.client.auth.UserAuth.process.

Parameters

buffer:Buffer

Doc from org.apache.sshd.client.auth.UserAuth.process.

The Buffer to process - null if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required

Returns:boolean

Doc from org.apache.sshd.client.auth.UserAuth.process.

true if request handled - false if the next authentication mechanism should be used

Annotations

@Override

Exceptions

Exception:

Doc from org.apache.sshd.client.auth.UserAuth.process.

If failed to process the request

processAuthDataRequest	back to summary
protected abstract boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception

sendAuthDataRequest	back to summary
protected abstract boolean sendAuthDataRequest(ClientSession session, String service) throws Exception

setCancellable back to summary

setCancellable	back to summary
protected void setCancellable(boolean cancellable) Sets whether the authentication protocol is currently cancellable. Parameters cancellable:boolean `true` if the protocol may be canceled in its current state; `false` if not

protected void setCancellable(boolean cancellable)

Sets whether the authentication protocol is currently cancellable.

Parameters

cancellable:boolean: true if the protocol may be canceled in its current state; false if not

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public abstract Class AbstractUserAuth

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail