org.apache.xml.security.encryption
Interface Reference

public interface Reference

A wrapper for a pointer from a key value of an EncryptedKey to items encrypted by that key value (EncryptedData or EncryptedKey elements).

It is defined as follows:

<complexType name='ReferenceType'> <sequence> <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/> </sequence> <attribute name='URI' type='anyURI' use='required'/> </complexType>

Author:

Axl Mattheus

See Also:

ReferenceList

Method Summary

void	addElementRetrievalInformation(org.w3c.dom.Element info) Adds retrieval information.
java.util.Iterator	getElementRetrievalInformation() Returns an Iterator over all the child elements contained in this Reference that will aid the recipient in retrieving the EncryptedKey and/or EncryptedData elements.
java.lang.String	getURI() Returns a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element.
void	removeElementRetrievalInformation(org.w3c.dom.Element info) Removes the specified retrieval information.
void	setURI(java.lang.String uri) Sets a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element.

Method Detail

getURI

public java.lang.String getURI()

Returns a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element.

Returns:

an Uniform Resource Identifier that qualifies an EncryptedType.

setURI

public void setURI(java.lang.String uri)

Sets a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element.

Parameters:

uri - the Uniform Resource Identifier that qualifies an EncryptedType.

getElementRetrievalInformation

public java.util.Iterator getElementRetrievalInformation()

Returns an Iterator over all the child elements contained in this Reference that will aid the recipient in retrieving the EncryptedKey and/or EncryptedData elements. These could include information such as XPath transforms, decompression transforms, or information on how to retrieve the elements from a document storage facility.

Returns:

child elements.

addElementRetrievalInformation

public void addElementRetrievalInformation(org.w3c.dom.Element info)

Adds retrieval information.

removeElementRetrievalInformation

public void removeElementRetrievalInformation(org.w3c.dom.Element info)

Removes the specified retrieval information.