xades4j.properties
Class DataObjectFormatProperty

java.lang.Object
  extended by xades4j.properties.DataObjectProperty
      extended by xades4j.properties.SignedDataObjectProperty
          extended by xades4j.properties.DataObjectFormatProperty
All Implemented Interfaces:
QualifyingProperty

public class DataObjectFormatProperty
extends SignedDataObjectProperty

Represents the DataObjectFormat signed data object property. The DataObjectFormat element provides information that describes the format of the signed data object. When presenting signed data to a human user it may be important that there is no ambiguity as to the presentation of the signed data object to the relying party. In order for the appropriate representation (text, sound or video) to be selected by the relying party a content hint may be indicated by the signer.

A XAdES signature may contain more than one DataObjectFormat elements, each one qualifying one signed data object.

This property is associated with the corresponding data object via the withDataObjectFormat method of the DataObjectDesc class.

Author:
Luís

Nested Class Summary
 
Nested classes/interfaces inherited from class xades4j.properties.DataObjectProperty
DataObjectProperty.TargetMultiplicity
 
Field Summary
static String PROP_NAME
           
 
Fields inherited from interface xades4j.properties.QualifyingProperty
QUALIFYING_PROPS_REF_TAG, QUALIFYING_PROPS_TAG, SIGNED_DATAOBJ_PROPS_TAG, SIGNED_PROPS_TAG, SIGNED_PROPS_TYPE_URI, SIGNED_SIGNATURE_PROPS_TAG, TARGET_ATTR, UNSIGNED_DATAOBJ_PROPS_TAG, UNSIGNED_PROPS_TAG, UNSIGNED_SIGNATURE_PROPS_TAG, XADES_XMLNS, XADESV141_XMLNS
 
Constructor Summary
DataObjectFormatProperty()
           
DataObjectFormatProperty(String mimeType)
           
DataObjectFormatProperty(String mimeType, String encoding)
           
 
Method Summary
 String getDescription()
           
 Collection<String> getDocumentationUris()
           
 String getEncoding()
           
 ObjectIdentifier getIdentifier()
           
 String getMimeType()
           
 String getName()
          Gets the name of the property, as specified in XAdES (the element name).
 DataObjectFormatProperty withDescription(String description)
           
 DataObjectFormatProperty withDocumentationUri(String documentationUri)
           
 DataObjectFormatProperty withDocumentationUris(Collection<String> documentationUris)
           
 DataObjectFormatProperty withIdentifier(ObjectIdentifier identifier)
           
 DataObjectFormatProperty withIdentifier(String identifier)
           
 DataObjectFormatProperty withIdentifier(String identifier, IdentifierType identifierType)
           
 
Methods inherited from class xades4j.properties.SignedDataObjectProperty
isSigned
 
Methods inherited from class xades4j.properties.DataObjectProperty
getTargetDataObjects, isSignature
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_NAME

public static final String PROP_NAME
See Also:
Constant Field Values
Constructor Detail

DataObjectFormatProperty

public DataObjectFormatProperty(String mimeType)

DataObjectFormatProperty

public DataObjectFormatProperty(String mimeType,
                                String encoding)

DataObjectFormatProperty

public DataObjectFormatProperty()
Method Detail

withIdentifier

public DataObjectFormatProperty withIdentifier(ObjectIdentifier identifier)

withIdentifier

public DataObjectFormatProperty withIdentifier(String identifier,
                                               IdentifierType identifierType)

withIdentifier

public DataObjectFormatProperty withIdentifier(String identifier)

withDescription

public DataObjectFormatProperty withDescription(String description)

withDocumentationUri

public DataObjectFormatProperty withDocumentationUri(String documentationUri)

withDocumentationUris

public DataObjectFormatProperty withDocumentationUris(Collection<String> documentationUris)

getDocumentationUris

public Collection<String> getDocumentationUris()

getMimeType

public String getMimeType()

getEncoding

public String getEncoding()

getDescription

public String getDescription()

getIdentifier

public ObjectIdentifier getIdentifier()

getName

public String getName()
Description copied from interface: QualifyingProperty
Gets the name of the property, as specified in XAdES (the element name).

Returns:
the name


Copyright © 2012. All Rights Reserved.