oracle.security.xmlsec.liberty.v12.metadata

Class EntityDescriptor

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.liberty.v12.metadata.EntityDescriptor

public class EntityDescriptor
extends oracle.security.xmlsec.util.XMLElement

Liberty 1.2 libMD:EntityDescriptor element.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

Constructors

Constructor and Description
EntityDescriptor(org.w3c.dom.Document owner) Creates a new EntityDescriptor instance within the specified XML Document.
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

Methods

Modifier and Type	Method and Description
void	addIDPDescriptor(IDPDescriptor descriptor) Adds an IDPDescriptor element for the entity's identity provider.
oracle.security.xmlsec.dsig.XSSignature	addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod, java.lang.String digestMethod) Adds a dsig:Signature to this EntityDescriptor, replacing any existing signature.
void	addSPDescriptor(SPDescriptor descriptor) Adds a SPDescriptor element for the entity's service provider.
AffiliationDescriptor	getAffiliationDescriptor() Returns the AffiliationDescriptor element for the entity's affiliation group, or null if no AffiliationDescriptor element is present.
java.lang.String	getCacheDuration() Returns the cacheDuration attribute of this EntityDescriptor, or null if the attribute is not specified.
ContactPerson	getContactPerson() Returns the ContactPerson element for the entity, or null if no ContactPerson element is present.
java.lang.String	getId() Returns the "id" attribute of this EntityDescriptor, for use as the target of a ds:Signature, or null if the attribute is not specified.
java.util.List	getIDPDescriptors() Returns a List of IDPDescriptor elements for the entity's identity provider.
Organization	getOrganization() Returns the Organization element for the entity, or null if no Organization element is present.
java.lang.String	getProviderID() Returns the providerID of the entity whose metadata is represented by this EntityDescriptor.
oracle.security.xmlsec.dsig.XSSignature	getSignature() Returns the XML Signature child element from this EntityDescriptor element, or null if no XML Signature element is present.
java.util.List	getSPDescriptors() Returns a List of SPDescriptor elements for the entity's service provider.
java.util.Date	getValidUntil() Returns the validUntil attribute of this EntityDescriptor, indicating the expiration of the metadata, or null if the attribute is not specified.
void	setAffiliationDescriptor(AffiliationDescriptor descriptor) Sets the AffiliationDescriptor element for the entity's affiliation group.
void	setCacheDuration(java.lang.String duration) Sets the cacheDuration attribute of this EntityDescriptor.
void	setContactPerson(ContactPerson contact) Sets the ContactPerson element for the entity.
void	setId(java.lang.String id) Sets the "id" attribute of this EntityDescriptor, for use as the target of a ds:Signature.
void	setOrganization(Organization organization) Sets the Organization element for the entity.
void	setProviderID(java.lang.String providerID) Sets the providerID of the entity whose metadata is represented by this EntityDescriptor.
void	setValidUntil(java.util.Date validUntil) Sets the validUntil attribute of this EntityDescriptor, indicating the expiration of the metadata.

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 - A Liberty EntityDescriptor XML 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 - A Liberty EntityDescriptor XML 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 within the specified XML Document.

Parameters:

owner - The owner document of the new Liberty EntityDescriptor element.

Throws:

org.w3c.dom.DOMException

Method Detail

setProviderID

public void setProviderID(java.lang.String providerID)
                   throws org.w3c.dom.DOMException

Sets the providerID of the entity whose metadata is represented by this EntityDescriptor.

Parameters:

providerID - The providerID attribute URI string value.

Throws:

org.w3c.dom.DOMException

getProviderID

public java.lang.String getProviderID()

Returns the providerID of the entity whose metadata is represented by this EntityDescriptor.

Returns:

The providerID attribute URI string value, or null if none is set.

setId

public void setId(java.lang.String id)
           throws org.w3c.dom.DOMException

Sets the "id" attribute of this EntityDescriptor, for use as the target of a ds:Signature.

Parameters:

id - The "id" attribute's ID value.

Throws:

org.w3c.dom.DOMException

getId

public java.lang.String getId()

Returns the "id" attribute of this EntityDescriptor, for use as the target of a ds:Signature, or null if the attribute is not specified.

Returns:

The "id" attribute's ID value.

setValidUntil

public void setValidUntil(java.util.Date validUntil)
                   throws org.w3c.dom.DOMException

Sets the validUntil attribute of this EntityDescriptor, indicating the expiration of the metadata.

Parameters:

validUntil - The validUntil attribute's dateTime value.

Throws:

org.w3c.dom.DOMException

