org.fcrepo.mint

Class HttpPidMinter

java.lang.Object

org.fcrepo.mint.HttpPidMinter

All Implemented Interfaces:

PidMinter

public class HttpPidMinter
extends Object
implements PidMinter

PID minter that uses an external REST service to mint PIDs.

Since:

04/28/2014

Author:

escowles

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.http.client.HttpClient	client
protected String	method
protected String	password
protected String	url
protected String	username

Constructor Summary

Constructors

Constructor and Description
HttpPidMinter(String url, String method, String username, String password, String regex, String xpath) Create a new HttpPidMinter.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.http.client.HttpClient	buildClient() Setup authentication in httpclient.
String	mintPid() Mint a unique identifier using an external HTTP API.
protected String	responseToPid(String responseText) Remove unwanted text from the minter service response to produce the desired identifier.

Methods inherited from class java.lang.Object

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

Field Detail

url

protected final String url

method

protected final String method

username

protected final String username

password

protected final String password

client

protected org.apache.http.client.HttpClient client

Constructor Detail

HttpPidMinter

public HttpPidMinter(String url,
             String method,
             String username,
             String password,
             String regex,
             String xpath)

Create a new HttpPidMinter.

Parameters:

url - The URL for the minter service. This is the only required argument -- all other parameters can be blank.

method - The HTTP method (POST, PUT or GET) used to generate a new PID (POST will be used if the method is blank.

username - If not blank, use this username to connect to the minter service.

password - If not blank, use this password used to connect to the minter service.

regex - If not blank, use this regular expression used to remove unwanted text from the minter service response. For example, if the response text is "/foo/bar:baz" and the desired identifier is "baz", then the regex would be ".*:".

xpath - If not blank, use this XPath expression used to extract the desired identifier from an XML minter response.

Method Detail

buildClient

protected org.apache.http.client.HttpClient buildClient()

Setup authentication in httpclient.

Returns:

the setup of authentication

responseToPid

protected String responseToPid(String responseText)
                        throws IOException

Remove unwanted text from the minter service response to produce the desired identifier. Override this method for processing more complex than a simple regex replacement.

Parameters:

responseText - the response text

Returns:

the response

Throws:

IOException - if exception occurred

mintPid

@Timed
public String mintPid()

Mint a unique identifier using an external HTTP API.

Specified by:

mintPid in interface PidMinter

Returns:

The generated identifier.