ParameterDefinition (formcycle: bom 8.6.0 API)

java.lang.Object
- de.xima.fc.security.pac4j.passthrough.ParameterDefinition

All Implemented Interfaces:

Serializable
```
public final class ParameterDefinition
extends Object
implements Serializable
```
Immutable mapping from a form request header or URL parameter to an Identity Provider login parameter.

Since:

8.6.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ParameterDefinition.Source
Supported sources in the initial form request.

Constructor Summary

Constructors
Constructor	Description
`ParameterDefinition(ParameterDefinition.Source source, String sourceName, String targetName)`	Creates a passthrough parameter definition, including when reading its JSON representation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`ParameterDefinition.Source`	`getSource()`	The part of the incoming form request to read.
`String`	`getSourceName()`	The incoming header or URL query parameter name.
`String`	`getTargetName()`	The login parameter name passed to the Identity Provider.
`int`	`hashCode()`
`String`	`toString()`

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

- Constructor Detail
  - ParameterDefinition
```
public ParameterDefinition(ParameterDefinition.Source source,
                           String sourceName,
                           String targetName)
```
    Creates a passthrough parameter definition, including when reading its JSON representation.
    
    Parameters:
    
    source - the request source
    
    sourceName - the incoming header or URL parameter name
    
    targetName - the parameter name sent to the identity provider
- Method Detail
  - getSource
```
public ParameterDefinition.Source getSource()
```
    The part of the incoming form request to read.
  - getSourceName
```
public String getSourceName()
```
    The incoming header or URL query parameter name.
  - getTargetName
```
public String getTargetName()
```
    The login parameter name passed to the Identity Provider.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object