XMLObject (Java Platform SE 8 ) (original) (raw)

• All Superinterfaces:
  XMLStructure

public interface XMLObject
extends 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 thenewXMLObject method of theXMLSignatureFactory 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 thanObject to avoid naming clashes with the existingjava.lang.Object class.
Since:
1.6
See Also:
XMLSignatureFactory.newXMLObject(List, String, String, String)

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static String	TYPE	URI that identifies the Object element (this can be specified as the value of the type parameter of theReference class to identify the referent's type).

  • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  List	getContent()	Returns an unmodifiable list of XMLStructures contained in this XMLObject, which represent elements from any namespace.
  String	getEncoding()	Returns the encoding URI of this XMLObject.
  String	getId()	Returns the Id of this XMLObject.
  String	getMimeType()	Returns the mime type of this XMLObject.

     * ### Methods inherited from interface javax.xml.crypto.[XMLStructure](../../../../javax/xml/crypto/XMLStructure.html "interface in javax.xml.crypto")  
     `[isFeatureSupported](../../../../javax/xml/crypto/XMLStructure.html#isFeatureSupported-java.lang.String-)`

• • Field Detail

     * #### TYPE  
     static final [String](../../../../java/lang/String.html "class in java.lang") TYPE  
     URI that identifies the `Object` element (this can be specified as the value of the `type` parameter of the[Reference](../../../../javax/xml/crypto/dsig/Reference.html "interface in javax.xml.crypto.dsig") class to identify the referent's type).  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.crypto.dsig.XMLObject.TYPE)  

  • Method Detail

    * #### getContent  
    [List](../../../../java/util/List.html "interface in java.util") getContent()  
    Returns an [unmodifiable list](../../../../java/util/Collections.html#unmodifiableList-java.util.List-) of [XMLStructure](../../../../javax/xml/crypto/XMLStructure.html "interface in javax.xml.crypto")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 [SignatureProperties](../../../../javax/xml/crypto/dsig/SignatureProperties.html "interface in javax.xml.crypto.dsig")).  
    Returns:  
    an unmodifiable list of `XMLStructure`s (may be empty but never `null`)  
    * #### getId  
    [String](../../../../java/lang/String.html "class in java.lang") getId()  
    Returns the Id of this `XMLObject`.  
    Returns:  
    the Id (or `null` if not specified)  
    * #### getMimeType  
    [String](../../../../java/lang/String.html "class in java.lang") 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:  
    the mime type (or `null` if not specified)  
    * #### getEncoding  
    [String](../../../../java/lang/String.html "class in java.lang") getEncoding()  
    Returns the encoding URI of this `XMLObject`. The encoding URI identifies the method by which the object is encoded.  
    Returns:  
    the encoding URI (or `null` if not specified)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.