org.opensaml.saml2.metadata.provider
Class ChainingMetadataProvider.ChainingEntitiesDescriptor

java.lang.Object
  org.opensaml.saml2.metadata.provider.ChainingMetadataProvider.ChainingEntitiesDescriptor

All Implemented Interfaces:

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

Enclosing class:

ChainingMetadataProvider

private class ChainingMetadataProvider.ChainingEntitiesDescriptor
extends Object
implements EntitiesDescriptor

Class that wraps the currently list of providers and exposes it as an EntitiesDescriptors.

Field Summary

private ArrayList<XMLObject>

childDescriptors Metadata from the child metadata providers.

Fields inherited from interface org.opensaml.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.saml2.common.TimeBoundSAMLObject

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

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

CACHE_DURATION_ATTRIB_NAME, CACHE_DURATION_ATTRIB_QNAME

Constructor Summary

ChainingMetadataProvider.ChainingEntitiesDescriptor()
Constructor.

Method Summary

void	addNamespace(Namespace namespace)
void	deregisterValidator(Validator validator)
void	detach()
Long	getCacheDuration() Gets the maximum time, in milliseconds, that this descriptor should be cached.
Element	getDOM()
QName	getElementQName()
List<EntitiesDescriptor>	getEntitiesDescriptors() Gets a list of child EntitiesDescriptors.
List<EntityDescriptor>	getEntityDescriptors() Gets a list of child EntityDescriptors.
Extensions	getExtensions() Gets the Extensions child of this object.
String	getID() Gets the ID of this entity group.
IDIndex	getIDIndex()
String	getName() Gets the name of this entity group.
NamespaceManager	getNamespaceManager()
Set<Namespace>	getNamespaces()
String	getNoNamespaceSchemaLocation()
List<XMLObject>	getOrderedChildren()
XMLObject	getParent()
String	getSchemaLocation()
QName	getSchemaType()
Signature	getSignature()
String	getSignatureReferenceID() Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
List<Validator>	getValidators()
org.joda.time.DateTime	getValidUntil() Gets the date until which this descriptor is valid.
boolean	hasChildren()
boolean	hasParent()
Boolean	isNil()
XSBooleanValue	isNilXSBoolean()
boolean	isSigned()
boolean	isValid() Checks to see if the current time is past the validUntil time.
void	registerValidator(Validator validator)
void	releaseChildrenDOM(boolean propagateRelease)
void	releaseDOM()
void	releaseParentDOM(boolean propagateRelease)
void	removeNamespace(Namespace namespace)
XMLObject	resolveID(String id)
XMLObject	resolveIDFromRoot(String id)
void	setCacheDuration(Long duration) Sets the maximum time, in milliseconds, that this descriptor should be cached.
void	setDOM(Element dom)
void	setExtensions(Extensions extensions) Sets the Extensions child of this object.
void	setID(String newID) Sets the ID of this entity group.
void	setName(String name) Sets the name of this entity group.
void	setNil(Boolean arg0)
void	setNil(XSBooleanValue arg0)
void	setNoNamespaceSchemaLocation(String location)
void	setParent(XMLObject parent)
void	setSchemaLocation(String location)
void	setSignature(Signature newSignature)
void	setValidUntil(org.joda.time.DateTime validUntil) Sets the date until which this descriptor is valid.
void	validate(boolean validateDescendants)

Methods inherited from class java.lang.Object

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

Field Detail

childDescriptors

private ArrayList<XMLObject> childDescriptors

Metadata from the child metadata providers.

Constructor Detail

ChainingMetadataProvider.ChainingEntitiesDescriptor

public ChainingMetadataProvider.ChainingEntitiesDescriptor()

Constructor.

Method Detail

getEntitiesDescriptors

public List<EntitiesDescriptor> getEntitiesDescriptors()

Gets a list of child EntitiesDescriptors.

Specified by:

getEntitiesDescriptors in interface EntitiesDescriptor

Returns:

list of descriptors

getEntityDescriptors

public List<EntityDescriptor> getEntityDescriptors()

Gets a list of child EntityDescriptors.

Specified by:

getEntityDescriptors in interface EntitiesDescriptor

Returns:

list of child descriptors

getExtensions

public Extensions getExtensions()

Gets the Extensions child of this object.

Specified by:

getExtensions in interface EntitiesDescriptor

Returns:

the Extensions child of this object

getID

public String getID()

Gets the ID of this entity group.

Specified by:

getID in interface EntitiesDescriptor

Returns:

the id of this entity group

getName

public String getName()

Gets the name of this entity group.

Specified by:

getName in interface EntitiesDescriptor

Returns:

the name of this entity group

setExtensions

public void setExtensions(Extensions extensions)

Sets the Extensions child of this object.

Specified by:

setExtensions in interface EntitiesDescriptor

Parameters:

extensions - the Extensions child of this object

setID

public void setID(String newID)

Sets the ID of this entity group.

Specified by:

setID in interface EntitiesDescriptor

Parameters:

newID - the ID of this entity group

setName

public void setName(String name)

Sets the name of this entity group.

Specified by:

setName in interface EntitiesDescriptor

Parameters:

name - the name of this entity group

getSignatureReferenceID

