com.yourmediashelf.fedora.client.request

Class FedoraRequest<T>

java.lang.Object

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

Direct Known Subclasses:

AddDatastream, BatchDeleteDatastreams, BatchGetDatastreams, DescribeRepository, Export, FindObjects, GetDatastream, GetDatastreamDissemination, GetDatastreamHistory, GetDatastreams, GetDissemination, GetNextPID, GetObjectHistory, GetObjectProfile, GetObjectXML, Ingest, ListDatastreams, ListMethods, ModifyDatastream, ModifyObject, PurgeDatastream, PurgeObject, RelationshipsRequest, RiSearch, Upload, Validate

public abstract class FedoraRequest<T>
extends Object

Base class for Fedora REST API requests.

Author:

Edwin Shin

Constructor Summary

Constructors

Constructor and Description
FedoraRequest()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String key, String value) Adds an HTTP header to this request.
protected void	addQueryParam(String key, String value)
FedoraResponse	execute() Executes this request against the DEFAULT_CLIENT
abstract <F extends FedoraResponse> FedoraResponse	execute(FedoraClient fedora) Execute this request using the supplied FedoraClient instance.
protected String	getFirstQueryParam(String key)
javax.ws.rs.core.MultivaluedMap<String,String>	getHeaders() Retrieves the current HTTP headers set on this request.
protected List<String>	getQueryParam(String key)
protected javax.ws.rs.core.MultivaluedMap<String,String>	getQueryParams()
static boolean	isDefaultClientSet() Return boolean indicating whether DEFAULT_CLIENT has been set.
void	removeHeader(String key) Removes all HTTP headers of a specified name to this request.
protected com.sun.jersey.api.client.WebResource	resource() Returns a WebResource as supplied by the DEFAULT_CLIENT using FedoraClient.resource().
protected com.sun.jersey.api.client.WebResource	resource(FedoraClient fc) Returns a WebResource as supplied by the FedoraClient fc using FedoraClient.resource().
protected com.sun.jersey.api.client.WebResource	resource(FedoraClient fc, String path) Returns a WebResource as supplied by the FedoraClient fc using FedoraClient.resource().
protected com.sun.jersey.api.client.WebResource	resource(String path) Returns a WebResource as supplied by the DEFAULT_CLIENT using FedoraClient.resource().
static void	setDefaultClient(FedoraClient client) Set the instance of FedoraClient that all FedoraRequests should use by default.
void	setHeaders(javax.ws.rs.core.MultivaluedMap<String,String> headers) Sets the current HTTP headers on this request.
T	xParam(String key, String value) Add an arbitrary query parameter and value to the method.

Methods inherited from class java.lang.Object

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

Constructor Detail

FedoraRequest

public FedoraRequest()

Method Detail

execute

public FedoraResponse execute()
                       throws FedoraClientException

Executes this request against the DEFAULT_CLIENT

Returns:

the FedoraResponse to this request

Throws:

FedoraClientException - if DEFAULT_CLIENT is null

setDefaultClient

public static void setDefaultClient(FedoraClient client)

Set the instance of FedoraClient that all FedoraRequests should use by default.

Parameters:

client - the instance of FedoraClient that requests should use by default

isDefaultClientSet

public static boolean isDefaultClientSet()

Return boolean indicating whether DEFAULT_CLIENT has been set.

Returns:

boolean

execute

public abstract <F extends FedoraResponse> FedoraResponse execute(FedoraClient fedora)
                                throws FedoraClientException

Execute this request using the supplied FedoraClient instance.

Parameters:

fedora - an instance of FedoraClient

Returns:

the response

Throws:

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

xParam

public T xParam(String key,
       String value)

Add an arbitrary query parameter and value to the method.

This method is intended as mild future-proofing, allowing fedora-client to be used with future or unreleased versions of Fedora that may support additional or different query parameters than fedora-client is aware of.

Parameters:

key - the query parameter name

value - the value

Returns:

this builder

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getHeaders()

Retrieves the current HTTP headers set on this request.

Returns:

A MultivaluedMap of HTTP headers.

setHeaders

public void setHeaders(javax.ws.rs.core.MultivaluedMap<String,String> headers)

Sets the current HTTP headers on this request. This overwrites any headers already set.

Parameters:

headers - A MultivaluedMap of HTTP headers.

addHeader

public void addHeader(String key,
             String value)

Adds an HTTP header to this request. This does not overwrite any headers of the same name already set: it adds to them.

Parameters:

key - The name of the HTTP header to set.

value - The value of the HTTP header to set.

removeHeader

public void removeHeader(String key)

Removes all HTTP headers of a specified name to this request.

Parameters:

key - The name of the HTTP header to remove.

addQueryParam

protected void addQueryParam(String key,
                 String value)

getQueryParam

protected List<String> getQueryParam(String key)

getFirstQueryParam

protected String getFirstQueryParam(String key)

getQueryParams

protected javax.ws.rs.core.MultivaluedMap<String,String> getQueryParams()

resource

protected com.sun.jersey.api.client.WebResource resource()
                                                  throws FedoraClientException

Returns a WebResource as supplied by the DEFAULT_CLIENT using FedoraClient.resource(). Also adds any headers as found via getHeaders() to the resource.

Returns:

WebResource

Throws:

FedoraClientException - if DEFAULT_CLIENT is null

resource

protected com.sun.jersey.api.client.WebResource resource(String path)
                                                  throws FedoraClientException

Returns a WebResource as supplied by the DEFAULT_CLIENT using FedoraClient.resource(). Also adds any headers as found via getHeaders() to the resource.

Parameters:

path - the path to use for this resource

Returns:

WebResource

Throws:

FedoraClientException - if DEFAULT_CLIENT is null

resource

protected com.sun.jersey.api.client.WebResource resource(FedoraClient fc)

Returns a WebResource as supplied by the FedoraClient fc using FedoraClient.resource(). Also adds any headers as found via getHeaders() to the resource.

Parameters:

fc - the FedoraClient from which to get this resource

Returns:

WebResource

resource

protected com.sun.jersey.api.client.WebResource resource(FedoraClient fc,
                                             String path)

Returns a WebResource as supplied by the FedoraClient fc using FedoraClient.resource(). Also adds any headers as found via getHeaders() to the resource.

Parameters:

fc - the FedoraClient from which to get this resource

path - the path to use for this resource

Returns:

WebResource