Skip navigation links

Oracle Fusion Middleware SAML 2.0 Java API Reference for Oracle Security Developer Tools
11g Release 1 (11.1.1)

E10676-05


oracle.security.xmlsec.saml2.metadata
Class EntityDescriptor

java.lang.Object
  extended by oracle.security.xmlsec.util.XMLNode
      extended by oracle.security.xmlsec.util.XMLElement
          extended by oracle.security.xmlsec.saml2.metadata.Descriptor
              extended by oracle.security.xmlsec.saml2.metadata.EntityDescriptor


public class EntityDescriptor
extends Descriptor

Represents the EntityDescriptor metadata element.


Field Summary

 

Fields inherited from class oracle.security.xmlsec.util.XMLNode
node, systemId

 

Constructor Summary
  EntityDescriptor(org.w3c.dom.Document owner)
          Creates a new EntityDescriptor instance.
protected EntityDescriptor(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName)
          Creates a new EntityDescriptor instance.
  EntityDescriptor(org.w3c.dom.Element element)
          Creates a new EntityDescriptor instance from the given Element node.
  EntityDescriptor(org.w3c.dom.Element element, java.lang.String systemId)
          Creates a new EntityDescriptor instance from the given Element node.

 

Method Summary
 void addAdditionalMetadataLocation(AdditionalMetadataLocation aml)
          Adds the location for additional metadata.
 void addContactPerson(ContactPerson cp)
          Adds a contact person.
 void addRoleDescriptor(RoleDescriptor rd)
          Adds a RoleDescriptor.
 java.util.List getAdditionalMetadataLocations()
          Returns the list of locations for additional metadata.
 AffiliationDescriptor getAffiliationDescriptor()
          Returns the PDPDescriptor list.
 java.util.List getAttributeAuthorityDescriptors()
          Returns the AttributeAuthorityDescriptor list.
 java.util.List getAuthnAuthorityDescriptors()
          Returns the AuthnAuthorityDescriptor list.
 java.util.List getContactPersons()
          Returns the list of contact persons.
 java.lang.String getEntityID()
          Returns the entity identifier.
 java.util.List getIDPSSODescriptors()
          Returns the IDPSSODescriptor list.
 Organization getOrganization()
          Returns the Organization.
 java.util.List getPDPDescriptors()
          Returns the PDPDescriptor list.
 java.util.List getRoleDescriptors()
          Returns the EntityDescriptor list.
 java.util.List getSPSSODescriptors()
          Returns the SPSSODescriptor list.
 void setAffiliationDescriptor(AffiliationDescriptor ad)
          Sets the affiliation information.
 void setEntityID(EntityID entity)
          Sets the entity identifier.
 void setOrganization(Organization org)
          Sets the Organization information.

 

Methods inherited from class oracle.security.xmlsec.saml2.metadata.Descriptor
addSignature, addSignature, clearSignature, getCacheDuration, getExtensions, getID, getSignature, getValidUntil, isSigned, setCacheDuration, setExtensions, setID, setValidUntil, sign, sign, verify, verify

 

Methods inherited from class oracle.security.xmlsec.util.XMLElement
addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix

 

Methods inherited from class oracle.security.xmlsec.util.XMLNode
appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

EntityDescriptor

public EntityDescriptor(org.w3c.dom.Element element)
                 throws org.w3c.dom.DOMException
Creates a new EntityDescriptor instance from the given Element node.
Parameters:
element - An EntityDescriptor element.
Throws:
org.w3c.dom.DOMException

EntityDescriptor

public EntityDescriptor(org.w3c.dom.Element element,
                        java.lang.String systemId)
                 throws org.w3c.dom.DOMException
Creates a new EntityDescriptor instance from the given Element node.
Parameters:
element - An EntityDescriptor element.
systemId - The URI string system ID for the EntityDescriptor.
Throws:
org.w3c.dom.DOMException

EntityDescriptor

public EntityDescriptor(org.w3c.dom.Document owner)
                 throws org.w3c.dom.DOMException
