Package org.opensaml.saml.saml2.metadata.impl

Class EntityDescriptorImpl

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.opensaml.saml.common.AbstractSignableSAMLObject

org.opensaml.saml.saml2.metadata.impl.EntityDescriptorImpl

All Implemented Interfaces:

AttributeExtensibleXMLObject, XMLObject, SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, EntityDescriptor, SignableXMLObject

public class EntityDescriptorImpl
extends AbstractSignableSAMLObject
implements EntityDescriptor

Concretate implementation of EntityDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private final XMLObjectChildrenList<AdditionalMetadataLocation>	additionalMetadata	Additional metadata locations for this entity.
private AffiliationDescriptor	affiliationDescriptor	Affiliatition descriptor for this entity.
private Duration	cacheDuration	cacheDurection attribute.
private final XMLObjectChildrenList<ContactPerson>	contactPersons	Contact persons for this entity.
private String	entityID	Entity ID of this Entity.
private Extensions	extensions	Extensions child.
private String	id	ID attribute.
private Organization	organization	Organization the administers this entity.
private final IndexedXMLObjectChildrenList<RoleDescriptor>	roleDescriptors	Role descriptors for this entity.
private final AttributeMap	unknownAttributes	"anyAttribute" attributes.
private Instant	validUntil	validUntil attribute.

Fields inherited from interface org.opensaml.saml.saml2.common.CacheableSAMLObject

CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME

Fields inherited from interface org.opensaml.saml.saml2.metadata.EntityDescriptor

DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ELEMENT_QNAME, ENTITY_ID_ATTRIB_NAME, ID_ATTRIB_NAME, TYPE_LOCAL_NAME, TYPE_NAME

Fields inherited from interface org.opensaml.saml.saml2.common.TimeBoundSAMLObject

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityDescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
List<AdditionalMetadataLocation>	getAdditionalMetadataLocations()
AffiliationDescriptor	getAffiliationDescriptor()
AttributeAuthorityDescriptor	getAttributeAuthorityDescriptor(String supportedProtocol)
AuthnAuthorityDescriptor	getAuthnAuthorityDescriptor(String supportedProtocol)
Duration	getCacheDuration()
List<ContactPerson>	getContactPersons()
String	getEntityID()
Extensions	getExtensions()
String	getID()
IDPSSODescriptor	getIDPSSODescriptor(String supportedProtocol)
List<XMLObject>	getOrderedChildren()
Organization	getOrganization()
PDPDescriptor	getPDPDescriptor(String supportedProtocol)
List<RoleDescriptor>	getRoleDescriptors()
List<RoleDescriptor>	getRoleDescriptors(QName typeOrName)
List<RoleDescriptor>	getRoleDescriptors(QName type, String supportedProtocol)
String	getSignatureReferenceID()
SPSSODescriptor	getSPSSODescriptor(String supportedProtocol)
AttributeMap	getUnknownAttributes()
Instant	getValidUntil()
boolean	isValid()
void	setAffiliationDescriptor(AffiliationDescriptor descriptor)
void	setCacheDuration(Duration duration)
void	setEntityID(String newId)
void	setExtensions(Extensions newExtensions)
void	setID(String newID)
void	setOrganization(Organization newOrganization)
void	setValidUntil(Instant newValidUntil)

Methods inherited from class org.opensaml.saml.common.AbstractSignableSAMLObject

equals, hashCode, setSignature

Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject

getSignature, isSigned

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, ensureDOM, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Details

entityID

@Nullable
private String entityID

Entity ID of this Entity.

id

@Nullable
private String id

ID attribute.

validUntil

@Nullable
private Instant validUntil

validUntil attribute.

cacheDuration

@Nullable
private Duration cacheDuration

cacheDurection attribute.

extensions

@Nullable
private Extensions extensions

Extensions child.

roleDescriptors

@Nonnull
private final IndexedXMLObjectChildrenList<RoleDescriptor> roleDescriptors

Role descriptors for this entity.

affiliationDescriptor

@Nullable
private AffiliationDescriptor affiliationDescriptor

Affiliatition descriptor for this entity.

organization

@Nullable
private Organization organization

Organization the administers this entity.

contactPersons

@Nonnull
private final XMLObjectChildrenList<ContactPerson> contactPersons

Contact persons for this entity.

additionalMetadata

@Nonnull
private final XMLObjectChildrenList<AdditionalMetadataLocation> additionalMetadata

Additional metadata locations for this entity.

unknownAttributes

@Nonnull
private final AttributeMap unknownAttributes

"anyAttribute" attributes.

Constructor Details

EntityDescriptorImpl

protected EntityDescriptorImpl(@Nullable
 String namespaceURI,
 @Nonnull
 String elementLocalName,
 @Nullable
 String namespacePrefix)

Constructor.

Parameters:

