RequestGeneratorInput (OpenSAML 4.x utility extensions - 2.1.0)

All Known Implementing Classes:

AbstractRequestGeneratorInput
```
public interface RequestGeneratorInput
```
Base interface for the input to a request generator.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default X509Credential`	`getOverrideSigningCredential()`	A request generator normally has a configured signature credential that is used to sign the request.
`String`	`getPeerEntityID()`	Returns the peer (IdP) entityID.
`String`	`getPreferredBinding()`	If the caller prefers a specific binding to use, this method should return that.
`String`	`getRelayState()`	Returns the relay state variable to use.

- Method Detail
  - getRelayState
```
String getRelayState()
```
    Returns the relay state variable to use.
    
    Returns:
    
    relay state
  - getPeerEntityID
```
String getPeerEntityID()
```
    Returns the peer (IdP) entityID.
    
    Returns:
    
    the entityID
  - getPreferredBinding
```
String getPreferredBinding()
```
    If the caller prefers a specific binding to use, this method should return that. Otherwise the request generator its own default.
    
    Returns:
    
    the preferred binding, or null if the generator default should apply
  - getOverrideSigningCredential
```
default X509Credential getOverrideSigningCredential()
```
    A request generator normally has a configured signature credential that is used to sign the request. If, for some reason, other credentials should be used to sign a particular request, this method may be implemented. The default returns null.
    
    Returns:
    
    signature credential that overrides the installed credentials