AvailableRealmsCallback (WildFly Elytron Parent 2.1.0.Final API)

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

All Implemented Interfaces:

Callback, ExtendedCallback
```
public final class AvailableRealmsCallback
extends Object
implements ExtendedCallback
```
A callback used to query a server participant for the names of realms that it is prepared to offer. Note that the authentication mechanism realm concept is not directly related to the Elytron security realm concept.

Author:

David M. Lloyd

Field Summary

Fields
Modifier and Type Field Description

private String[] realmNames

Constructor Summary

Constructors
Constructor Description

AvailableRealmsCallback()
Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String[]`	`getRealmNames()`	Get the array of realm names that was set.
`boolean`	`isOptional()`	Determine if this callback is optional.
`boolean`	`needsInformation()`	Determine if this callback is requesting information.
`void`	`setRealmNames(String... realmNames)`	Set the realm names.

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

- Field Detail
  - realmNames
```
private String[] realmNames
```
- Constructor Detail
  - AvailableRealmsCallback
```
public AvailableRealmsCallback()
```
    Construct a new instance.
- Method Detail
  - getRealmNames
```
public String[] getRealmNames()
```
    Get the array of realm names that was set.
    
    Returns:
    
    the realm names array
  - setRealmNames
```
public void setRealmNames(String... realmNames)
```
    Set the realm names. None of the realm names may be null. The array is not copied, so care must be taken to avoid modifying the realm array after it is set.
    
    Parameters:
    
    realmNames - the realm names (may not be null, may not contain null)
  - isOptional
```
public boolean isOptional()
```
    Description copied from interface: ExtendedCallback
    
    Determine if this callback is optional.
    
    Specified by:
    
    isOptional in interface ExtendedCallback
    
    Returns:
    
    true if the callback is optional, false if it is mandatory
  - needsInformation
```
public boolean needsInformation()
```
    Description copied from interface: ExtendedCallback
    
    Determine if this callback is requesting information.
    
    Specified by:
    
    needsInformation in interface ExtendedCallback
    
    Returns:
    
    true if the callback is requesting information, false if it is only providing information