MechanismInformationCallback (WildFly Elytron Parent 2.1.0.Final API)

java.lang.Object
- org.wildfly.security.auth.callback.MechanismInformationCallback

All Implemented Interfaces:

Callback, ExtendedCallback
```
public class MechanismInformationCallback
extends Object
implements ExtendedCallback
```
A Callback to pass the information about the current mechanism to the CallbackHandler. As an informational Callback it is optional for the CallbackHandler to handle this.

Author:

Darran Lofthouse

Field Summary

Fields
Modifier and Type Field Description

private MechanismInformation mechanismInformation

Constructor Summary

Constructors
Constructor Description

MechanismInformationCallback(MechanismInformation mechanismInformation)
Construct a new instance with the appropriate mechanism information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MechanismInformation`	`getMechanismInformation()`	Get the type of the mechanism information for the current authentication attempt.

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

Methods inherited from interface org.wildfly.security.auth.callback.ExtendedCallback
isOptional, needsInformation

- Field Detail
  - mechanismInformation
```
private final MechanismInformation mechanismInformation
```
- Constructor Detail
  - MechanismInformationCallback
```
public MechanismInformationCallback(MechanismInformation mechanismInformation)
```
    Construct a new instance with the appropriate mechanism information.
    
    Parameters:
    
    mechanismInformation - the mechanism information for the current authentication attempt.
- Method Detail
  - getMechanismInformation
```
public MechanismInformation getMechanismInformation()
```
    Get the type of the mechanism information for the current authentication attempt.
    
    Returns:
    
    the type of the mechanism for the current authentication.