UsernameTemplateMapper.Target (Keycloak Docs Distribution 21.1.1 API)

java.lang.Object
- java.lang.Enum<UsernameTemplateMapper.Target>
- - org.keycloak.broker.saml.mappers.UsernameTemplateMapper.Target

All Implemented Interfaces:

Serializable, Comparable<UsernameTemplateMapper.Target>

Enclosing class:

UsernameTemplateMapper
```
public static enum UsernameTemplateMapper.Target
extends Enum<UsernameTemplateMapper.Target>
```

Enum Constant Summary

Enum Constants
Enum Constant Description

BROKER_ID

BROKER_USERNAME

LOCAL

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract void`	`set(BrokeredIdentityContext context, String value)`
`static UsernameTemplateMapper.Target`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static UsernameTemplateMapper.Target[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - LOCAL
```
public static final UsernameTemplateMapper.Target LOCAL
```
  - BROKER_ID
```
public static final UsernameTemplateMapper.Target BROKER_ID
```
  - BROKER_USERNAME
```
public static final UsernameTemplateMapper.Target BROKER_USERNAME
```
- Method Detail
  - values
```
public static UsernameTemplateMapper.Target[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (UsernameTemplateMapper.Target c : UsernameTemplateMapper.Target.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UsernameTemplateMapper.Target valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - set
```
public abstract void set(BrokeredIdentityContext context,
                         String value)
```