org.fcrepo.client

Class PutBuilder

java.lang.Object

org.fcrepo.client.RequestBuilder

org.fcrepo.client.BodyRequestBuilder

org.fcrepo.client.PutBuilder

public class PutBuilder
extends BodyRequestBuilder

Builds a PUT request for interacting with the Fedora HTTP API in order to create a resource with a specified path, or replace the triples associated with a resource with the triples provided in the request body.

Author:

bbpennel

Field Summary

Fields inherited from class org.fcrepo.client.RequestBuilder

client, request, targetUri

Constructor Summary

Constructors

Constructor and Description
PutBuilder(URI uri, FcrepoClient client) Instantiate builder

Method Summary

Modifier and Type	Method and Description
PutBuilder	addHeader(String name, String value) Add a header with the given name and value to the request.
PutBuilder	addInteractionModel(String interactionModelUri) Add an interaction model to the request
PutBuilder	addLinkHeader(FcrepoLink linkHeader) Add a link header to the request
PutBuilder	body(File file, String contentType) Add the given file as the body for this request with the provided content type
PutBuilder	body(InputStream stream) Add a body to this request from a stream, with application/octet-stream as its content type
PutBuilder	body(InputStream stream, String contentType) Add a body to this request as a stream with the given content type
protected org.apache.http.client.methods.HttpRequestBase	createRequest() Creates the HTTP request object for this builder
PutBuilder	digest(String digest) Deprecated.
PutBuilder	digest(String digest, String alg) Provide a checksum for the body of this request
PutBuilder	digestMd5(String digest) Provide a MD5 checksum for the body of this request
PutBuilder	digestSha1(String digest) Provide a SHA-1 checksum for the body of this request.
PutBuilder	digestSha256(String digest) Provide a SHA-256 checksum for the body of this request
PutBuilder	externalContent(URI contentURI, String contentType, String handling) Add the given URI to the request as the location a Non-RDF Source binary should use for external content.
PutBuilder	filename(String filename) Provide a content disposition header which will be used as the filename
PutBuilder	ifMatch(String etag) Provide an etag for the if-match header for this request
PutBuilder	ifStateToken(String token) Provide a value for the if-state-token header for this request.
PutBuilder	ifUnmodifiedSince(String modified) Provide a if-unmodified-since header for this request
PutBuilder	linkAcl(String aclUri) Provide the URI to an ACL for this request
PutBuilder	preferLenient() Set the prefer header for this request to lenient handling, to indicate that server-managed triples will not be included in the request body.

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

PutBuilder

public PutBuilder(URI uri,
                  FcrepoClient client)

Instantiate builder

Parameters:

uri - uri of the resource this request is being made 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

body

public PutBuilder body(InputStream stream,
                       String contentType)

Description copied from class: BodyRequestBuilder

Add a body to this request as a stream with the given content type

Overrides:

body in class BodyRequestBuilder

Parameters:

stream - InputStream of the content to be sent to the server

contentType - the Content-Type of the body

Returns:

this builder

body

public PutBuilder body(File file,
                       String contentType)
                throws IOException

Description copied from class: BodyRequestBuilder

Add the given file as the body for this request with the provided content type

Overrides:

body in class BodyRequestBuilder

Parameters:

file - File containing the content to be sent to the server

contentType - the Content-Type of the body

Returns:

this builder

Throws:

IOException - when unable to stream the body file

externalContent

public PutBuilder externalContent(URI contentURI,
                                  String contentType,
                                  String handling)

Description copied from class: BodyRequestBuilder

Add the given URI to the request as the location a Non-RDF Source binary should use for external content. The handling parameter must be supplied, and informs the server of how to process the request.

Overrides:

externalContent in class BodyRequestBuilder

Parameters:

contentURI - URI of the external content.

contentType - Mimetype to supply for the external content.

handling - Name of the handling method, used by the server to determine how to process the external content URI. Standard values can be found in ExternalContentHandling.

