- All Superinterfaces:
XMLStructure
public interface XMLObject extends XMLStructure
A representation of the XMLObject
element as defined in the W3C Recommendation for XML-Signature Syntax and Processing. AnXMLObject
may 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>
XMLObject
instance may be created by invoking thenewXMLObject
method of theXMLSignatureFactory
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 thanObject
to avoid naming clashes with the existingjava.lang.Object
class.- Since:
- 1.6
- See Also:
XMLSignatureFactory.newXMLObject(List, String, String, String)
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<XMLStructure>
getContent()
Returns anunmodifiable list
ofXMLStructure
s contained in thisXMLObject
, which represent elements from any namespace.String
getEncoding()
Returns the encoding URI of thisXMLObject
.String
getId()
Returns the Id of thisXMLObject
.String
getMimeType()
Returns the mime type of thisXMLObject
.Methods declared in interface javax.xml.crypto.XMLStructure
isFeatureSupported
Field Detail
TYPE
static final String TYPE
URI that identifies theObject
element (this can be specified as the value of thetype
parameter of theReference
class to identify the referent's type).- See Also:
- Constant Field Values
Method Detail
getContent
List<XMLStructure> getContent()
Returns anunmodifiable list
ofXMLStructure
s 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: aSignatureProperties
element would be returned as an instance ofSignatureProperties
).- Returns:
- an unmodifiable list of
XMLStructure
s (may be empty but nevernull
)
getId
String getId()
Returns the Id of thisXMLObject
.- Returns:
- the Id (or
null
if 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
null
if 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
null
if not specified)