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

Class EntitiesDescriptorImpl

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.opensaml.saml.common.AbstractSignableSAMLObject

org.opensaml.saml.saml2.metadata.impl.EntitiesDescriptorImpl

All Implemented Interfaces:

XMLObject, SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, EntitiesDescriptor, SignableXMLObject

public class EntitiesDescriptorImpl
extends AbstractSignableSAMLObject
implements EntitiesDescriptor

Concrete implementation of EntitiesDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private Duration	cacheDuration	cacheDurection attribute.
private Extensions	extensions	Extensions child.
private String	id	ID attribute.
private String	name	Name of this descriptor group.
private final IndexedXMLObjectChildrenList<SAMLObject>	orderedDescriptors	Ordered set of child Entity/Entities Descriptors.
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.EntitiesDescriptor

DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ELEMENT_QNAME, ID_ATTRIB_NAME, NAME_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	EntitiesDescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix)	Constructor.

Method Summary

Modifier and Type	Method	Description
Duration	getCacheDuration()
List<EntitiesDescriptor>	getEntitiesDescriptors()
List<EntityDescriptor>	getEntityDescriptors()
Extensions	getExtensions()
String	getID()
String	getName()
List<XMLObject>	getOrderedChildren()
String	getSignatureReferenceID()
Instant	getValidUntil()
boolean	isValid()
void	setCacheDuration(Duration duration)
void	setExtensions(Extensions newExtensions)
void	setID(String newID)
void	setName(String newName)
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

name

@Nullable
private String name

Name of this descriptor group.

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.

orderedDescriptors

@Nonnull
private final IndexedXMLObjectChildrenList<SAMLObject> orderedDescriptors

Ordered set of child Entity/Entities Descriptors.

Constructor Details

EntitiesDescriptorImpl

protected EntitiesDescriptorImpl(@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

getName

@Nullable
public String getName()

Specified by:

getName in interface EntitiesDescriptor

setName

public void setName(@Nullable
 String newName)

Specified by:

setName in interface EntitiesDescriptor

getID

@Nullable
public String getID()

Specified by:

getID in interface EntitiesDescriptor

setID

public void setID(@Nullable
 String newID)

Specified by:

setID in interface EntitiesDescriptor

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 EntitiesDescriptor

setExtensions

public void setExtensions(@Nullable
 Extensions newExtensions)

Specified by:

setExtensions in interface EntitiesDescriptor

getEntitiesDescriptors

@Nonnull
@Live
public List<EntitiesDescriptor> getEntitiesDescriptors()

Specified by:

getEntitiesDescriptors in interface EntitiesDescriptor

getEntityDescriptors

@Nonnull
@Live
public List<EntityDescriptor> getEntityDescriptors()

Specified by:

getEntityDescriptors in interface EntitiesDescriptor

getSignatureReferenceID

public String getSignatureReferenceID()

Specified by:

getSignatureReferenceID in interface SignableSAMLObject

getOrderedChildren

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

Specified by:

getOrderedChildren in interface XMLObject