com.yourmediashelf.fedora.client.request

Class GetDatastreamHistory

java.lang.Object

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

com.yourmediashelf.fedora.client.request.GetDatastreamHistory

public class GetDatastreamHistory
extends FedoraRequest<GetDatastreamHistory>

Builder for the GetDatastreamHistory method.

Since:

0.0.3

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
GetDatastreamHistory(String pid, String dsId)

Method Summary

Methods

Modifier and Type	Method and Description
GetDatastreamHistoryResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
GetDatastreamHistoryResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
GetDatastreamHistory	format(String format) The format of the response.

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

GetDatastreamHistory

public GetDatastreamHistory(String pid,
                    String dsId)

Parameters:

pid - persistent identifier of the digital object

dsId - datastream identifier

Method Detail

format

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

execute

public GetDatastreamHistoryResponse execute()
                                     throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<GetDatastreamHistory>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public GetDatastreamHistoryResponse execute(FedoraClient fedora)
                                     throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<GetDatastreamHistory>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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