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

Class AffiliationDescriptorImpl

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.opensaml.saml.common.AbstractSignableSAMLObject

org.opensaml.saml.saml2.metadata.impl.AffiliationDescriptorImpl

All Implemented Interfaces:

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

public class AffiliationDescriptorImpl
extends AbstractSignableSAMLObject
implements AffiliationDescriptor

Concrete implementation of AffiliationDescriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private Duration	cacheDuration	cacheDurection attribute.
private Extensions	extensions	Extensions child.
private String	id	ID attribute.
private XMLObjectChildrenList<KeyDescriptor>	keyDescriptors	Key descriptors for this role.
private XMLObjectChildrenList<AffiliateMember>	members	Members of this affiliation.
private String	ownerID	ID of the owner of this affiliation.
private AttributeMap	unknownAttributes	"anyAttribute" attributes.
private Instant	validUntil	validUntil attribute.

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

DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ID_ATTRIB_NAME, OWNER_ID_ATTRIB_NAME, TYPE_LOCAL_NAME, TYPE_NAME

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.common.TimeBoundSAMLObject

VALID_UNTIL_ATTRIB_NAME, VALID_UNTIL_ATTRIB_QNAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Duration	getCacheDuration()	Gets the maximum time that this descriptor should be cached.
Extensions	getExtensions()	Gets the Extensions child of this object.
String	getID()	Gets the ID of this Descriptor.
List<KeyDescriptor>	getKeyDescriptors()	Gets an immutable list of KeyDescriptors for this affiliation.
List<AffiliateMember>	getMembers()	Gets a list of the members of this affiliation.
List<XMLObject>	getOrderedChildren()	Gets an unmodifiable list of child elements in the order that they will appear in the DOM.
String	getOwnerID()	Gets the ID of the owner of this affiliation.
String	getSignatureReferenceID()	Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
AttributeMap	getUnknownAttributes()	Gets a mutable map of the attributes.
Instant	getValidUntil()	Gets the date until which this descriptor is valid.
boolean	isValid()	Checks to see if the current time is past the validUntil time.
void	setCacheDuration(Duration duration)	Sets the maximum time that this descriptor should be cached.
void	setExtensions(Extensions theExtensions)	Sets the Extensions child of this object.
void	setID(String newID)	Sets the ID of this descriptor.
void	setOwnerID(String newOwnerID)	Sets the ID of the owner of this affiliation.
void	setValidUntil(Instant theValidUntil)	Sets the date until which this descriptor is valid.

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, 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, 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 Detail

ownerID

private String ownerID

ID of the owner of this affiliation.

id

private String id

ID attribute.

validUntil

private Instant validUntil

validUntil attribute.

cacheDuration

private Duration cacheDuration

cacheDurection attribute.

extensions

private Extensions extensions

Extensions child.

unknownAttributes

private final AttributeMap unknownAttributes

"anyAttribute" attributes.

members

private final XMLObjectChildrenList<AffiliateMember> members

Members of this affiliation.

keyDescriptors

private final XMLObjectChildrenList<KeyDescriptor> keyDescriptors

Key descriptors for this role.

Constructor Detail

AffiliationDescriptorImpl

protected AffiliationDescriptorImpl(String namespaceURI,
                                    String elementLocalName,
                                    String namespacePrefix)

Constructor.

Parameters:

namespaceURI - namespace

elementLocalName - localname

namespacePrefix - prefix

Method Detail

getOwnerID

public String getOwnerID()

Gets the ID of the owner of this affiliation. The owner may, or may not, be a member of the affiliation.

Specified by:

getOwnerID in interface AffiliationDescriptor

Returns:

the ID of the owner of this affiliation

setOwnerID

public void setOwnerID(String newOwnerID)

Sets the ID of the owner of this affiliation.

Specified by:

setOwnerID in interface AffiliationDescriptor

Parameters:

newOwnerID - the ID of the owner of this affiliation

getID

public String getID()

Gets the ID of this Descriptor.

Specified by:

getID in interface AffiliationDescriptor

Returns:

the ID of this Descriptor

setID

public void setID(String newID)

Sets the ID of this descriptor.

Specified by:

setID in interface AffiliationDescriptor

Parameters:

newID - the ID of this descriptor

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

getValidUntil

public Instant 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

setValidUntil

public void setValidUntil(Instant theValidUntil)

Sets the date until which this descriptor is valid.

Specified by:

setValidUntil in interface TimeBoundSAMLObject

Parameters:

theValidUntil - the date until which this descriptor is valid

getCacheDuration

public Duration getCacheDuration()

Gets the maximum time 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(Duration duration)

Sets the maximum time that this descriptor should be cached.

Specified by:

setCacheDuration in interface CacheableSAMLObject

Parameters:

duration - the maximum time that this descriptor should be cached

getExtensions

public Extensions getExtensions()

Gets the Extensions child of this object.

Specified by:

getExtensions in interface AffiliationDescriptor

Returns:

the Extensions child of this object

setExtensions

public void setExtensions(Extensions theExtensions)

Sets the Extensions child of this object.

Specified by:

setExtensions in interface AffiliationDescriptor

Parameters:

theExtensions - the Extensions child of this object

getMembers

public List<AffiliateMember> getMembers()

Gets a list of the members of this affiliation.

Specified by:

getMembers in interface AffiliationDescriptor

Returns:

a list of affiliate members

getKeyDescriptors

public List<KeyDescriptor> getKeyDescriptors()

Gets an immutable list of KeyDescriptors for this affiliation.

Specified by:

getKeyDescriptors in interface AffiliationDescriptor

Returns:

list of KeyDescriptors for this affiliation

getUnknownAttributes

public AttributeMap getUnknownAttributes()

Gets a mutable map of the attributes. The map key is the namespace qualified name of the attribute, the map value is the value of the attribute.

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject

Returns:

a map of the attributes

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

getOrderedChildren

public List<XMLObject> getOrderedChildren()

Gets an unmodifiable list of child elements in the order that they will appear in the DOM.

Specified by:

getOrderedChildren in interface XMLObject

Returns:

ordered list of child elements