iaik.ixsil.core

Class Object

java.lang.Object

iaik.ixsil.core.Container

iaik.ixsil.core.Object

public class Object
extends Container

Implementation of a XML Signature object container (XML element "Object"). An Object element can have any XML structure as its content. Three attributes can be optionally specified, as there are "Id", "MimeType", and "Encoding".

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addedToSignature_ Signals if this object container has already been added to a signature.
protected java.util.Set	containedElemsWithID_ A set of all DOM elements contained by this object container, which have its ID attribute set.
protected java.lang.String	encoding_ Value for the "Encoding" attribute of the XML Object element.
protected java.lang.String	id_ Value for the "Id" attribute of the XML Object element.
protected java.lang.String	mimeType_ Value for the "MimeType" attribute of the XML Object element.

Fields inherited from class iaik.ixsil.core.Container

containerDOMElem_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Object(org.w3c.dom.Document owningDoc, org.w3c.dom.DocumentFragment content) Creates a new object container with the specified DOM document fragment as its content.
protected	Object(org.w3c.dom.Document owningDoc, org.w3c.dom.Element content) Creates a new object container with the specified DOM element as its child.
protected	Object(org.w3c.dom.Document owningDoc, iaik.ixsil.core.Manifest manifest) Create a new object container with the specified manifest as its content.
protected	Object(org.w3c.dom.Document owningDoc, SignatureProperties signatureProperties) Create a new object container with the specified signature property container as its content.
protected	Object(org.w3c.dom.Document owningDoc, java.lang.String content) Creates a new object container with the specified string value as DOM text child of the Object element.
protected	Object(org.w3c.dom.Element objectDOMElem, org.w3c.dom.Document owningDoc) Creates a new object container from the specified Object DOM element.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getEncoding() Gets the Encoding attribute value of the Object element.
java.lang.String	getId() Gets the Id attribute value of the Object element.
java.lang.String	getMimeType() Gets the MimeType attribute value of the Object element.
void	setEncoding(java.lang.String encoding) Sets the Encoding attribute of this object container.
void	setId(java.lang.String id) Sets the Id attribute of this object container.
void	setMimeType(java.lang.String mimeType) Sets the MimeType attribute of this object container.

Methods inherited from class iaik.ixsil.core.Container

toElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id_

protected java.lang.String id_

Value for the "Id" attribute of the XML Object element.

mimeType_

protected java.lang.String mimeType_

Value for the "MimeType" attribute of the XML Object element.

encoding_

protected java.lang.String encoding_

Value for the "Encoding" attribute of the XML Object element.

containedElemsWithID_

protected java.util.Set containedElemsWithID_

A set of all DOM elements contained by this object container, which have its ID attribute set.

addedToSignature_

protected boolean addedToSignature_

Signals if this object container has already been added to a signature.

Constructor Detail

Object

protected Object(org.w3c.dom.Element objectDOMElem,
      org.w3c.dom.Document owningDoc)

Creates a new object container from the specified Object DOM element.

Parameters:

objectDOMElem - The DOM element representation of the object container.

owningDoc - The DOM document which should be used to create necessary DOM nodes.

Object

protected Object(org.w3c.dom.Document owningDoc,
      java.lang.String content)

Creates a new object container with the specified string value as DOM text child of the Object element.

Parameters:

owningDoc - The DOM document which should be used to create necessary DOM nodes.

content - The value for the DOM text child.

Object

protected Object(org.w3c.dom.Document owningDoc,
      org.w3c.dom.Element content)

Creates a new object container with the specified DOM element as its child.

Parameters:

owningDoc - The DOM document which should be used to create necessary DOM nodes.

content - Contains the DOM element which will become the single child node of the Object.

Object

protected Object(org.w3c.dom.Document owningDoc,
      org.w3c.dom.DocumentFragment content)

Creates a new object container with the specified DOM document fragment as its content.

Parameters:

owningDoc - The DOM document which should be used to create necessary DOM nodes.

content - Contains the DOM document fragment which children will become the child nodes of the Object.

Object

protected Object(org.w3c.dom.Document owningDoc,
      SignatureProperties signatureProperties)

Create a new object container with the specified signature property container as its content.

Parameters:

owningDoc - The DOM document which should be used to create necessary DOM nodes.

signatureProperties - The signature property container which is set as the content of this object container.

Object

protected Object(org.w3c.dom.Document owningDoc,
      iaik.ixsil.core.Manifest manifest)

Create a new object container with the specified manifest as its content.

Parameters:

owningDoc - The DOM document which should be used to create necessary DOM nodes.

manifest - The manifest which is set as the content of this object container.

Method Detail

getId

public java.lang.String getId()

Gets the Id attribute value of the Object element.

Returns:

the attribute value or null if the Id attribute is not available.

setId

public void setId(java.lang.String id)

Sets the Id attribute of this object container. If the attribute has been already set, its value will be overwritten. If the specified value is null, the attribute will be removed. If the object container has already been added to a SignerSignature, this method will have no effect.

Parameters:

id - The value for the Id attribute.

getMimeType

public java.lang.String getMimeType()

Gets the MimeType attribute value of the Object element.

Returns:

the attribute value or null if the MimeType attribute is not available.

setMimeType

public void setMimeType(java.lang.String mimeType)

Sets the MimeType attribute of this object container. If the attribute has been already set, its value will be overwritten. If the specified value is null, the attribute will be removed.

Parameters:

mimeType - The value for the MimeType attribute.

getEncoding

public java.lang.String getEncoding()

Gets the Encoding attribute value of the Object element.

Returns:

the attribute value or null if the Encoding attribute is not available.

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the Encoding attribute of this object container. If the attribute has been already set, its value will be overwritten. If the specified value is null, the attribute will be removed.

Parameters:

encoding - The value for the Encoding attribute.