Package org.pac4j.saml.metadata
Class BaseSAML2MetadataGenerator
java.lang.Object
org.pac4j.saml.metadata.BaseSAML2MetadataGenerator
- All Implemented Interfaces:
SAML2MetadataGenerator
- Direct Known Subclasses:
SAML2FileSystemMetadataGenerator
,SAML2HttpUrlMetadataGenerator
,SAML2JdbcMetadataGenerator
,SAML2MongoMetadataGenerator
Generates metadata object with standard values and overridden user defined values.
- Since:
- 4.0.1
- Author:
- Misagh Moayyed
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected boolean
protected final org.opensaml.core.xml.XMLObjectBuilderFactory
protected CredentialProvider
protected int
protected org.opensaml.xmlsec.SignatureSigningConfiguration
protected String
protected final org.opensaml.xmlsec.algorithm.AlgorithmRegistry
protected final org.slf4j.Logger
protected final org.opensaml.core.xml.io.MarshallerFactory
protected String
protected List<SAML2ServiceProviderRequestedAttribute>
protected String
protected String
protected boolean
protected String
protected boolean
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionorg.opensaml.saml.saml2.metadata.EntityDescriptor
buildEntityDescriptor.org.opensaml.saml.metadata.resolver.MetadataResolver
buildMetadataResolver.protected Collection<org.opensaml.saml.saml2.metadata.NameIDFormat>
buildNameIDFormat.protected org.opensaml.saml.saml2.metadata.SPSSODescriptor
buildSPSSODescriptor.protected abstract org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver
createMetadataResolver.protected org.opensaml.saml.saml2.metadata.Extensions
generateMetadataExtensions.protected org.opensaml.saml.saml2.metadata.AssertionConsumerService
getAssertionConsumerService
(String binding, int index, boolean isDefault) getAssertionConsumerService.Getter for the fieldblackListedSignatureSigningAlgorithms
.protected org.opensaml.saml.saml2.metadata.KeyDescriptor
getKeyDescriptor
(org.opensaml.security.credential.UsageType type, org.opensaml.xmlsec.signature.KeyInfo key) getKeyDescriptor.getMetadata
(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor) getMetadata.Getter for the fieldsignatureAlgorithms
.Getter for the fieldsignatureReferenceDigestMethods
.protected org.opensaml.saml.saml2.metadata.SingleLogoutService
getSingleLogoutService
(String binding) getSingleLogoutService.protected void
signMetadata
(org.opensaml.xmlsec.signature.SignableXMLObject descriptor) signMetadata.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.pac4j.saml.metadata.SAML2MetadataGenerator
storeMetadata
-
Field Details
-
logger
protected final org.slf4j.Logger logger -
builderFactory
protected final org.opensaml.core.xml.XMLObjectBuilderFactory builderFactory -
marshallerFactory
protected final org.opensaml.core.xml.io.MarshallerFactory marshallerFactory -
globalAlgorithmRegistry
protected final org.opensaml.xmlsec.algorithm.AlgorithmRegistry globalAlgorithmRegistry -
credentialProvider
-
entityId
-
assertionConsumerServiceUrl
-
responseBindingType
-
singleLogoutServiceUrl
-
authnRequestSigned
protected boolean authnRequestSigned -
wantAssertionSigned
protected boolean wantAssertionSigned -
signMetadata
protected boolean signMetadata -
defaultACSIndex
protected int defaultACSIndex -
requestInitiatorLocation
-
nameIdPolicyFormat
-
requestedAttributes
-
defaultSignatureSigningConfiguration
protected org.opensaml.xmlsec.SignatureSigningConfiguration defaultSignatureSigningConfiguration -
blackListedSignatureSigningAlgorithms
-
signatureAlgorithms
-
signatureReferenceDigestMethods
-
-
Constructor Details
-
BaseSAML2MetadataGenerator
public BaseSAML2MetadataGenerator()
-
-
Method Details
-
buildMetadataResolver
public org.opensaml.saml.metadata.resolver.MetadataResolver buildMetadataResolver() throws ExceptionbuildMetadataResolver.
- Specified by:
buildMetadataResolver
in interfaceSAML2MetadataGenerator
- Returns:
- a
MetadataResolver
object - Throws:
Exception
- if any.
-
createMetadataResolver
protected abstract org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver createMetadataResolver() throws ExceptioncreateMetadataResolver.
- Returns:
- a
AbstractMetadataResolver
object - Throws:
Exception
- if any.
-
getMetadata
public String getMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor) throws Exception getMetadata.
- Specified by:
getMetadata
in interfaceSAML2MetadataGenerator
- Parameters:
entityDescriptor
- aEntityDescriptor
object- Returns:
- a
String
object - Throws:
Exception
- if any.
-
buildEntityDescriptor
public org.opensaml.saml.saml2.metadata.EntityDescriptor buildEntityDescriptor()buildEntityDescriptor.
- Specified by:
buildEntityDescriptor
in interfaceSAML2MetadataGenerator
- Returns:
- a
EntityDescriptor
object
-
signMetadata
protected void signMetadata(org.opensaml.xmlsec.signature.SignableXMLObject descriptor) signMetadata.
- Parameters:
descriptor
- aEntityDescriptor
object
-
generateMetadataExtensions
protected org.opensaml.saml.saml2.metadata.Extensions generateMetadataExtensions()generateMetadataExtensions.
- Returns:
- a
Extensions
object
-
buildSPSSODescriptor
protected org.opensaml.saml.saml2.metadata.SPSSODescriptor buildSPSSODescriptor()buildSPSSODescriptor.
- Returns:
- a
SPSSODescriptor
object
-
buildNameIDFormat
buildNameIDFormat.
- Returns:
- a
Collection
object
-
getAssertionConsumerService
protected org.opensaml.saml.saml2.metadata.AssertionConsumerService getAssertionConsumerService(String binding, int index, boolean isDefault) getAssertionConsumerService.
- Parameters:
binding
- aString
objectindex
- a intisDefault
- a boolean- Returns:
- a
AssertionConsumerService
object
-
getSingleLogoutService
protected org.opensaml.saml.saml2.metadata.SingleLogoutService getSingleLogoutService(String binding) getSingleLogoutService.
- Parameters:
binding
- aString
object- Returns:
- a
SingleLogoutService
object
-
getKeyDescriptor
protected org.opensaml.saml.saml2.metadata.KeyDescriptor getKeyDescriptor(org.opensaml.security.credential.UsageType type, org.opensaml.xmlsec.signature.KeyInfo key) getKeyDescriptor.
- Parameters:
type
- aUsageType
objectkey
- aKeyInfo
object- Returns:
- a
KeyDescriptor
object
-
getBlackListedSignatureSigningAlgorithms
Getter for the field
blackListedSignatureSigningAlgorithms
.- Returns:
- a
List
object
-
getSignatureAlgorithms
Getter for the field
signatureAlgorithms
.- Returns:
- a
List
object
-
getSignatureReferenceDigestMethods
Getter for the field
signatureReferenceDigestMethods
.- Returns:
- a
List
object
-