Creates a new EntityDescriptor instance.
Parameters:
owner - The owner document of the new EntityDescriptor.
Throws:
org.w3c.dom.DOMException

EntityDescriptor

protected EntityDescriptor(org.w3c.dom.Document owner,
                           java.lang.String nsURI,
                           java.lang.String localName)
                    throws org.w3c.dom.DOMException
Creates a new EntityDescriptor instance. This constructor is for use in subclass for extension of the EntityDescriptor element.
Parameters:
owner - The owner document of the new EntityDescriptor.
nsURI - The namespace URI in which the new EntityDescriptor is to be created.
localName - The localName of the element represented by the class that extends this class.
Throws:
org.w3c.dom.DOMException

Method Detail

addRoleDescriptor

public void addRoleDescriptor(RoleDescriptor rd)
Adds a RoleDescriptor.

The AffiliationDescriptor element will be deleted.

Parameters:
rd - The RoleDescriptor.

getRoleDescriptors

public java.util.List getRoleDescriptors()
Returns the EntityDescriptor list.
Returns:
A List of EntityDescriptor objects or null if none were found.

getIDPSSODescriptors

public java.util.List getIDPSSODescriptors()
Returns the IDPSSODescriptor list.
Returns:
A List of IDPSSODescriptor objects or null if none were found.

getSPSSODescriptors

public java.util.List getSPSSODescriptors()
Returns the SPSSODescriptor list.
Returns:
A List of SPSSODescriptor objects or null if none were found.

getAuthnAuthorityDescriptors

public java.util.List getAuthnAuthorityDescriptors()
Returns the AuthnAuthorityDescriptor list.
Returns:
A List of AuthnAuthorityDescriptor objects or null if none were found.

getAttributeAuthorityDescriptors

public java.util.List getAttributeAuthorityDescriptors()
Returns the AttributeAuthorityDescriptor list.
Returns:
A List of AttributeAuthorityDescriptor objects or null if none were found.

getPDPDescriptors

public java.util.List getPDPDescriptors()
Returns the PDPDescriptor list.
Returns:
A List of PDPDescriptor objects or null if none were found.

setAffiliationDescriptor

public void setAffiliationDescriptor(AffiliationDescriptor ad)
Sets the affiliation information.

All RoleDescriptor elements will be deleted.

Parameters:
ad - A AffiliationDescriptor object.

getAffiliationDescriptor

public AffiliationDescriptor getAffiliationDescriptor()
Returns the PDPDescriptor list.
Returns:
A List of PDPDescriptor objects or null if none were found.

setOrganization

public void setOrganization(Organization org)
Sets the Organization information.
Parameters:
org - A Organization object.

getOrganization

public Organization getOrganization()
Returns the Organization.
Returns:
A Organization object or null if not was found.

addContactPerson

public void addContactPerson(ContactPerson cp)
Adds a contact person.
Parameters:
cp - A ContactPerson.

getContactPersons

public java.util.List getContactPersons()
Returns the list of contact persons.
Returns:
A List of ContactPerson objects or null if none was found.

addAdditionalMetadataLocation

public void addAdditionalMetadataLocation(AdditionalMetadataLocation aml)
Adds the location for additional metadata.
Parameters:
aml - The AdditionalMetadataLocation object to add.

getAdditionalMetadataLocations

public java.util.List getAdditionalMetadataLocations()
Returns the list of locations for additional metadata.
Returns:
A List of AdditionalMetadataLocation objects or null if none were found.

setEntityID

public void setEntityID(EntityID entity)
Sets the entity identifier.
Parameters:
entity - The entity identifier.

getEntityID

public java.lang.String getEntityID()
Returns the entity identifier.
Returns:
The entity identifier String.

Skip navigation links

Oracle Fusion Middleware SAML 2.0 Java API Reference for Oracle Security Developer Tools
11g Release 1 (11.1.1)

E10676-05


Copyright © 2005, 2013 , Oracle. All rights reserved.