AuthenticationHandler

Type Parameters:

ParameterType - defining the parameter type for setParams(Object)

TokenType - defining the token type for getToken()

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

HttpClientConnector.HttpAuthenticationHandler

All Known Implementing Classes:

AbstractAuthenticationHandler, BasicAuthentication, GssApiAuthentication, HttpClientConnector.HttpBasicAuthentication, HttpClientConnector.NegotiateAuthentication, Socks5ClientConnector.SocksBasicAuthentication, Socks5ClientConnector.SocksGssApiAuthentication
```
public interface AuthenticationHandler<ParameterType,TokenType>
extends java.io.Closeable
```
An AuthenticationHandler encapsulates a possibly multi-step authentication protocol. Intended usage:
```
 setParams(something);
 start();
 sendToken(getToken());
 while (!isDone()) {
        setParams(receiveMessageAndExtractParams());
        process();
        Object t = getToken();
        if (t != null) {
                sendToken(t);
        }
 }
 
```
An AuthenticationHandler may be stateful and therefore is a Closeable.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`
`TokenType`	`getToken()`	Retrieves the last token generated.
`boolean`	`isDone()`	Tells whether is authentication mechanism is done (successfully or unsuccessfully).
`void`	`process()`	Produces the next authentication token, if any.
`void`	`setParams(ParameterType input)`	Sets the parameters for the next token generation via `start()` or `process()`.
`void`	`start()`	Produces the initial authentication token that can be then retrieved via `getToken()`.

- Method Detail
  - start
```
void start()
    throws java.lang.Exception
```
    Produces the initial authentication token that can be then retrieved via getToken().
    
    Throws:
    
    java.lang.Exception - if an error occurs
  - process
```
void process()
      throws java.lang.Exception
```
    Produces the next authentication token, if any.
    
    Throws:
    
    java.lang.Exception - if an error occurs
  - setParams
```
void setParams(ParameterType input)
```
    Sets the parameters for the next token generation via start() or process().
    
    Parameters:
    
    input - to set, may be null
  - getToken
```
TokenType getToken()
            throws java.lang.Exception
```
    Retrieves the last token generated.
    
    Returns:
    
    the token, or null if there is none
    
    Throws:
    
    java.lang.Exception - if an error occurs
  - isDone
```
boolean isDone()
```
    Tells whether is authentication mechanism is done (successfully or unsuccessfully).
    
    Returns:
    
    whether this authentication is done
  - close
```
void close()
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable