| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
getId() 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 |
---|
public static final String TYPE
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 |
---|
public List getContent()
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}).
XMLStructure
s (may be empty
but never null
)public String getEncoding()
XMLObject
. The encoding
URI identifies the method by which the object is encoded.
null
if not specified)public String getId()
XMLObject
.
null
if not specified)public String getMimeType()
XMLObject
. The
mime type is an optional attribute which describes the data within this
XMLObject
(independent of its encoding).
null
if not specified)
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |