Interface Reference

All Known Implementing Classes:
XMLCipher.Factory.ReferenceListImpl.DataReference, XMLCipher.Factory.ReferenceListImpl.KeyReference, XMLCipher.Factory.ReferenceListImpl.ReferenceImpl

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:

 
     
         
     
     
 
 
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Adds retrieval information.
    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.
    Returns the Element tag name for this Reference.
    Returns a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element.
    void
    Removes the specified retrieval information.
    void
    Sets a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element.
  • Method Details

    • getType

      String getType()
      Returns the Element tag name for this Reference.
      Returns:
      the tag name of this Reference.
    • getURI

      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

      void setURI(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

      Iterator<Element> 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

      void addElementRetrievalInformation(Element info)
      Adds retrieval information.
      Parameters:
      info -
    • removeElementRetrievalInformation

      void removeElementRetrievalInformation(Element info)
      Removes the specified retrieval information.
      Parameters:
      info -