Package org.apache.sshd.client.auth
Class AbstractUserAuth
- java.lang.Object
-
- org.apache.sshd.common.util.logging.AbstractLoggingBean
-
- org.apache.sshd.client.auth.AbstractUserAuth
-
- All Implemented Interfaces:
UserAuth
,ClientSessionHolder
,UserAuthInstance<ClientSession>
,NamedResource
- Direct Known Subclasses:
UserAuthHostBased
,UserAuthKeyboardInteractive
,UserAuthPassword
,UserAuthPublicKey
public abstract class AbstractUserAuth extends AbstractLoggingBean implements UserAuth
- Author:
- Apache MINA SSHD Project
-
-
Field Summary
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Fields inherited from interface org.apache.sshd.common.NamedResource
BY_NAME_COMPARATOR, NAME_EXTRACTOR
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractUserAuth(String name)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
destroy()
Called to release any allocated resourcesClientSession
getClientSession()
String
getName()
String
getService()
ClientSession
getSession()
void
init(ClientSession session, String service)
boolean
process(Buffer buffer)
protected abstract boolean
processAuthDataRequest(ClientSession session, String service, Buffer buffer)
protected abstract boolean
sendAuthDataRequest(ClientSession session, String service)
String
toString()
-
Methods inherited from class 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
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.sshd.client.auth.UserAuth
signalAuthMethodFailure, signalAuthMethodSuccess
-
-
-
-
Constructor Detail
-
AbstractUserAuth
protected AbstractUserAuth(String name)
-
-
Method Detail
-
getClientSession
public ClientSession getClientSession()
- Specified by:
getClientSession
in interfaceClientSessionHolder
- Returns:
- The underlying
ClientSession
used
-
getSession
public ClientSession getSession()
- Specified by:
getSession
in interfaceUserAuthInstance<ClientSession>
-
getName
public final String getName()
- Specified by:
getName
in interfaceNamedResource
-
getService
public String getService()
-
init
public void init(ClientSession session, String service) throws Exception
- Specified by:
init
in interfaceUserAuth
- Parameters:
session
- TheClientSession
service
- The requesting service name- Throws:
Exception
- If failed to initialize the mechanism
-
process
public boolean process(Buffer buffer) throws Exception
- Specified by:
process
in interfaceUserAuth
- Parameters:
buffer
- TheBuffer
to process -null
if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required- Returns:
true
if request handled -false
if the next authentication mechanism should be used- Throws:
Exception
- If failed to process the request
-
sendAuthDataRequest
protected abstract boolean sendAuthDataRequest(ClientSession session, String service) throws Exception
- Throws:
Exception
-
processAuthDataRequest
protected abstract boolean processAuthDataRequest(ClientSession session, String service, Buffer buffer) throws Exception
- Throws:
Exception
-
destroy
public void destroy()
Description copied from interface:UserAuth
Called to release any allocated resources
-
-