FileDocCategorySizeDatePackage
XMLObject.javaAPI DocJava SE 6 API3934Tue Jun 10 00:27:06 BST 2008javax.xml.crypto.dsig

XMLObject

public interface XMLObject implements XMLStructure
A representation of the XML Object element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. An XMLObject may contain any data and may include optional MIME type, ID, and encoding attributes. The XML Schema Definition is defined as:

<element name="Object" type="ds:ObjectType"/>
<complexType name="ObjectType" mixed="true">
<sequence minOccurs="0" maxOccurs="unbounded">
<any namespace="##any" processContents="lax"/>
</sequence>
<attribute name="Id" type="ID" use="optional"/>
<attribute name="MimeType" type="string" use="optional"/>
<attribute name="Encoding" type="anyURI" use="optional"/>
</complexType>
A XMLObject instance may be created by invoking the {@link XMLSignatureFactory#newXMLObject newXMLObject} method of the {@link XMLSignatureFactory} class; for example:
XMLSignatureFactory fac = XMLSignatureFactory.getInstance("DOM");
List content = Collections.singletonList(fac.newManifest(references)));
XMLObject object = factory.newXMLObject(content, "object-1", null, null);

Note that this class is named XMLObject rather than Object to avoid naming clashes with the existing {@link java.lang.Object java.lang.Object} class.

author
Sean Mullan
author
JSR 105 Expert Group
author
Joyce L. Leung
since
1.6
see
XMLSignatureFactory#newXMLObject(List, String, String, String)

Fields Summary
static final String
TYPE
URI that identifies the Object element (this can be specified as the value of the type parameter of the {@link Reference} class to identify the referent's type).
Constructors Summary
Methods Summary
public java.util.ListgetContent()
Returns an {@link java.util.Collections#unmodifiableList unmodifiable list} of {@link XMLStructure}s contained in this XMLObject, which represent elements from any namespace.

If there is a public subclass representing the type of XMLStructure, it is returned as an instance of that class (ex: a SignatureProperties element would be returned as an instance of {@link javax.xml.crypto.dsig.SignatureProperties}).

return
an unmodifiable list of XMLStructures (may be empty but never null)

public java.lang.StringgetEncoding()
Returns the encoding URI of this XMLObject. The encoding URI identifies the method by which the object is encoded.

return
the encoding URI (or null if not specified)

public java.lang.StringgetId()
Returns the Id of this XMLObject.

return
the Id (or null if not specified)

public java.lang.StringgetMimeType()
Returns the mime type of this XMLObject. The mime type is an optional attribute which describes the data within this XMLObject (independent of its encoding).

return
the mime type (or null if not specified)