com.yourmediashelf.fedora.client.request

Class GetDatastream

java.lang.Object

com.yourmediashelf.fedora.client.request.FedoraRequest<GetDatastream>

com.yourmediashelf.fedora.client.request.GetDatastream

public class GetDatastream
extends FedoraRequest<GetDatastream>

Builder for the GetDatastream method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
GetDatastream(String pid, String dsId)

Method Summary

Methods

Modifier and Type	Method and Description
GetDatastream	asOfDateTime(String asOfDateTime) Indicates that the result should be relative to the digital object as it existed on the given date.
GetDatastreamResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
GetDatastreamResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
GetDatastream	format(String format) The format of the response.
GetDatastream	validateChecksum(boolean validateChecksum) Verifies that the Datastream content has not changed since the checksum was initially computed.

Methods inherited from class com.yourmediashelf.fedora.client.request.FedoraRequest

addHeader, addQueryParam, getFirstQueryParam, getHeaders, getQueryParam, getQueryParams, isDefaultClientSet, removeHeader, resource, resource, resource, resource, setDefaultClient, setHeaders, xParam

Methods inherited from class java.lang.Object

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

Constructor Detail

GetDatastream

public GetDatastream(String pid,
             String dsId)

Parameters:

pid - persistent identifier of the digital object

Method Detail

asOfDateTime

public GetDatastream asOfDateTime(String asOfDateTime)

Indicates that the result should be relative to the digital object as it existed on the given date.

Parameters:

asOfDateTime - datetime string as yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ

Returns:

this builder

format

public GetDatastream format(String format)

The format of the response. Defaults to "xml".

The Fedora REST API default is "html", but fedora-client will set "xml" as the default in order to parse the response. If "html" is selected, the caller is responsible for parsing the raw HTTP response as most of the FedoraResponse convenience methods rely on an XML response.

Parameters:

format - "html" or "xml". Defaults to "xml".

Returns:

this builder

validateChecksum

public GetDatastream validateChecksum(boolean validateChecksum)

Verifies that the Datastream content has not changed since the checksum was initially computed. If asOfDateTime is null, Fedora will use the most recent version.

Parameters:

validateChecksum -

Returns:

this builder

execute

public GetDatastreamResponse execute()
                              throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<GetDatastream>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public GetDatastreamResponse execute(FedoraClient fedora)
                              throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<GetDatastream>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

FedoraClientException - if the HTTP status code of the response is >= 400.