Package org.pac4j.saml.metadata
Class BaseSAML2MetadataGenerator
- java.lang.Object
-
- org.pac4j.saml.metadata.BaseSAML2MetadataGenerator
-
- All Implemented Interfaces:
SAML2MetadataGenerator
- Direct Known Subclasses:
SAML2FileSystemMetadataGenerator
,SAML2HttpUrlMetadataGenerator
public abstract class BaseSAML2MetadataGenerator extends Object implements SAML2MetadataGenerator
Generates metadata object with standard values and overridden user defined values.- Since:
- 4.0.1
- Author:
- Misagh Moayyed
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BaseSAML2MetadataGenerator()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description org.opensaml.saml.saml2.metadata.EntityDescriptor
buildEntityDescriptor()
org.opensaml.saml.metadata.resolver.MetadataResolver
buildMetadataResolver(org.springframework.core.io.Resource metadataResource)
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.AbstractBatchMetadataResolver
createMetadataResolver(org.springframework.core.io.Resource metadataResource)
protected org.opensaml.saml.saml2.metadata.Extensions
generateMetadataExtensions()
protected org.opensaml.saml.saml2.metadata.AssertionConsumerService
getAssertionConsumerService(String binding, int index, boolean isDefault)
List<String>
getBlackListedSignatureSigningAlgorithms()
List<SAML2MetadataContactPerson>
getContactPersons()
CredentialProvider
getCredentialProvider()
int
getDefaultACSIndex()
String
getEntityId()
protected org.opensaml.saml.saml2.metadata.KeyDescriptor
getKeyDescriptor(org.opensaml.security.credential.UsageType type, org.opensaml.xmlsec.signature.KeyInfo key)
String
getMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor)
List<SAML2MetadataUIInfo>
getMetadataUIInfos()
String
getNameIdPolicyFormat()
List<SAML2ServiceProvicerRequestedAttribute>
getRequestedAttributes()
List<String>
getSignatureAlgorithms()
List<String>
getSignatureReferenceDigestMethods()
protected org.opensaml.saml.saml2.metadata.SingleLogoutService
getSingleLogoutService(String binding)
List<String>
getSupportedProtocols()
boolean
isAuthnRequestSigned()
boolean
isSignMetadata()
boolean
isWantAssertionSigned()
void
setAssertionConsumerServiceUrl(String assertionConsumerServiceUrl)
void
setAuthnRequestSigned(boolean authnRequestSigned)
void
setBlackListedSignatureSigningAlgorithms(List<String> blackListedSignatureSigningAlgorithms)
void
setContactPersons(List<SAML2MetadataContactPerson> contactPersons)
void
setCredentialProvider(CredentialProvider credentialProvider)
void
setDefaultACSIndex(int defaultACSIndex)
void
setEntityId(String entityId)
void
setMetadataUIInfos(List<SAML2MetadataUIInfo> metadataUIInfos)
void
setNameIdPolicyFormat(String nameIdPolicyFormat)
void
setRequestedAttributes(List<SAML2ServiceProvicerRequestedAttribute> requestedAttributes)
void
setRequestInitiatorLocation(String requestInitiatorLocation)
void
setResponseBindingType(String responseBindingType)
void
setSignatureAlgorithms(List<String> signatureAlgorithms)
void
setSignatureReferenceDigestMethods(List<String> signatureReferenceDigestMethods)
void
setSignMetadata(boolean signMetadata)
void
setSingleLogoutServiceUrl(String singleLogoutServiceUrl)
void
setSupportedProtocols(List<String> supportedProtocols)
void
setWantAssertionSigned(boolean wantAssertionSigned)
protected void
signMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor descriptor)
-
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 Detail
-
logger
protected static 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
protected CredentialProvider credentialProvider
-
entityId
protected String entityId
-
assertionConsumerServiceUrl
protected String assertionConsumerServiceUrl
-
responseBindingType
protected String responseBindingType
-
singleLogoutServiceUrl
protected String singleLogoutServiceUrl
-
authnRequestSigned
protected boolean authnRequestSigned
-
wantAssertionSigned
protected boolean wantAssertionSigned
-
signMetadata
protected boolean signMetadata
-
defaultACSIndex
protected int defaultACSIndex
-
requestInitiatorLocation
protected String requestInitiatorLocation
-
nameIdPolicyFormat
protected String nameIdPolicyFormat
-
requestedAttributes
protected List<SAML2ServiceProvicerRequestedAttribute> requestedAttributes
-
defaultSignatureSigningConfiguration
protected org.opensaml.xmlsec.SignatureSigningConfiguration defaultSignatureSigningConfiguration
-
-
Method Detail
-
buildMetadataResolver
public org.opensaml.saml.metadata.resolver.MetadataResolver buildMetadataResolver(org.springframework.core.io.Resource metadataResource) throws Exception
- Specified by:
buildMetadataResolver
in interfaceSAML2MetadataGenerator
- Throws:
Exception
-
createMetadataResolver
protected abstract org.opensaml.saml.metadata.resolver.impl.AbstractBatchMetadataResolver createMetadataResolver(org.springframework.core.io.Resource metadataResource) throws Exception
- Throws:
Exception
-
getMetadata
public String getMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor) throws Exception
- Specified by:
getMetadata
in interfaceSAML2MetadataGenerator
- Throws:
Exception
-
buildEntityDescriptor
public org.opensaml.saml.saml2.metadata.EntityDescriptor buildEntityDescriptor()
- Specified by:
buildEntityDescriptor
in interfaceSAML2MetadataGenerator
-
signMetadata
protected void signMetadata(org.opensaml.saml.saml2.metadata.EntityDescriptor descriptor)
-
generateMetadataExtensions
protected org.opensaml.saml.saml2.metadata.Extensions generateMetadataExtensions()
-
buildSPSSODescriptor
protected org.opensaml.saml.saml2.metadata.SPSSODescriptor buildSPSSODescriptor()
-
buildNameIDFormat
protected Collection<org.opensaml.saml.saml2.metadata.NameIDFormat> buildNameIDFormat()
-
getAssertionConsumerService
protected org.opensaml.saml.saml2.metadata.AssertionConsumerService getAssertionConsumerService(String binding, int index, boolean isDefault)
-
getSingleLogoutService
protected org.opensaml.saml.saml2.metadata.SingleLogoutService getSingleLogoutService(String binding)
-
getKeyDescriptor
protected org.opensaml.saml.saml2.metadata.KeyDescriptor getKeyDescriptor(org.opensaml.security.credential.UsageType type, org.opensaml.xmlsec.signature.KeyInfo key)
-
getCredentialProvider
public CredentialProvider getCredentialProvider()
-
setCredentialProvider
public final void setCredentialProvider(CredentialProvider credentialProvider)
-
getEntityId
public String getEntityId()
-
setEntityId
public final void setEntityId(String entityId)
-
isAuthnRequestSigned
public boolean isAuthnRequestSigned()
-
setAuthnRequestSigned
public final void setAuthnRequestSigned(boolean authnRequestSigned)
-
isWantAssertionSigned
public boolean isWantAssertionSigned()
-
setWantAssertionSigned
public void setWantAssertionSigned(boolean wantAssertionSigned)
-
isSignMetadata
public boolean isSignMetadata()
-
setSignMetadata
public void setSignMetadata(boolean signMetadata)
-
getDefaultACSIndex
public int getDefaultACSIndex()
-
setDefaultACSIndex
public void setDefaultACSIndex(int defaultACSIndex)
-
setAssertionConsumerServiceUrl
public final void setAssertionConsumerServiceUrl(String assertionConsumerServiceUrl)
-
setResponseBindingType
public void setResponseBindingType(String responseBindingType)
-
setSingleLogoutServiceUrl
public final void setSingleLogoutServiceUrl(String singleLogoutServiceUrl)
-
setRequestInitiatorLocation
public final void setRequestInitiatorLocation(String requestInitiatorLocation)
-
getNameIdPolicyFormat
public String getNameIdPolicyFormat()
-
setNameIdPolicyFormat
public void setNameIdPolicyFormat(String nameIdPolicyFormat)
-
getRequestedAttributes
public List<SAML2ServiceProvicerRequestedAttribute> getRequestedAttributes()
-
setRequestedAttributes
public void setRequestedAttributes(List<SAML2ServiceProvicerRequestedAttribute> requestedAttributes)
-
getBlackListedSignatureSigningAlgorithms
public List<String> getBlackListedSignatureSigningAlgorithms()
-
setBlackListedSignatureSigningAlgorithms
public void setBlackListedSignatureSigningAlgorithms(List<String> blackListedSignatureSigningAlgorithms)
-
setSignatureReferenceDigestMethods
public void setSignatureReferenceDigestMethods(List<String> signatureReferenceDigestMethods)
-
getContactPersons
public List<SAML2MetadataContactPerson> getContactPersons()
-
setContactPersons
public void setContactPersons(List<SAML2MetadataContactPerson> contactPersons)
-
getMetadataUIInfos
public List<SAML2MetadataUIInfo> getMetadataUIInfos()
-
setMetadataUIInfos
public void setMetadataUIInfos(List<SAML2MetadataUIInfo> metadataUIInfos)
-
-