Interface XMLObject
-
- All Superinterfaces:
- XMLStructure
public interface XMLObject extends XMLStructure
A representation of the XMLObjectelement as defined in the W3C Recommendation for XML-Signature Syntax and Processing. AnXMLObjectmay contain any data and may include optional MIME type, ID, and encoding attributes. The XML Schema Definition is defined as:
A<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>XMLObjectinstance may be created by invoking thenewXMLObjectmethod of theXMLSignatureFactoryclass; 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
XMLObjectrather thanObjectto avoid naming clashes with the existingjava.lang.Objectclass.- Since:
- 1.6
- See Also:
-
XMLSignatureFactory.newXMLObject(List, String, String, String)
-
-
Field Summary
Fields Modifier and Type Field and Description static StringTYPEURI that identifies theObjectelement (this can be specified as the value of thetypeparameter of theReferenceclass to identify the referent's type).
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description ListgetContent()Returns anunmodifiable listofXMLStructures contained in thisXMLObject, which represent elements from any namespace.StringgetEncoding()Returns the encoding URI of thisXMLObject.StringgetId()Returns the Id of thisXMLObject.StringgetMimeType()Returns the mime type of thisXMLObject.-
Methods inherited from interface javax.xml.crypto.XMLStructure
isFeatureSupported
-
-
-
-
Field Detail
TYPE
static final String TYPE
URI that identifies theObjectelement (this can be specified as the value of thetypeparameter of theReferenceclass to identify the referent's type).- See Also:
- Constant Field Values
-
Method Detail
getContent
List getContent()
Returns anunmodifiable listofXMLStructures contained in thisXMLObject, 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: aSignaturePropertieselement would be returned as an instance ofSignatureProperties).- Returns:
-
an unmodifiable list of
XMLStructures (may be empty but nevernull)
getId
String getId()
Returns the Id of thisXMLObject.- Returns:
-
the Id (or
nullif not specified)
getMimeType
String getMimeType()
Returns the mime type of thisXMLObject. The mime type is an optional attribute which describes the data within thisXMLObject(independent of its encoding).- Returns:
-
the mime type (or
nullif not specified)
getEncoding
String getEncoding()
Returns the encoding URI of thisXMLObject. The encoding URI identifies the method by which the object is encoded.- Returns:
-
the encoding URI (or
nullif 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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
