org.opensaml.saml2.metadata.impl
Class AffiliationDescriptorImpl

java.lang.Object
  org.opensaml.xml.AbstractXMLObject
      org.opensaml.xml.signature.AbstractSignableXMLObject
          org.opensaml.xml.AbstractValidatingSignableXMLObject
              org.opensaml.common.impl.AbstractSignableSAMLObject
                  org.opensaml.saml2.metadata.impl.AffiliationDescriptorImpl

All Implemented Interfaces:

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

public class AffiliationDescriptorImpl
extends AbstractSignableSAMLObject
implements AffiliationDescriptor

Concrete implementation of AffiliationDescriptor.

Field Summary

private Long	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 org.joda.time.DateTime	validUntil validUntil attribute

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

protected

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

Method Summary

Long	getCacheDuration() Gets the maximum time, in milliseconds, 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()
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()
org.joda.time.DateTime	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(Long duration) Sets the maximum time, in milliseconds, that this descriptor should be cached.
void	setExtensions(Extensions extensions) 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(org.joda.time.DateTime validUntil) Sets the date until which this descriptor is valid.

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

equals, prepareForAssignment, setSignature

Methods inherited from class org.opensaml.xml.AbstractValidatingSignableXMLObject

deregisterValidator, getValidators, registerValidator, validate, validateChildren

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

getSignature, isSigned

Methods inherited from class org.opensaml.xml.AbstractXMLObject

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

Methods inherited from class java.lang.Object

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

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

getSignature, isSigned, setSignature

Methods inherited from interface org.opensaml.xml.validation.ValidatingXMLObject

deregisterValidator, getValidators, registerValidator, validate

Methods inherited from interface org.opensaml.xml.XMLObject

addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, 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 org.joda.time.DateTime validUntil

validUntil attribute

cacheDuration

private Long 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 -

elementLocalName -

namespacePrefix -

Method Detail

getOwnerID

public String getOwnerID()

Gets the ID of the owner of this affiliation. The owner may, or may not, be a memeber 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()

Description copied from interface: AffiliationDescriptor

Gets the ID of this Descriptor.

Specified by:

getID in interface AffiliationDescriptor

Returns:

the ID of this Descriptor

setID

public void setID(String newID)

Description copied from interface: AffiliationDescriptor

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

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

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 extensions)
                   throws IllegalArgumentException

Sets the Extensions child of this object.

Specified by:

setExtensions in interface AffiliationDescriptor

Parameters:

extensions - the Extensions child of this object

Throws:

IllegalArgumentException - thrown if the given extensions Object is already a child of another SAMLObject

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()

Specified by:

getUnknownAttributes in interface AttributeExtensibleXMLObject

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()

Specified by:

getOrderedChildren in interface XMLObject