APIdia Launch Partner
Top Description Fields Methods
javax.xml.crypto.dsig

public Interface XMLObject

extends XMLStructure
Known Direct Implementers
org.jcp.xml.dsig.internal.dom.DOMXMLObject
Imports
java.util.List, javax.xml.crypto.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 newXMLObject method of the XMLSignatureFactory class; for example: 
  XMLSignatureFactory fac = XMLSignatureFactory.getInstance("DOM");
  Manifest manifest = fac.newManifest(references);
  List<XMLStructure> content = Collections.singletonList(manifest);
  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 java.lang.Object class.

Authors
Sean Mullan, JSR 105 Expert Group, Joyce L. Leung
Since
1.6
See Also
XMLSignatureFactory#newXMLObject(List, String, String, String)

Field Summary

Modifier and TypeField and Description
public static final String
TYPE

URI that identifies the Object element (this can be specified as the value of the type parameter of the Reference class to identify the referent's type).

Method Summary

Modifier and TypeMethod and Description
public List<XMLStructure>

Returns:

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

Returns an unmodifiable list of XMLStructures contained in this XMLObject, which represent elements from any namespace.

public String

Returns:

the encoding URI (or null if not specified)
getEncoding()

Returns the encoding URI of this XMLObject.

public String

Returns:

the Id (or null if not specified)
getId()

Returns the Id of this XMLObject.

public String

Returns:

the mime type (or null if not specified)
getMimeType()

Returns the mime type of this XMLObject.

Inherited from javax.xml.crypto.XMLStructure:
isFeatureSupported

Field Detail

TYPEback to summary
public static final String TYPE

URI that identifies the Object element (this can be specified as the value of the type parameter of the Reference class to identify the referent's type).

Method Detail

getContentback to summary
public List<XMLStructure> getContent()

Returns an unmodifiable list of XMLStructures 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 javax.xml.crypto.dsig.SignatureProperties).

Returns:List<XMLStructure>

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

getEncodingback to summary
public String getEncoding()

Returns the encoding URI of this XMLObject. The encoding URI identifies the method by which the object is encoded.

Returns:String

the encoding URI (or null if not specified)

getIdback to summary
public String getId()

Returns the Id of this XMLObject.

Returns:String

the Id (or null if not specified)

getMimeTypeback to summary
public String getMimeType()

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

Returns:String

the mime type (or null if not specified)