org.opensaml.saml2.metadata.impl
Class EntityDescriptorImpl

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.EntityDescriptorImpl
All Implemented Interfaces:
SAMLObject, SignableSAMLObject, CacheableSAMLObject, TimeBoundSAMLObject, EntityDescriptor, AttributeExtensibleXMLObject, SignableXMLObject, ValidatingXMLObject, XMLObject

public class EntityDescriptorImpl
extends AbstractSignableSAMLObject
implements EntityDescriptor

Concretate implementation of EntitiesDescriptor.


Field Summary
private  XMLObjectChildrenList<AdditionalMetadataLocation> additionalMetadata
          Additional metadata locations for this entity.
private  AffiliationDescriptor affiliationDescriptor
          Affiliatition descriptor for this entity.
private  Long cacheDuration
          cacheDurection attribute.
private  XMLObjectChildrenList<ContactPerson> contactPersons
          Contact persons for this entity.
private  String entityID
          Entity ID of this Entity.
private  Extensions extensions
          Extensions child.
private  String id
          ID attribute.
private  Organization organization
          Organization the administers this entity.
private  IndexedXMLObjectChildrenList<RoleDescriptor> roleDescriptors
          Role descriptors for this entity.
private  AttributeMap unknownAttributes
          "anyAttribute" attributes.
private  org.joda.time.DateTime validUntil
          validUntil attribute.
 
Fields inherited from interface org.opensaml.saml2.metadata.EntityDescriptor
DEFAULT_ELEMENT_LOCAL_NAME, DEFAULT_ELEMENT_NAME, ELEMENT_QNAME, ENTITY_ID_ATTRIB_NAME, 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 EntityDescriptorImpl(String namespaceURI, String elementLocalName, String namespacePrefix)
          Constructor.
 
Method Summary
 List<AdditionalMetadataLocation> getAdditionalMetadataLocations()
          Gets the additional metadata locations for this entity.
 AffiliationDescriptor getAffiliationDescriptor()
          Gets the affiliation descriptor for this entity.
 AttributeAuthorityDescriptor getAttributeAuthorityDescriptor(String supportedProtocol)
          Gets the first AttributeAuthorityDescriptor role descriptor for this entity that supports the given protocol.
 AuthnAuthorityDescriptor getAuthnAuthorityDescriptor(String supportedProtocol)
          Gets the first AuthnAuthorityDescriptor role descriptor for this entity that supports the given protocol.
 Long getCacheDuration()
          Gets the maximum time, in milliseconds, that this descriptor should be cached.
 List<ContactPerson> getContactPersons()
          Get the contact people for this entity.
 String getEntityID()
          Gets the entity ID for this entity descriptor.
 Extensions getExtensions()
          Gets the Extensions child of this object.
 String getID()
          Gets the ID for this entity descriptor.
 IDPSSODescriptor getIDPSSODescriptor(String supportedProtocol)
          Gets the first IDPSSODescriptor role descriptor for this entity that supports the given protocol.
 List<XMLObject> getOrderedChildren()
          
 Organization getOrganization()
          Gets the organization for this entity.
 PDPDescriptor getPDPDescriptor(String supportedProtocol)
          Gets the first PDPDescriptor role descriptor for this entity that supports the given protocol.
 List<RoleDescriptor> getRoleDescriptors()
          Gets all the role descriptors for this entity descriptor.
 List<RoleDescriptor> getRoleDescriptors(QName typeOrName)
          Gets all the role descriptors for this entity descriptor that match the supplied QName parameter.
 List<RoleDescriptor> getRoleDescriptors(QName type, String supportedProtocol)
          Gets all the role descriptors for this entity that support the given protocol.
 String getSignatureReferenceID()
          Gets the value of the ID attribute for this SAML object which will be used as its signature reference.
 SPSSODescriptor getSPSSODescriptor(String supportedProtocol)
          Gets the first SPSSODescriptor role descriptor for this entity that supports the given protocol.
 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 setAffiliationDescriptor(AffiliationDescriptor descriptor)
          Sets the affiliation descriptor for this entity.
 void setCacheDuration(Long duration)
          Sets the maximum time, in milliseconds, that this descriptor should be cached.
 void setEntityID(String newId)
          Sets the entity ID for this entity descriptor.
 void setExtensions(Extensions newExtensions)
          Sets the Extensions child of this object.
 void setID(String newID)
          Sets the ID for this entity descriptor.
 void setOrganization(Organization newOrganization)
          Sets the organization for this entity.
 void setValidUntil(org.joda.time.DateTime newValidUntil)
          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

entityID

private String entityID
Entity ID of this Entity.


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.


roleDescriptors

private final IndexedXMLObjectChildrenList<RoleDescriptor> roleDescriptors
Role descriptors for this entity.


affiliationDescriptor

private AffiliationDescriptor affiliationDescriptor
Affiliatition descriptor for this entity.


organization

private Organization organization
Organization the administers this entity.


contactPersons

private final XMLObjectChildrenList<ContactPerson> contactPersons
Contact persons for this entity.


additionalMetadata

private final XMLObjectChildrenList<AdditionalMetadataLocation> additionalMetadata
Additional metadata locations for this entity.


unknownAttributes

private final AttributeMap unknownAttributes
"anyAttribute" attributes.

Constructor Detail

EntityDescriptorImpl

