org.dataone.service.types.v1

Class DescribeResponse

java.lang.Object

org.dataone.service.types.v1.DescribeResponse

public class DescribeResponse
extends Object

The DataONE Type to represent the metadata returned from a 'describe' request. Describe provides a lighter weight mechanism than MN_crud.getSystemMetadata() for a client to determine basic properties of the referenced object. The response should indicate properties that are typically returned in a HTTP HEAD request: the date late modified, the size of the object, the type of the object (the SystemMetadata.objectFormat). It is not serializable Example of a HEAD response on object “ABC123”: curl -I http://mn1.dataone.org/mn/object/ABC123 HTTP/1.1 200 OK Last-Modified: Wed, 16 Dec 2009 13:58:34 GMT Content-Length: 10400 Content-Type: application/octet-stream DataONE-fmtid: eml://ecoinformatics.org/eml-2.0.1 DataONE-Checksum: SHA-1,2e01e17467891f7c933dbaa00e1459d23db3fe4f DataONE-SerialVersion: 1234

Author:

Matthew Jones

Constructor Summary

Constructors

Constructor and Description
DescribeResponse(ObjectFormatIdentifier objectFormatID, BigInteger content_length, Date last_modified, Checksum checksum, BigInteger serialVersion) instantiate a DescribeResponse object

Method Summary

Methods

Modifier and Type	Method and Description
BigInteger	getContent_Length() get the Size of the object in bytes, the value of SystemMetadata.size from SystemMetadata.
Checksum	getDataONE_Checksum() get The algorithm (SystemMetadata.algorithm) and Checksum (SystemMetadata.checksum) of the object being examined, drawn from the SystemMetadata.
ObjectFormatIdentifier	getDataONE_ObjectFormatIdentifier() get The value of the SystemMetadata.objectFormatIdentifier entry available in the SystemMetadata.
Date	getLast_Modified() get DateTime value that indicates when the system metadata associated with the object was last modified, i.e.
BigInteger	getSerialVersion() get the SerialVersion of the object SystemMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeResponse

public DescribeResponse(ObjectFormatIdentifier objectFormatID,
                BigInteger content_length,
                Date last_modified,
                Checksum checksum,
                BigInteger serialVersion)

instantiate a DescribeResponse object

Parameters:

format - value of the SystemMetadata.objectFormat entry available in the SystemMetadata.

content_length - Size of the object in bytes, the value of SystemMetadata.size from SystemMetadata.

last_modified - DateTime value that indicates when the system metadata associated with the object was last modified, i.e. the value of SystemMetadata.dateSysMetadataModified for the object.

checksum - The algorithm (SystemMetadata.algorithm) and Checksum (SystemMetadata.checksum) of the object being examined, drawn from the SystemMetadata. The algorithm and checksum are separated by a single comma with the algorithm first.

serialVersion - The serialVersion of the object's SystemMetadata

Method Detail

getContent_Length

public BigInteger getContent_Length()

get the Size of the object in bytes, the value of SystemMetadata.size from SystemMetadata.

Returns:

Size of the object in bytes

getDataONE_Checksum

public Checksum getDataONE_Checksum()

get The algorithm (SystemMetadata.algorithm) and Checksum (SystemMetadata.checksum) of the object being examined, drawn from the SystemMetadata. The algorithm and checksum are separated by a single comma with the algorithm first.

Returns:

Checksum of the object

getDataONE_ObjectFormatIdentifier

public ObjectFormatIdentifier getDataONE_ObjectFormatIdentifier()

get The value of the SystemMetadata.objectFormatIdentifier entry available in the SystemMetadata.

Returns:

objectFormat of the object

getLast_Modified

public Date getLast_Modified()

get DateTime value that indicates when the system metadata associated with the object was last modified, i.e. the value of SystemMetadata.dateSysMetadataModified for the object.

Returns:

last modified date of object

getSerialVersion

public BigInteger getSerialVersion()

get the SerialVersion of the object SystemMetadata

Returns:

serialVersion of the object