This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.xml.crypto.dsig
interface XMLObject

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


Field Summary
static String TYPE
          URI that identifies the Object element (this can be specified as the value of the type parameter of the javax.xml.crypto.dsig.Reference class to identify the referent's type).
 
Method Summary
 List

          Returns an java.util.Collections.unmodifiableList of javax.xml.crypto.XMLStructures contained in this XMLObject, which represent elements from any namespace.
 String

          Returns the encoding URI of this XMLObject.
 String

          Returns the Id of this XMLObject.
 String

          Returns the mime type of this XMLObject.
 
Methods inherited from class javax.xml.crypto.XMLStructure
isFeatureSupported
 

Field Detail

TYPE

public 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).
Method Detail

getContent

public List getContent()
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}).

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

getEncoding

public String 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)

getId

public String getId()
Returns the Id of this XMLObject.

Returns:
the Id (or null if not specified)

getMimeType

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:
the mime type (or null if not specified)


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.