protected EntityDescriptorImpl(String namespaceURI,
                               String elementLocalName,
                               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 Detail

getEntityID

public String getEntityID()
Gets the entity ID for this entity descriptor.

Specified by:
getEntityID in interface EntityDescriptor
Returns:
the entity ID for this entity descriptor

setEntityID

public void setEntityID(String newId)
Sets the entity ID for this entity descriptor.

Specified by:
setEntityID in interface EntityDescriptor
Parameters:
newId - the entity ID for this entity descriptor

getID

public String getID()
Gets the ID for this entity descriptor.

Specified by:
getID in interface EntityDescriptor
Returns:
the ID for this entity descriptor

setID

public void setID(String newID)
Sets the ID for this entity descriptor.

Specified by:
setID in interface EntityDescriptor
Parameters:
newID - the ID for this entity 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 newValidUntil)
Sets the date until which this descriptor is valid.

Specified by:
setValidUntil in interface TimeBoundSAMLObject
Parameters:
newValidUntil - 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 EntityDescriptor
Returns:
the Extensions child of this object

setExtensions

public void setExtensions(Extensions newExtensions)
Sets the Extensions child of this object.

Specified by:
setExtensions in interface EntityDescriptor
Parameters:
newExtensions - the Extensions child of this object

getRoleDescriptors

public List<RoleDescriptor> getRoleDescriptors()
Gets all the role descriptors for this entity descriptor.

Specified by:
getRoleDescriptors in interface EntityDescriptor
Returns:
the role descriptors for this entity descriptor

getRoleDescriptors

public List<RoleDescriptor> getRoleDescriptors(QName typeOrName)
Gets all the role descriptors for this entity descriptor that match the supplied QName parameter.

Specified by:
getRoleDescriptors in interface EntityDescriptor
Parameters:
typeOrName - the name of the role
Returns:
the role descriptors for this entity descriptor

getRoleDescriptors

public List<RoleDescriptor> getRoleDescriptors(QName type,
                                               String supportedProtocol)
Gets all the role descriptors for this entity that support the given protocol.

Specified by:
getRoleDescriptors in interface EntityDescriptor
Parameters:
type - the name of the role
supportedProtocol - the supported protocol
Returns:
the list of role descriptors that support the given protocol

getIDPSSODescriptor

public IDPSSODescriptor getIDPSSODescriptor(String supportedProtocol)
Gets the first IDPSSODescriptor role descriptor for this entity that supports the given protocol.

Specified by:
getIDPSSODescriptor in interface EntityDescriptor
Returns:
the IDPSSODescriptor role descriptor

getSPSSODescriptor

public SPSSODescriptor getSPSSODescriptor(String supportedProtocol)
Gets the first SPSSODescriptor role descriptor for this entity that supports the given protocol.

Specified by:
getSPSSODescriptor in interface EntityDescriptor
Returns:
the SPSSODescriptor role descriptor

getAuthnAuthorityDescriptor

public AuthnAuthorityDescriptor getAuthnAuthorityDescriptor(String supportedProtocol)
Gets the first AuthnAuthorityDescriptor role descriptor for this entity that supports the given protocol.

Specified by:
getAuthnAuthorityDescriptor in interface EntityDescriptor
Returns:
the AuthnAuthorityDescriptor role descriptor

getAttributeAuthorityDescriptor

public AttributeAuthorityDescriptor getAttributeAuthorityDescriptor(String supportedProtocol)
Gets the first AttributeAuthorityDescriptor role descriptor for this entity that supports the given protocol.

Specified by:
getAttributeAuthorityDescriptor in interface EntityDescriptor
Returns:
the AttributeAuthorityDescriptor role descriptor

getPDPDescriptor

public PDPDescriptor getPDPDescriptor(String supportedProtocol)
Gets the first PDPDescriptor role descriptor for this entity that supports the given protocol.

Specified by:
getPDPDescriptor in interface EntityDescriptor
Returns:
the PDPDescriptor role descriptor

getAffiliationDescriptor

public AffiliationDescriptor getAffiliationDescriptor()
Gets the affiliation descriptor for this entity.

Specified by:
getAffiliationDescriptor in interface EntityDescriptor
Returns:
the affiliation descriptor for this entity

setAffiliationDescriptor

public void setAffiliationDescriptor(AffiliationDescriptor descriptor)
Sets the affiliation descriptor for this entity.

Specified by:
setAffiliationDescriptor in interface EntityDescriptor
Parameters:
descriptor - the affiliation descriptor for this entity

getOrganization

public Organization getOrganization()
Gets the organization for this entity.

Specified by:
getOrganization in interface EntityDescriptor
Returns:
the organization for this entity

setOrganization

public void setOrganization(Organization newOrganization)
Sets the organization for this entity.

Specified by:
setOrganization in interface EntityDescriptor
Parameters:
newOrganization - the organization for this entity

getContactPersons

public List<ContactPerson> getContactPersons()
Get the contact people for this entity.

Specified by:
getContactPersons in interface EntityDescriptor
Returns:
the contact people for this entity

getAdditionalMetadataLocations

public List<AdditionalMetadataLocation> getAdditionalMetadataLocations()
Gets the additional metadata locations for this entity.

Specified by:
getAdditionalMetadataLocations in interface EntityDescriptor
Returns:
the additional metadata locations for this entity

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


Copyright © 1999-2012. All Rights Reserved.