org.fcrepo.client.utils

Class HttpHelper

java.lang.Object

org.fcrepo.client.utils.HttpHelper

public class HttpHelper
extends Object

HTTP utilities

Since:

2014-08-26

Author:

escowles

Constructor Summary

Constructors

Constructor and Description
HttpHelper(String repositoryURL, org.apache.http.client.HttpClient httpClient, boolean readOnly) Create an HTTP helper with a pre-configured HttpClient instance.
HttpHelper(String repositoryURL, String fedoraUsername, String fedoraPassword, boolean readOnly) Create an HTTP helper for the specified repository.

Method Summary

Modifier and Type	Method and Description
org.apache.http.client.methods.HttpPut	createContentPutMethod(String path, Map<String,List<String>> params, FedoraContent content) Create a request to create/update content.
HttpCopy	createCopyMethod(String sourcePath, String destinationPath) Create COPY method
org.apache.http.client.methods.HttpDelete	createDeleteMethod(String path) Create DELETE method
org.apache.http.client.methods.HttpGet	createGetMethod(String path, Map<String,List<String>> params) Create GET method with list of parameters
org.apache.http.client.methods.HttpHead	createHeadMethod(String path) Create HEAD method
HttpMove	createMoveMethod(String sourcePath, String destinationPath) Create MOVE method
org.apache.http.client.methods.HttpPatch	createPatchMethod(String path, String sparqlUpdate) Create a request to update triples with SPARQL Update.
org.apache.http.client.methods.HttpPost	createPostMethod(String path, Map<String,List<String>> params) Create POST method with list of parameters
org.apache.http.client.methods.HttpPut	createPutMethod(String path, Map<String,List<String>> params) Create PUT method with list of parameters
org.apache.http.client.methods.HttpPut	createTriplesPutMethod(String path, InputStream updatedProperties, String contentType) Create a request to update triples.
org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpUriRequest request) Execute a request for a subclass.
FedoraResourceImpl	loadProperties(FedoraResourceImpl resource) Retrieve RDF from the repository and update the properties of a resource

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpHelper

public HttpHelper(String repositoryURL,
                  org.apache.http.client.HttpClient httpClient,
                  boolean readOnly)

Create an HTTP helper with a pre-configured HttpClient instance.

Parameters:

repositoryURL - Fedora base URL.

httpClient - Pre-configured HttpClient instance.

readOnly - If true, throw an exception when an update is attempted.

HttpHelper

public HttpHelper(String repositoryURL,
                  String fedoraUsername,
                  String fedoraPassword,
                  boolean readOnly)

Create an HTTP helper for the specified repository. If fedoraUsername and fedoraPassword are not null, then they will be used to connect to the repository.

Parameters:

repositoryURL - Fedora base URL.

fedoraUsername - Fedora username

fedoraPassword - Fedora password

readOnly - If true, throw an exception when an update is attempted.

Method Detail

execute

public org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpUriRequest request)
                                     throws IOException,
                                            ReadOnlyException

Execute a request for a subclass.

Parameters:

request - request to be executed

Returns:

response containing response to request

Throws:

IOException

ReadOnlyException

createHeadMethod

public org.apache.http.client.methods.HttpHead createHeadMethod(String path)

Create HEAD method

Parameters:

path - Resource path, relative to repository baseURL

Returns:

HEAD method

createGetMethod

public org.apache.http.client.methods.HttpGet createGetMethod(String path,
                                                              Map<String,List<String>> params)

Create GET method with list of parameters

Parameters:

path - Resource path, relative to repository baseURL

params - Query parameters

Returns:

GET method

createDeleteMethod

public org.apache.http.client.methods.HttpDelete createDeleteMethod(String path)

Create DELETE method

Parameters:

path - Resource path, relative to repository baseURL

Returns:

DELETE method

createPatchMethod

public org.apache.http.client.methods.HttpPatch createPatchMethod(String path,
                                                                  String sparqlUpdate)
                                                           throws FedoraException

Create a request to update triples with SPARQL Update.

Parameters:

path - The datastream path.

sparqlUpdate - SPARQL Update command.

Returns:

created patch based on parameters

Throws:

FedoraException

createPostMethod

public org.apache.http.client.methods.HttpPost createPostMethod(String path,
                                                                Map<String,List<String>> params)

Create POST method with list of parameters

Parameters:

path - Resource path, relative to repository baseURL

params - Query parameters

Returns:

PUT method

createPutMethod

public org.apache.http.client.methods.HttpPut createPutMethod(String path,
                                                              Map<String,List<String>> params)

Create PUT method with list of parameters

Parameters:

path - Resource path, relative to repository baseURL

params - Query parameters

Returns:

PUT method

createContentPutMethod

public org.apache.http.client.methods.HttpPut createContentPutMethod(String path,
                                                                     Map<String,List<String>> params,
                                                                     FedoraContent content)

Create a request to create/update content.

Parameters:

path - The datastream path.

params - Mapping of parameters for the PUT request

content - Content parameters.

Returns:

PUT method

createTriplesPutMethod

public org.apache.http.client.methods.HttpPut createTriplesPutMethod(String path,
                                                                     InputStream updatedProperties,
                                                                     String contentType)
                                                              throws FedoraException

Create a request to update triples.

Parameters:

path - The datastream path.

updatedProperties - InputStream containing RDF.

contentType - Content type of the RDF in updatedProperties (e.g., "text/rdf+n3" or "application/rdf+xml").

Returns:

PUT method

Throws:

FedoraException

loadProperties

public FedoraResourceImpl loadProperties(FedoraResourceImpl resource)
                                  throws FedoraException

Retrieve RDF from the repository and update the properties of a resource

Parameters:

resource - The resource to update

Returns:

the updated resource

Throws:

FedoraException

createCopyMethod

public HttpCopy createCopyMethod(String sourcePath,
                                 String destinationPath)

Create COPY method

Parameters:

sourcePath - Source path, relative to repository baseURL

destinationPath - Destination path, relative to repository baseURL

Returns:

COPY method

createMoveMethod

public HttpMove createMoveMethod(String sourcePath,
                                 String destinationPath)

Create MOVE method

Parameters:

sourcePath - Source path, relative to repository baseURL

destinationPath - Destination path, relative to repository baseURL

Returns:

MOVE method