Returns:

this builder

body

public PutBuilder body(InputStream stream)

Description copied from class: BodyRequestBuilder

Add a body to this request from a stream, with application/octet-stream as its content type

Overrides:

body in class BodyRequestBuilder

Parameters:

stream - InputStream of the content to be sent to the server

Returns:

this builder

ifMatch

public PutBuilder ifMatch(String etag)

Description copied from class: BodyRequestBuilder

Provide an etag for the if-match header for this request

Overrides:

ifMatch in class BodyRequestBuilder

Parameters:

etag - etag to provide as the if-match header

Returns:

this builder

ifUnmodifiedSince

public PutBuilder ifUnmodifiedSince(String modified)

Description copied from class: BodyRequestBuilder

Provide a if-unmodified-since header for this request

Overrides:

ifUnmodifiedSince in class BodyRequestBuilder

Parameters:

modified - date to provide as the if-unmodified-since header

Returns:

this builder

ifStateToken

public PutBuilder ifStateToken(String token)

Description copied from class: BodyRequestBuilder

Provide a value for the if-state-token header for this request.

Overrides:

ifStateToken in class BodyRequestBuilder

Parameters:

token - state token value

Returns:

this builder

digest

@Deprecated
public PutBuilder digest(String digest)

Deprecated.

Description copied from class: BodyRequestBuilder

Provide a SHA-1 checksum for the body of this request.

Overrides:

digest in class BodyRequestBuilder

Parameters:

digest - sha-1 checksum to provide as the digest for the request body

Returns:

this builder

digest

public PutBuilder digest(String digest,
                         String alg)

Description copied from class: BodyRequestBuilder

Provide a checksum for the body of this request

Overrides:

digest in class BodyRequestBuilder

Parameters:

digest - checksum to provide as the digest for the request body

alg - abbreviated algorithm identifier for the type of checksum being added (for example, sha, md5, etc)

Returns:

this builder

digestMd5

public PutBuilder digestMd5(String digest)

Description copied from class: BodyRequestBuilder

Provide a MD5 checksum for the body of this request

Overrides:

digestMd5 in class BodyRequestBuilder

Parameters:

digest - MD5 checksum to provide as the digest for the request body

Returns:

this builder

digestSha1

public PutBuilder digestSha1(String digest)

Description copied from class: BodyRequestBuilder

Provide a SHA-1 checksum for the body of this request.

Overrides:

digestSha1 in class BodyRequestBuilder

Parameters:

digest - sha-1 checksum to provide as the digest for the request body

Returns:

this builder

digestSha256

public PutBuilder digestSha256(String digest)

Description copied from class: BodyRequestBuilder

Provide a SHA-256 checksum for the body of this request

Overrides:

digestSha256 in class BodyRequestBuilder

Parameters:

digest - sha-256 checksum to provide as the digest for the request body

Returns:

this builder

addInteractionModel

public PutBuilder addInteractionModel(String interactionModelUri)

Description copied from class: BodyRequestBuilder

Add an interaction model to the request

Overrides:

addInteractionModel in class BodyRequestBuilder

Parameters:

interactionModelUri - URI of the interaction model

Returns:

this builder

linkAcl

public PutBuilder linkAcl(String aclUri)

Description copied from class: BodyRequestBuilder

Provide the URI to an ACL for this request

Overrides:

linkAcl in class BodyRequestBuilder

Parameters:

aclUri - URI to the ACL

Returns:

this builder

addHeader

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

filename

public PutBuilder filename(String filename)
                    throws FcrepoOperationFailedException

Provide a content disposition header which will be used as the filename

Parameters:

filename - the name of the file being provided in the body of the request

Returns:

this builder

Throws:

FcrepoOperationFailedException - if unable to encode filename

preferLenient

public PutBuilder preferLenient()

Set the prefer header for this request to lenient handling, to indicate that server-managed triples will not be included in the request body.

Returns:

this builder