AuthenticationCompleteCallback (WildFly Elytron Parent 2.1.0.Final API)

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

All Implemented Interfaces:

Serializable, Callback, ExtendedCallback
```
public final class AuthenticationCompleteCallback
extends Object
implements ExtendedCallback, Serializable
```
An optional callback indicating the success or failure of the authentication operation. When this callback is received, the callback handler may free any resources that were required to perform the authentication. This callback should always be sent to the callback handler last.

Author:

David M. Lloyd

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static AuthenticationCompleteCallback`	`FAILED`
`private static long`	`serialVersionUID`
`static AuthenticationCompleteCallback`	`SUCCEEDED`
`private boolean`	`success`

Constructor Summary

Constructors
Modifier Constructor Description

private AuthenticationCompleteCallback(boolean success)
Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`failed()`	Determine whether authentication failed.
`(package private) Object`	`readResolve()`	Replace the deserialized instance with the sppropriate singleton instance.
`boolean`	`succeeded()`	Determine whether authentication succeeded.

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
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - SUCCEEDED
```
public static final AuthenticationCompleteCallback SUCCEEDED
```
  - FAILED
```
public static final AuthenticationCompleteCallback FAILED
```
  - success
```
private final boolean success
```
- Constructor Detail
  - AuthenticationCompleteCallback
```
private AuthenticationCompleteCallback(boolean success)
```
    Construct a new instance.
    
    Parameters:
    
    success - true if the authentication was successful, false otherwise
- Method Detail
  - succeeded
```
public boolean succeeded()
```
    Determine whether authentication succeeded. Always returns the opposite of failed().
    
    Returns:
    
    true if authentication succeeded, false otherwise
  - failed
```
public boolean failed()
```
    Determine whether authentication failed. Always returns the opposite of succeeded().
    
    Returns:
    
    true if the authentication failed, false otherwise
  - readResolve
```
Object readResolve()
```
    Replace the deserialized instance with the sppropriate singleton instance.
    
    Returns:
    
    The singleton instance.