public String getSignatureReferenceID()

Gets the value of the ID attribute for this SAML object which will be used as its signature reference.

Specified by:

getSignatureReferenceID in interface SignableSAMLObject

Returns:

the value of this SAMLObject ID attribute

getSignature

public Signature getSignature()

Specified by:

getSignature in interface SignableXMLObject

isSigned

public boolean isSigned()

Specified by:

isSigned in interface SignableXMLObject

setSignature

public void setSignature(Signature newSignature)

Specified by:

setSignature in interface SignableXMLObject

addNamespace

public void addNamespace(Namespace namespace)

Specified by:

addNamespace in interface XMLObject

detach

public void detach()

Specified by:

detach in interface XMLObject

getDOM

public Element getDOM()

Specified by:

getDOM in interface XMLObject

getElementQName

public QName getElementQName()

Specified by:

getElementQName in interface XMLObject

getIDIndex

public IDIndex getIDIndex()

Specified by:

getIDIndex in interface XMLObject

getNamespaceManager

public NamespaceManager getNamespaceManager()

Specified by:

getNamespaceManager in interface XMLObject

getNamespaces

public Set<Namespace> getNamespaces()

Specified by:

getNamespaces in interface XMLObject

getNoNamespaceSchemaLocation

public String getNoNamespaceSchemaLocation()

Specified by:

getNoNamespaceSchemaLocation in interface XMLObject

getOrderedChildren

public List<XMLObject> getOrderedChildren()

Specified by:

getOrderedChildren in interface XMLObject

getParent

public XMLObject getParent()

Specified by:

getParent in interface XMLObject

getSchemaLocation

public String getSchemaLocation()

Specified by:

getSchemaLocation in interface XMLObject

getSchemaType

public QName getSchemaType()

Specified by:

getSchemaType in interface XMLObject

hasChildren

public boolean hasChildren()

Specified by:

hasChildren in interface XMLObject

hasParent

public boolean hasParent()

Specified by:

hasParent in interface XMLObject

releaseChildrenDOM

public void releaseChildrenDOM(boolean propagateRelease)

Specified by:

releaseChildrenDOM in interface XMLObject

releaseDOM

public void releaseDOM()

Specified by:

releaseDOM in interface XMLObject

releaseParentDOM

public void releaseParentDOM(boolean propagateRelease)

Specified by:

releaseParentDOM in interface XMLObject

removeNamespace

public void removeNamespace(Namespace namespace)

Specified by:

removeNamespace in interface XMLObject

resolveID

public XMLObject resolveID(String id)

Specified by:

resolveID in interface XMLObject

resolveIDFromRoot

public XMLObject resolveIDFromRoot(String id)

Specified by:

resolveIDFromRoot in interface XMLObject

setDOM

public void setDOM(Element dom)

Specified by:

setDOM in interface XMLObject

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(String location)

Specified by:

setNoNamespaceSchemaLocation in interface XMLObject

setParent

public void setParent(XMLObject parent)

Specified by:

setParent in interface XMLObject

setSchemaLocation

public void setSchemaLocation(String location)

Specified by:

setSchemaLocation in interface XMLObject

deregisterValidator

public void deregisterValidator(Validator validator)

Specified by:

deregisterValidator in interface ValidatingXMLObject

getValidators

public List<Validator> getValidators()

Specified by:

getValidators in interface ValidatingXMLObject

registerValidator

public void registerValidator(Validator validator)

Specified by:

registerValidator in interface ValidatingXMLObject

validate

public void validate(boolean validateDescendants)
              throws ValidationException

Specified by:

validate in interface ValidatingXMLObject

Throws:

ValidationException

getValidUntil

public org.joda.time.DateTime getValidUntil()

Gets the date until which this descriptor is valid.

Specified by:

getValidUntil in interface TimeBoundSAMLObject

Returns:

the date until which this descriptor is valid

isValid

public boolean isValid()

Checks to see if the current time is past the validUntil time.

Specified by:

isValid in interface TimeBoundSAMLObject

Returns:

true of this descriptor is still valid otherwise false

setValidUntil

public void setValidUntil(org.joda.time.DateTime validUntil)

Sets the date until which this descriptor is valid.

Specified by:

setValidUntil in interface TimeBoundSAMLObject

Parameters:

validUntil - the date until which this descriptor is valid

getCacheDuration

public Long getCacheDuration()

Gets the maximum time, in milliseconds, that this descriptor should be cached.

Specified by:

getCacheDuration in interface CacheableSAMLObject

Returns:

the maximum time that this descriptor should be cached

setCacheDuration

public void setCacheDuration(Long duration)

Sets the maximum time, in milliseconds, that this descriptor should be cached.

Specified by:

setCacheDuration in interface CacheableSAMLObject

Parameters:

duration - the maximum time that this descriptor should be cached

isNil

public Boolean isNil()

Specified by:

isNil in interface XMLObject

isNilXSBoolean

public XSBooleanValue isNilXSBoolean()

Specified by:

isNilXSBoolean in interface XMLObject

setNil

public void setNil(Boolean arg0)

Specified by:

setNil in interface XMLObject

setNil

public void setNil(XSBooleanValue arg0)

Specified by:

setNil in interface XMLObject