AbstractAuthentication (adams-addons-pom 22.10.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.rest.dex.authentication.AbstractAuthentication

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

BasicAuthentication, NoAuthenticationRequired
```
public abstract class AbstractAuthentication
extends adams.core.option.AbstractOptionHandler
```
Ancestor for authentication schemes.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractAuthentication()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`authenticate(Map<String,String> params)`	Performs the authentication.
`protected String`	`check(Map<String,String> params)`	Hook method for checks.
`protected abstract String`	`doAuthenticate(Map<String,String> params)`	Performs the authentication.

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Constructor Detail
  - AbstractAuthentication
```
public AbstractAuthentication()
```
- Method Detail
  - check
```
protected String check(Map<String,String> params)
```
    Hook method for checks.
    
    Parameters:
    
    params - the parameters to check
    
    Returns:
    
    null if check passed, otherwise error message
  - doAuthenticate
```
protected abstract String doAuthenticate(Map<String,String> params)
```
    Performs the authentication.
    
    Parameters:
    
    params - the parameters to use use for authentication
    
    Returns:
    
    null if successfully authenticated, otherwise error message
  - authenticate
```
public String authenticate(Map<String,String> params)
```
    Performs the authentication.
    
    Parameters:
    
    params - the parameters to use use for authentication
    
    Returns:
    
    null if successfully authenticated, otherwise error message