com.yourmediashelf.fedora.client.request

Class ListDatastreams

java.lang.Object

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

com.yourmediashelf.fedora.client.request.ListDatastreams

public class ListDatastreams
extends FedoraRequest<ListDatastreams>

Builder for the ListDatastreams method.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
ListDatastreams(String pid)

Method Summary

Methods

Modifier and Type	Method and Description
ListDatastreams	asOfDateTime(String asOfDateTime) Indicates that the result should be relative to the digital object as it existed on the given date.
ListDatastreams	dsState(String dsState)
ListDatastreamsResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
ListDatastreamsResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
ListDatastreams	format(String format) The format of the response.
ListDatastreams	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

ListDatastreams

public ListDatastreams(String pid)

Parameters:

pid - persistent identifier of the digital object

Method Detail

asOfDateTime

public ListDatastreams 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

dsState

public ListDatastreams dsState(String dsState)

Parameters:

dsState - one of "A", "I", "D" (*A*ctive, *I*nactive, *D*eleted)

Returns:

this builder

format

public ListDatastreams 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 - The response format, either "xml" or "html"

Returns:

this builder

validateChecksum

public ListDatastreams 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 ListDatastreamsResponse execute()
                                throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<ListDatastreams>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public ListDatastreamsResponse execute(FedoraClient fedora)
                                throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<ListDatastreams>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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