AbstractAuthnRequestGenerator (OpenSAML 4.x utility extensions - 2.1.0)

java.lang.Object
- se.litsec.opensaml.saml2.common.request.AbstractRequestGenerator<AuthnRequest,I>
- - se.litsec.opensaml.saml2.common.request.AbstractAuthnRequestGenerator<I>

Type Parameters:

I - the type of the input required by this generator

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, AuthnRequestGenerator<I>, RequestGenerator<AuthnRequest,I>
```
public abstract class AbstractAuthnRequestGenerator<I extends RequestGeneratorInput>
extends AbstractRequestGenerator<AuthnRequest,I>
implements AuthnRequestGenerator<I>
```
Abstract base class for generating AuthnRequest messages.

Author:

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

Field Summary

Fields
Modifier and Type	Field	Description
`protected static Predicate<SingleSignOnService>`	`hasSupportedBinding`	Function for checking if a metadata SingleSignOnService element has a binding that we support.
`protected static Predicate<String>`	`isValidBinding`	Function for checking if a binding is valid.

Constructor Summary

Constructors
Constructor Description

AbstractAuthnRequestGenerator(String entityID)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected SingleSignOnService`	`getSingleSignOnService(EntityDescriptor idp, RequestGeneratorInput input)`	Returns the `SingleSignOnService` element to use when sending the request to the IdP.

Methods inherited from class se.litsec.opensaml.saml2.common.request.AbstractRequestGenerator
afterPropertiesSet, buildRequestHttpObject, buildRequestHttpObject, buildRequestHttpObject, generateID, getDefaultBinding, getEntityID, getName, getPeerMetadata, getRandomizer, getSigningCredentials, setName, setSigningCredentials

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

Methods inherited from interface se.litsec.opensaml.saml2.common.request.RequestGenerator
generateRequest, getEntityID, getName

- Field Detail
  - isValidBinding
```
protected static Predicate<String> isValidBinding
```
    Function for checking if a binding is valid.
  - hasSupportedBinding
```
protected static Predicate<SingleSignOnService> hasSupportedBinding
```
    Function for checking if a metadata SingleSignOnService element has a binding that we support.
- Constructor Detail
  - AbstractAuthnRequestGenerator
```
public AbstractAuthnRequestGenerator(String entityID)
```
    Constructor.
    
    Parameters:
    
    entityID - the entityID
- Method Detail
  - getSingleSignOnService
```
protected SingleSignOnService getSingleSignOnService(EntityDescriptor idp,
                                                     RequestGeneratorInput input)
                                              throws RequestGenerationException
```
    Returns the SingleSignOnService element to use when sending the request to the IdP. The preferred binding will be searched for first, and if this is not found, another binding the we support will be used.
    
    Parameters:
    
    idp - the IdP metadata
    
    input - input for generating
    
    Returns:
    
    a SingleSignOnService object
    
    Throws:
    
    RequestGenerationException - if not valid endpoint can be found