namespaceURI - the namespace the element is in

elementLocalName - the local name of the XML element this Object represents

namespacePrefix - the prefix for the given namespace

Method Details

getEntityID

@Nullable
public String getEntityID()

Specified by:

getEntityID in interface EntityDescriptor

setEntityID

public void setEntityID(@Nullable
 String newId)

Specified by:

setEntityID in interface EntityDescriptor

getID

@Nullable
public String getID()

Specified by:

getID in interface EntityDescriptor

setID

public void setID(@Nullable
 String newID)

Specified by:

setID in interface EntityDescriptor

isValid

public boolean isValid()

Specified by:

isValid in interface TimeBoundSAMLObject

getValidUntil

@Nullable
public Instant getValidUntil()

Specified by:

getValidUntil in interface TimeBoundSAMLObject

setValidUntil

public void setValidUntil(@Nullable
 Instant newValidUntil)

Specified by:

setValidUntil in interface TimeBoundSAMLObject

getCacheDuration

@Nullable
public Duration getCacheDuration()

Specified by:

getCacheDuration in interface CacheableSAMLObject

setCacheDuration

public void setCacheDuration(@Nullable
 Duration duration)

Specified by:

setCacheDuration in interface CacheableSAMLObject

getExtensions

@Nullable
public Extensions getExtensions()

Specified by:

getExtensions in interface EntityDescriptor

setExtensions

public void setExtensions(@Nullable
 Extensions newExtensions)

Specified by:

setExtensions in interface EntityDescriptor

getRoleDescriptors

@Nonnull
@Live
public List<RoleDescriptor> getRoleDescriptors()

Specified by:

getRoleDescriptors in interface EntityDescriptor

getRoleDescriptors

@Nonnull
@Live
public List<RoleDescriptor> getRoleDescriptors(@Nonnull
 QName typeOrName)

Specified by:

getRoleDescriptors in interface EntityDescriptor

getRoleDescriptors

@Nonnull
@NotLive
@Unmodifiable
public List<RoleDescriptor> getRoleDescriptors(@Nonnull
 QName type,
 @Nonnull @NotEmpty
 String supportedProtocol)

Specified by:

getRoleDescriptors in interface EntityDescriptor

getIDPSSODescriptor

@Nullable
public IDPSSODescriptor getIDPSSODescriptor(@Nonnull @NotEmpty
 String supportedProtocol)

Specified by:

getIDPSSODescriptor in interface EntityDescriptor

getSPSSODescriptor

@Nullable
public SPSSODescriptor getSPSSODescriptor(@Nonnull @NotEmpty
 String supportedProtocol)

Specified by:

getSPSSODescriptor in interface EntityDescriptor

getAuthnAuthorityDescriptor

@Nullable
public AuthnAuthorityDescriptor getAuthnAuthorityDescriptor(@Nonnull @NotEmpty
 String supportedProtocol)

Specified by:

getAuthnAuthorityDescriptor in interface EntityDescriptor

getAttributeAuthorityDescriptor

@Nullable
public AttributeAuthorityDescriptor getAttributeAuthorityDescriptor(@Nonnull @NotEmpty
 String supportedProtocol)

Specified by:

getAttributeAuthorityDescriptor in interface EntityDescriptor

getPDPDescriptor

@Nullable
public PDPDescriptor getPDPDescriptor(@Nonnull @NotEmpty
 String supportedProtocol)

Specified by:

getPDPDescriptor in interface EntityDescriptor

getAffiliationDescriptor

@Nullable
public AffiliationDescriptor getAffiliationDescriptor()

Specified by:

getAffiliationDescriptor in interface EntityDescriptor

setAffiliationDescriptor

public void setAffiliationDescriptor(@Nullable
 AffiliationDescriptor descriptor)

Specified by:

setAffiliationDescriptor in interface EntityDescriptor

getOrganization

@Nullable
public Organization getOrganization()

Specified by:

getOrganization in interface EntityDescriptor

setOrganization

public void setOrganization(@Nullable
 Organization newOrganization)

Specified by:

setOrganization in interface EntityDescriptor

getContactPersons

@Nonnull
@Live
public List<ContactPerson> getContactPersons()

Specified by:

getContactPersons in interface EntityDescriptor

getAdditionalMetadataLocations

@Nonnull
@Live
public List<AdditionalMetadataLocation> getAdditionalMetadataLocations()

Specified by:

getAdditionalMetadataLocations in interface EntityDescriptor

getUnknownAttributes

@Nonnull
public AttributeMap getUnknownAttributes()

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject

getSignatureReferenceID

@Nullable
public String getSignatureReferenceID()

Specified by:

getSignatureReferenceID in interface SignableSAMLObject

getOrderedChildren

@Nullable
@NotLive
@Unmodifiable
public List<XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface XMLObject