com.yourmediashelf.fedora.client.request

Class BatchGetDatastreams

java.lang.Object

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

com.yourmediashelf.fedora.client.request.BatchGetDatastreams

public class BatchGetDatastreams
extends FedoraRequest<BatchGetDatastreams>

Builder for the BatchGetDatastreams method.

BatchGetDatastreams is not natively supported by Fedora. This is an proof-of-concept implementation of a batch request and currently requires manual patching of Fedora to support this request.

BatchGetDatastreams issues a single client request for each of the requested datastreams of each of the requested pids and returns the combined result as a multipart/mixed response.

Author:

Edwin Shin

See Also:

https://github.com/mediashelf/fedora-batch

Constructor Summary

Constructors

Constructor and Description
BatchGetDatastreams()

Method Summary

Methods

Modifier and Type	Method and Description
BatchGetDatastreams	asOfDateTime(String asOfDateTime)
BatchGetDatastreams	download(boolean download)
BatchGetDatastreams	dsids(Collection<String> dsids)
BatchGetDatastreams	dsids(String... dsids) Convenience method for dsids(Collection).
BatchResponse	execute() Executes this request against the FedoraRequest.DEFAULT_CLIENT
BatchResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
BatchGetDatastreams	pids(Collection<String> pids)
BatchGetDatastreams	pids(String... pids) Convenience method for pids(Collection).

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

BatchGetDatastreams

public BatchGetDatastreams()

Method Detail

pids

public BatchGetDatastreams pids(Collection<String> pids)

Parameters:

pids - The pids to fetch datastreams from

Returns:

this builder

pids

public BatchGetDatastreams pids(String... pids)

Convenience method for pids(Collection).

Parameters:

pids - The pids to fetch datastreams from

Returns:

this builder

dsids

public BatchGetDatastreams dsids(Collection<String> dsids)

Parameters:

dsids - The datastream ids that will be requested of each object

Returns:

this builder

dsids

public BatchGetDatastreams dsids(String... dsids)

Convenience method for dsids(Collection).

Parameters:

dsids - The datastream ids that will be requested of each object

Returns:

this builder

asOfDateTime

public BatchGetDatastreams asOfDateTime(String asOfDateTime)

download

public BatchGetDatastreams download(boolean download)

execute

public BatchResponse execute()
                      throws FedoraClientException

Description copied from class: FedoraRequest

Executes this request against the FedoraRequest.DEFAULT_CLIENT

Overrides:

execute in class FedoraRequest<BatchGetDatastreams>

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if FedoraRequest.DEFAULT_CLIENT is null

execute

public BatchResponse execute(FedoraClient fedora)
                      throws FedoraClientException

Description copied from class: FedoraRequest

Execute this request using the supplied FedoraClient instance.

Specified by:

execute in class FedoraRequest<BatchGetDatastreams>

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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