Package org.fcrepo.client

Class TransactionalFcrepoClient

java.lang.Object

org.fcrepo.client.FcrepoClient

org.fcrepo.client.TransactionalFcrepoClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class TransactionalFcrepoClient
extends FcrepoClient

A Transaction aware client which adds the Atomic_ID header to requests and provides functionality for interacting with the Fedora Transaction API

Author:

mikejritter

Nested Class Summary

Nested classes/interfaces inherited from class org.fcrepo.client.FcrepoClient

FcrepoClient.FcrepoClientBuilder

Field Summary

Fields inherited from class org.fcrepo.client.FcrepoClient

TRANSACTION_ENDPOINT

Constructor Summary

Constructors

Constructor	Description
TransactionalFcrepoClient(URI transactionURI, FcrepoHttpClientBuilder httpClientBuilder, Boolean throwExceptionOnFailure)

Method Summary

Modifier and Type	Method	Description
PutBuilder	commit()	Commit a transaction by performing a PUT
DeleteBuilder	delete(URI url)	Make a DELETE request to delete a resource
GetBuilder	get(URI url)	Make a GET request to retrieve the content of a resource
URI	getTransactionURI()
HeadBuilder	head(URI url)	Make a HEAD request to retrieve resource headers.
PostBuilder	keepAlive()	Keep a transaction alive by performing a POST
OptionsBuilder	options(URI url)	Make a OPTIONS request to output information about the supported HTTP methods, etc.
PatchBuilder	patch(URI url)	Make a PATCH request to modify the triples associated with a resource with SPARQL-Update.
PostBuilder	post(URI url)	Make a POST request to create a new resource within an LDP container.
PutBuilder	put(URI url)	Make a PUT request to create a resource with a specified path, or replace the triples associated with a resource with the triples provided in the request body.
DeleteBuilder	rollback()	Rollback a transaction by performing a DELETE
GetBuilder	status()	Retrieve the status of a transaction by performing a GET

Methods inherited from class org.fcrepo.client.FcrepoClient

client, close, createMemento, createMemento, createMemento, executeRequest, startTransactionClient, transactionalClient

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionalFcrepoClient

public TransactionalFcrepoClient(URI transactionURI,
                                 FcrepoHttpClientBuilder httpClientBuilder,
                                 Boolean throwExceptionOnFailure)

Parameters:

transactionURI - the transaction to append to all requests

httpClientBuilder - the httpclient

throwExceptionOnFailure - whether to throw an exception on any non-2xx or 3xx HTTP responses

Method Detail

getTransactionURI

public URI getTransactionURI()

commit

public PutBuilder commit()

Commit a transaction by performing a PUT

Returns:

the commit RequestBuilder

status

public GetBuilder status()

Retrieve the status of a transaction by performing a GET

Returns:

the status RequestBuilder

keepAlive

public PostBuilder keepAlive()

Keep a transaction alive by performing a POST

Returns:

the keep alive RequestBuilder

rollback

public DeleteBuilder rollback()

Rollback a transaction by performing a DELETE

Returns:

the rollback RequestBuilder

get

public GetBuilder get(URI url)

Description copied from class: FcrepoClient

Make a GET request to retrieve the content of a resource

Overrides:

get in class FcrepoClient

Parameters:

url - the URL of the resource to which to GET

Returns:

a get request builder object

head

public HeadBuilder head(URI url)

Description copied from class: FcrepoClient

Make a HEAD request to retrieve resource headers.

Overrides:

head in class FcrepoClient

Parameters:

url - the URL of the resource to make the HEAD request on.

Returns:

a HEAD request builder object

delete

public DeleteBuilder delete(URI url)

Description copied from class: FcrepoClient

Make a DELETE request to delete a resource

Overrides:

delete in class FcrepoClient

Parameters:

url - the URL of the resource to which to DELETE

Returns:

a delete request builder object

options

public OptionsBuilder options(URI url)

Description copied from class: FcrepoClient

Make a OPTIONS request to output information about the supported HTTP methods, etc.

Overrides:

options in class FcrepoClient

Parameters:

url - the URL of the resource to make the OPTIONS request on.

Returns:

a OPTIONS request builder object

patch

public PatchBuilder patch(URI url)

Description copied from class: FcrepoClient

Make a PATCH request to modify the triples associated with a resource with SPARQL-Update.

Overrides:

patch in class FcrepoClient

Parameters:

url - the URL of the resource to which to PATCH

Returns:

a patch request builder object

post

public PostBuilder post(URI url)

Description copied from class: FcrepoClient

Make a POST request to create a new resource within an LDP container.

Overrides:

post in class FcrepoClient

Parameters:

url - the URL of the resource to which to POST

Returns:

a post request builder object

put

public PutBuilder put(URI url)

Description copied from class: FcrepoClient

Make a PUT request to create a resource with a specified path, or replace the triples associated with a resource with the triples provided in the request body.

Overrides:

put in class FcrepoClient

Parameters:

url - the URL of the resource to which to PUT

Returns:

a put request builder object