org.opensaml.saml2.metadata.impl
Class AffiliationDescriptorImpl

java.lang.Object
  extended by org.opensaml.xml.AbstractXMLObject
      extended by org.opensaml.xml.signature.AbstractSignableXMLObject
          extended by org.opensaml.xml.AbstractValidatingSignableXMLObject
              extended by org.opensaml.common.impl.AbstractSignableSAMLObject
                  extended by org.opensaml.saml2.metadata.impl.AffiliationDescriptorImpl
All Implemented Interfaces:
SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, AffiliationDescriptor, org.opensaml.xml.AttributeExtensibleXMLObject, org.opensaml.xml.signature.SignableXMLObject, org.opensaml.xml.validation.ValidatingXMLObject, org.opensaml.xml.XMLObject

public class AffiliationDescriptorImpl
extends AbstractSignableSAMLObject
implements AffiliationDescriptor

Concrete implementation of AffiliationDescriptor.


Field Summary
 
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(java.lang.String namespaceURI, java.lang.String elementLocalName, java.lang.String namespacePrefix)
          Constructor
 
Method Summary
 java.lang.Long getCacheDuration()
          Gets the maximum time, in milliseconds, that this descriptor should be cached.
 Extensions getExtensions()
          Gets the Extensions child of this object.
 java.lang.String getID()
          Gets the ID of this Descriptor.
 java.util.List<KeyDescriptor> getKeyDescriptors()
          Gets an immutable list of KeyDescriptors for this affiliation.
 java.util.List<AffiliateMember> getMembers()
          Gets a list of the members of this affiliation.
 java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()
          
 java.lang.String getOwnerID()
          Gets the ID of the owner of this affiliation.
 java.lang.String getSignatureReferenceID()
          Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
 org.opensaml.xml.util.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(java.lang.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(java.lang.String newID)
          Sets the ID of this descriptor.
 void setOwnerID(java.lang.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, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, 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, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
 

Constructor Detail

AffiliationDescriptorImpl

protected AffiliationDescriptorImpl(java.lang.String namespaceURI,
                                    java.lang.String elementLocalName,
                                    java.lang.String namespacePrefix)
Constructor

Parameters:
namespaceURI -
elementLocalName -
namespacePrefix -
Method Detail

getOwnerID

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.IllegalArgumentException
Sets the Extensions child of this object.

Specified by:
setExtensions in interface AffiliationDescriptor
Parameters:
extensions - the Extensions child of this object
Throws:
java.lang.IllegalArgumentException - thrown if the given extensions Object is already a child of another SAMLObject

getMembers

public java.util.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 java.util.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 org.opensaml.xml.util.AttributeMap getUnknownAttributes()

Specified by:
getUnknownAttributes in interface org.opensaml.xml.AttributeExtensibleXMLObject

getSignatureReferenceID

public java.lang.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 java.util.List<org.opensaml.xml.XMLObject> getOrderedChildren()

Specified by:
getOrderedChildren in interface org.opensaml.xml.XMLObject


Copyright © 2006-2011 Internet2. All Rights Reserved.