getValidUntil

public java.util.Date getValidUntil()

Returns the validUntil attribute of this EntityDescriptor, indicating the expiration of the metadata, or null if the attribute is not specified.

Returns:

The validUntil attribute's dateTime value.

setCacheDuration

public void setCacheDuration(java.lang.String duration)
                      throws org.w3c.dom.DOMException

Sets the cacheDuration attribute of this EntityDescriptor.

Parameters:

duration - The cacheDuration attribute value.

Throws:

org.w3c.dom.DOMException

getCacheDuration

public java.lang.String getCacheDuration()

Returns the cacheDuration attribute of this EntityDescriptor, or null if the attribute is not specified.

Returns:

The cacheDuration attribute value.

addSPDescriptor

public void addSPDescriptor(SPDescriptor descriptor)
                     throws org.w3c.dom.DOMException

Adds a SPDescriptor element for the entity's service provider.

Parameters:

descriptor - The SPDescriptor instance.

Throws:

org.w3c.dom.DOMException

getSPDescriptors

public java.util.List getSPDescriptors()

Returns a List of SPDescriptor elements for the entity's service provider.

Returns:

The List instance.

addIDPDescriptor

public void addIDPDescriptor(IDPDescriptor descriptor)
                      throws org.w3c.dom.DOMException

Adds an IDPDescriptor element for the entity's identity provider.

Parameters:

descriptor - The IDPDescriptor instance.

Throws:

org.w3c.dom.DOMException

getIDPDescriptors

public java.util.List getIDPDescriptors()

Returns a List of IDPDescriptor elements for the entity's identity provider.

Returns:

The List instance.

setAffiliationDescriptor

public void setAffiliationDescriptor(AffiliationDescriptor descriptor)
                              throws org.w3c.dom.DOMException

Sets the AffiliationDescriptor element for the entity's affiliation group.

Parameters:

descriptor - The AffiliationDescriptor instance.

Throws:

org.w3c.dom.DOMException

getAffiliationDescriptor

public AffiliationDescriptor getAffiliationDescriptor()

Returns the AffiliationDescriptor element for the entity's affiliation group, or null if no AffiliationDescriptor element is present.

Returns:

The AffiliationDescriptor instance.

setContactPerson

public void setContactPerson(ContactPerson contact)
                      throws org.w3c.dom.DOMException

Sets the ContactPerson element for the entity.

Parameters:

contact - The ContactPerson instance.

Throws:

org.w3c.dom.DOMException

getContactPerson

public ContactPerson getContactPerson()

Returns the ContactPerson element for the entity, or null if no ContactPerson element is present.

Returns:

The ContactPerson instance.

setOrganization

public void setOrganization(Organization organization)
                     throws org.w3c.dom.DOMException

Sets the Organization element for the entity.

Parameters:

organization - The Organization instance.

Throws:

org.w3c.dom.DOMException

getOrganization

public Organization getOrganization()

Returns the Organization element for the entity, or null if no Organization element is present.

Returns:

The Organization instance.

addSignature

public oracle.security.xmlsec.dsig.XSSignature addSignature(java.lang.String signatureMethod,
                                                   java.lang.String c14nMethod,
                                                   java.lang.String digestMethod)
                                                     throws org.w3c.dom.DOMException,
                                                            oracle.security.xmlsec.dsig.SigningException

Adds a dsig:Signature to this EntityDescriptor, replacing any existing signature. The dsig:SignatureValue is not calculated here so, at a minimum, one of the sign() methods must be invoked on the returned oracle.security.xmlsec.dsig.XSSignature object. The XSSignature can be used to add a dsig:KeyInfo containing, for example, the signer's public key certificate.

See XMLURI for algorithm URI string constants.

Note: This EntityDescriptor must have an "id" attribute to be used as the target of the new signature's Reference element. If no "id" attribute is present, a SigningException is thrown.

Parameters:

signatureMethod - The URI identifying the signature algorithm to be used.

c14nMethod - The URI identifying the canonicalization algorithm to be used.

digestMethod - The URI identifying the message digest algorithm to be used.

Returns:

The newly created signature.

Throws:

oracle.security.xmlsec.dsig.SigningException - If no "id" attribute has been set for this EntityDescriptor.

org.w3c.dom.DOMException

See Also:

XSSignature, XSKeyInfo, XMLURI

getSignature

public oracle.security.xmlsec.dsig.XSSignature getSignature()

Returns the XML Signature child element from this EntityDescriptor element, or null if no XML Signature element is present.

Returns:

A XSSignature object or null if no signature is present.