Package org.fcrepo.client

Class HeadBuilder

java.lang.Object

org.fcrepo.client.RequestBuilder

org.fcrepo.client.RetrieveRequestBuilder

org.fcrepo.client.HeadBuilder

public class HeadBuilder
extends RetrieveRequestBuilder

Builds a HEAD request to retrieve resource headers.

Author:

bbpennel

Field Summary

Fields inherited from class org.fcrepo.client.RequestBuilder

client, request, targetUri

Constructor Summary

Constructors

Constructor	Description
HeadBuilder(URI uri, FcrepoClient client)	Instantiate builder

Method Summary

Modifier and Type	Method	Description
HeadBuilder	acceptDatetime(String acceptDatetime)	Provide an Accept-Datetime from the given RFC1123 formatted string.
HeadBuilder	acceptDatetime(Instant acceptInstant)	Provide an Accept-Datetime header in RFC1123 format from the given instant for memento datetime negotiation.
HeadBuilder	addHeader(String name, String value)	Add a header with the given name and value to the request.
HeadBuilder	addLinkHeader(FcrepoLink linkHeader)	Add a link header to the request
protected org.apache.http.client.methods.HttpRequestBase	createRequest()	Creates the HTTP request object for this builder
HeadBuilder	disableRedirects()	Disable following redirects.
HeadBuilder	noCache()	Provide a Cache-Control header with value "no-cache"
HeadBuilder	wantDigest(String value)	Provide a Want-Digest header for this request

Methods inherited from class org.fcrepo.client.RequestBuilder

perform

Methods inherited from class java.lang.Object

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

Constructor Detail

HeadBuilder

public HeadBuilder(URI uri,
                   FcrepoClient client)

Instantiate builder

Parameters:

uri - uri request will be issued to

client - the client

Method Detail

createRequest

protected org.apache.http.client.methods.HttpRequestBase createRequest()

Description copied from class: RequestBuilder

Creates the HTTP request object for this builder

Specified by:

createRequest in class RequestBuilder

Returns:

HTTP request object for this builder

disableRedirects

public HeadBuilder disableRedirects()

Description copied from class: RetrieveRequestBuilder

Disable following redirects.

Overrides:

disableRedirects in class RetrieveRequestBuilder

Returns:

this builder

wantDigest

public HeadBuilder wantDigest(String value)

Description copied from class: RetrieveRequestBuilder

Provide a Want-Digest header for this request

Overrides:

wantDigest in class RetrieveRequestBuilder

Parameters:

value - header value, following the syntax defined in: https://tools.ietf.org/html/rfc3230#section-4.3.1

Returns:

this builder

noCache

public HeadBuilder noCache()

Description copied from class: RetrieveRequestBuilder

Provide a Cache-Control header with value "no-cache"

Overrides:

noCache in class RetrieveRequestBuilder

Returns:

this builder

acceptDatetime

public HeadBuilder acceptDatetime(Instant acceptInstant)

Description copied from class: RetrieveRequestBuilder

Provide an Accept-Datetime header in RFC1123 format from the given instant for memento datetime negotiation.

Overrides:

acceptDatetime in class RetrieveRequestBuilder

Parameters:

acceptInstant - the accept datetime represented as an Instant.

Returns:

this builder

acceptDatetime

public HeadBuilder acceptDatetime(String acceptDatetime)

Description copied from class: RetrieveRequestBuilder

Provide an Accept-Datetime from the given RFC1123 formatted string.

Overrides:

acceptDatetime in class RetrieveRequestBuilder

Parameters:

acceptDatetime - the accept datetime as a string, must be in RFC1123 format.

Returns:

this builder

addHeader

public HeadBuilder addHeader(String name,
                             String value)

Description copied from class: RequestBuilder

Add a header with the given name and value to the request.

Overrides:

addHeader in class RequestBuilder

Parameters:

name - name of the header

value - value of the header

Returns:

this builder

addLinkHeader

public HeadBuilder addLinkHeader(FcrepoLink linkHeader)

Description copied from class: RequestBuilder

Add a link header to the request

Overrides:

addLinkHeader in class RequestBuilder

Parameters:

linkHeader - link header value represented as a FcrepoLink

Returns:

this builder