Skip navigation links

oracle.security.xmlsec.liberty.v12.metadata
Class AffiliationDescriptor

java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.liberty.v12.metadata.AffiliationDescriptor

public class AffiliationDescriptor

extends oracle.security.xmlsec.util.XMLElement

Liberty 1.2 libMD:AffiliationDescriptor element.

Field Summary

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

node, systemId

Constructor Summary

AffiliationDescriptor(org.w3c.dom.Document owner)
Creates a new AffiliationDescriptor instance within the specified XML Document.

AffiliationDescriptor(org.w3c.dom.Document owner, java.lang.String affiliationOwnerID)
Creates a new AffiliationDescriptor instance within the specified XML Document.

AffiliationDescriptor(org.w3c.dom.Element element)
Creates a new AffiliationDescriptor instance from the given Element node.

AffiliationDescriptor(org.w3c.dom.Element element, java.lang.String systemId)
Creates a new AffiliationDescriptor instance from the given Element node.

Method Summary

void	addAffiliateMember(java.lang.String providerID) Adds a member entity to this AffiliateDescriptor.
void	addKeyDescriptor(KeyDescriptor keyDesc) Adds a KeyDescriptor child element to this AffiliationDescriptor.
oracle.security.xmlsec.dsig.XSSignature	addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod, java.lang.String digestMethod) Adds a ds:Signature to this AffiliationDescriptor, replacing any existing signature.
java.util.List	getAffiliateMembers() Returns the list of member entities for this AffiliateDescriptor.
java.lang.String	getAffiliationOwnerID() Returns the AffiliationOwnerID attribute value for the affiliation group.
java.lang.String	getCacheDuration() Returns the cacheDuration attribute of this AffiliationDescriptor.
java.lang.String	getId() Returns the "id" attribute of this AffiliationDescriptor, for use as the target of a ds:Signature.
java.util.List	getKeyDescriptors() Returns a list of the KeyDescriptor elements contained in this AffiliationDescriptor.
oracle.security.xmlsec.dsig.XSSignature	getSignature() Returns the XML Signature child element from this AffiliationDescriptor element.
java.util.Date	getValidUntil() Returns the validUntil attribute of this AffiliationDescriptor, indicating the expiration of the metadata.
void	setAffiliationOwnerID(java.lang.String affiliationOwnerID) Sets the AffiliationOwnerID attribute for the affiliation group.
void	setCacheDuration(java.lang.String duration) Sets the cacheDuration attribute of this AffiliationDescriptor.
void	setId(java.lang.String id) Sets the "id" attribute of this AffiliationDescriptor, for use as the target of a ds:Signature.
void	setValidUntil(java.util.Date validUntil) Sets the validUntil attribute of this AffiliationDescriptor, 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

AffiliationDescriptor

public AffiliationDescriptor(org.w3c.dom.Element element)
                      throws org.w3c.dom.DOMException

Creates a new AffiliationDescriptor instance from the given Element node.

Parameters:

element - A Liberty AffiliationDescriptor XML element.

Throws:

org.w3c.dom.DOMException

AffiliationDescriptor

public AffiliationDescriptor(org.w3c.dom.Element element,
                             java.lang.String systemId)
                      throws org.w3c.dom.DOMException

Creates a new AffiliationDescriptor instance from the given Element node.

Parameters:

element - A Liberty AffiliationDescriptor XML element.

systemId - The URI string system ID for the AffiliationDescriptor.

Throws:

org.w3c.dom.DOMException

AffiliationDescriptor

public AffiliationDescriptor(org.w3c.dom.Document owner)
                      throws org.w3c.dom.DOMException

Creates a new AffiliationDescriptor instance within the specified XML Document.

Parameters:

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

Throws:

org.w3c.dom.DOMException

AffiliationDescriptor

public AffiliationDescriptor(org.w3c.dom.Document owner,
                             java.lang.String affiliationOwnerID)
                      throws org.w3c.dom.DOMException

Creates a new AffiliationDescriptor instance within the specified XML Document.

Parameters:

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

affiliationOwnerID - The affiliationOwnerID attribute value.

Throws:

org.w3c.dom.DOMException

Method Detail

setAffiliationOwnerID

public void setAffiliationOwnerID(java.lang.String affiliationOwnerID)
                           throws org.w3c.dom.DOMException

Sets the AffiliationOwnerID attribute for the affiliation group.

Parameters:

affiliationOwnerID - The providerID of the affiliation's owner or parent operator.

Throws:

org.w3c.dom.DOMException

getAffiliationOwnerID

public java.lang.String getAffiliationOwnerID()

Returns the AffiliationOwnerID attribute value for the affiliation group.

Returns:

The providerID of the affiliation's owner or parent operator.

setId

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

Sets the "id" attribute of this AffiliationDescriptor, 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 AffiliationDescriptor, for use as the target of a ds:Signature.

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 AffiliationDescriptor, 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 AffiliationDescriptor, indicating the expiration of the metadata.

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

Parameters:

duration - The cacheDuration attribute value.

Throws:

org.w3c.dom.DOMException

getCacheDuration

public java.lang.String getCacheDuration()

Returns the cacheDuration attribute of this AffiliationDescriptor.

Returns:

The cacheDuration attribute value.

addAffiliateMember

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

Adds a member entity to this AffiliateDescriptor.

Parameters:

providerID - The member entity's providerID URI string.

Throws:

org.w3c.dom.DOMException

getAffiliateMembers

public java.util.List getAffiliateMembers()

Returns the list of member entities for this AffiliateDescriptor.

Returns:

A List of member entities' providerID URI strings.

addKeyDescriptor

public void addKeyDescriptor(KeyDescriptor keyDesc)

Adds a KeyDescriptor child element to this AffiliationDescriptor.

Parameters:

keyDesc - The KeyDescriptor instance.

getKeyDescriptors

public java.util.List getKeyDescriptors()

Returns a list of the KeyDescriptor elements contained in this AffiliationDescriptor.

Returns:

A List of KeyDescriptor objects.

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 ds:Signature to this AffiliationDescriptor, replacing any existing signature. The ds: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 object can be used to add a ds:KeyInfo containing, for example, the signer's public key certificate.

See XMLURI for algorithm URI string constants.

Note: This AffiliationDescriptor 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 AffiliationDescriptor.

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 AffiliationDescriptor element.

Returns:

A XSSignature object or null if no signature is present.

Skip navigation links