Interface NameIDGeneratorFactory

All Known Implementing Classes:
DefaultNameIDGeneratorFactory

public interface NameIDGeneratorFactory
A NameIDGenerator is assigned each Saml2AuthnRequestAuthenticationToken when an AuthnRequest is being processed. When the user has been authenticated and an Assertion is created this generator will be used to generate a NameID.
Author:
Martin Lindström
  • Method Summary

    Modifier and Type
    Method
    Description
    getNameIDGenerator(org.opensaml.saml.saml2.core.AuthnRequest authnRequest, org.opensaml.saml.saml2.metadata.EntityDescriptor peerMetadata)
    Given the requirements for a NameID in the AuthnRequest and EntityDescriptor along with the IdP policy the method returns a NameIDGenerator.
    Gets a list of the NameIDFormats that are supported by the factory.
  • Method Details

    • getNameIDGenerator

      NameIDGenerator getNameIDGenerator(org.opensaml.saml.saml2.core.AuthnRequest authnRequest, org.opensaml.saml.saml2.metadata.EntityDescriptor peerMetadata) throws Saml2ErrorStatusException, UnrecoverableSaml2IdpException
      Given the requirements for a NameID in the AuthnRequest and EntityDescriptor along with the IdP policy the method returns a NameIDGenerator.
      Parameters:
      authnRequest - the AuthnRequest
      peerMetadata - the peer metadata
      Returns:
      a NameIDGenerator
      Throws:
      Saml2ErrorStatusException - for errors that should be reported back to the Service Provider
      UnrecoverableSaml2IdpException - for non-recoverable errors
    • getSupportedFormats

      List<String> getSupportedFormats()
      Gets a list of the NameIDFormats that are supported by the factory. The most preferred should be added first.
      Returns:
      a list of the supported formats