Package org.pac4j.saml.metadata

Interface SAML2MetadataGenerator

All Known Implementing Classes:
BaseSAML2MetadataGenerator, SAML2FileSystemMetadataGenerator, SAML2HttpUrlMetadataGenerator, SAML2InMemoryMetadataGenerator, SAML2JdbcMetadataGenerator, SAML2MongoMetadataGenerator, SAML2S3MetadataGenerator
public interface SAML2MetadataGenerator
Builds metadata and the relevant resolvers.
Author:
Misagh Moayyed

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opensaml.saml.saml2.metadata.EntityDescriptor
    buildEntityDescriptor()
    buildEntityDescriptor.
    org.opensaml.saml.metadata.resolver.MetadataResolver
    buildMetadataResolver()
    buildMetadataResolver.
    default boolean
    canMerge()
     
    String
    getMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor)
    getMetadata.
    boolean
    merge(SAML2Configuration configuration)
    Merge two entities together and store metadata.
    boolean
    storeMetadata(String metadata, boolean force)
    storeMetadata.

  • Method Details

    • buildMetadataResolver

      org.opensaml.saml.metadata.resolver.MetadataResolver buildMetadataResolver() throws Exception

      buildMetadataResolver.

      Returns:
      a MetadataResolver object
      Throws:
      Exception - if any.

    • getMetadata

      String getMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor) throws Exception

      getMetadata.

      Parameters:
      entityDescriptor - a EntityDescriptor object
      Returns:
      a String object
      Throws:
      Exception - if any.

    • buildEntityDescriptor

      org.opensaml.saml.saml2.metadata.EntityDescriptor buildEntityDescriptor()

      buildEntityDescriptor.

      Returns:
      a EntityDescriptor object

    • storeMetadata

      boolean storeMetadata(String metadata, boolean force) throws Exception

      storeMetadata.

      Parameters:
      metadata - a String object
      force - a boolean
      Returns:
      a boolean
      Throws:
      Exception - if any.

    • merge

      boolean merge(SAML2Configuration configuration) throws Exception
      Merge two entities together and store metadata.
      Returns:
      true if the merge was successful and saved. false if no metadata was changed/stored.
      Throws:
      Exception - the exception

    • canMerge

      default boolean canMerge()