net.cnri.repository.rest

Class RestRepository

java.lang.Object

net.cnri.repository.AbstractRepository

net.cnri.repository.rest.RestRepository

All Implemented Interfaces:

Repository

public class RestRepository
extends AbstractRepository

This is an implementation of Repository API used for connecting to RestRepository servlet using JSON over HTTP as the wire format.

Constructor Summary

Constructors

Constructor and Description
RestRepository(java.lang.String baseUri, java.lang.String username, java.lang.String password)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the repository and release all resources.
static void	consumeEntity(org.apache.http.HttpEntity entity)
static void	consumeQuietly(org.apache.http.HttpEntity entity)
DigitalObject	createDigitalObject(java.lang.String handle) Creates a new digital object with the given identifier in this repository.
void	deleteDigitalObject(java.lang.String handle) Deletes a digital object from the repository.
DigitalObject	getDigitalObject(java.lang.String handle) Returns the digital object with the given identifier from this repository.
java.lang.String	getHandle() Returns the handle of the repository.
DigitalObject	getOrCreateDigitalObject(java.lang.String handle) Returns the digital object with the given identifier from this repository, which is created if it does not exist.
CloseableIterator<java.lang.String>	listHandles() Provides a CloseableIterator view of the identifiers for digital objects accessible through this repository.
CloseableIterator<DigitalObject>	listObjects() Provides a CloseableIterator view of the digital objects accessible through this repository.
static java.lang.String	queryToString(Query q)
QueryResults<DigitalObject>	search(Query query, QueryParams queryParams) Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.
QueryResults<DigitalObject>	search(java.lang.String query) Deprecated.
QueryResults<DigitalObject>	search(java.lang.String query, QueryParams queryParams)
QueryResults<java.lang.String>	searchHandles(Query query, QueryParams queryParams) Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.
QueryResults<java.lang.String>	searchHandles(java.lang.String query) Deprecated.
QueryResults<java.lang.String>	searchHandles(java.lang.String query, QueryParams queryParams)
boolean	verifyDigitalObject(java.lang.String handle) Verifies whether a digital object with the given identifier can be accessed via this repository.

Methods inherited from class net.cnri.repository.AbstractRepository

search, searchHandles, searchMapping

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRepository

public RestRepository(java.lang.String baseUri,
              java.lang.String username,
              java.lang.String password)

Method Detail

getHandle

public java.lang.String getHandle()

Description copied from interface: Repository

Returns the handle of the repository. May return null for local repositories.

Specified by:

getHandle in interface Repository

Overrides:

getHandle in class AbstractRepository

Returns:

the handle of the repository, or null if not available.

verifyDigitalObject

public boolean verifyDigitalObject(java.lang.String handle)
                            throws RepositoryException

Description copied from interface: Repository

Verifies whether a digital object with the given identifier can be accessed via this repository.

Specified by:

verifyDigitalObject in interface Repository

Overrides:

verifyDigitalObject in class AbstractRepository

Parameters:

handle - an identifier for a digital object

Returns:

whether a digital object with that identifier can be accessed via this repository

Throws:

RepositoryException

createDigitalObject

public DigitalObject createDigitalObject(java.lang.String handle)
                                  throws CreationException,
                                         RepositoryException

Description copied from interface: Repository

Creates a new digital object with the given identifier in this repository. Passing null requests that the repository assign a new unique identifier; this method will throw UnsupportedOperationException if the given repository does not support that functionality.

Parameters:

handle - the identifier for the new digital object, or null to request that the repository assign a new unique identifier.

Returns:

the newly-created digital object

Throws:

CreationException - if an object with the given identifier already exists within the repository

RepositoryException

getDigitalObject

public DigitalObject getDigitalObject(java.lang.String handle)
                               throws RepositoryException

Description copied from interface: Repository

Returns the digital object with the given identifier from this repository.

Parameters:

handle - the identifier for the digital object

Returns:

the digital object, or null if no such object can be accessed through this repository

Throws:

RepositoryException

getOrCreateDigitalObject

public DigitalObject getOrCreateDigitalObject(java.lang.String handle)
                                       throws RepositoryException

Description copied from interface: Repository

Returns the digital object with the given identifier from this repository, which is created if it does not exist.

Specified by:

getOrCreateDigitalObject in interface Repository

Overrides:

getOrCreateDigitalObject in class AbstractRepository

Parameters:

handle - the identifier for the digital object

Returns:

the digital object

Throws:

RepositoryException

listHandles

public CloseableIterator<java.lang.String> listHandles()
                                                throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the identifiers for digital objects accessible through this repository.

Specified by:

listHandles in interface Repository

Overrides:

listHandles in class AbstractRepository

Throws:

RepositoryException

deleteDigitalObject

public void deleteDigitalObject(java.lang.String handle)
                         throws RepositoryException

Description copied from interface: Repository

Deletes a digital object from the repository.

Specified by:

deleteDigitalObject in interface Repository

Overrides:

deleteDigitalObject in class AbstractRepository

Parameters:

handle - the identifier for the digital object

Throws:

RepositoryException

listObjects

public CloseableIterator<DigitalObject> listObjects()
                                             throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the digital objects accessible through this repository.

Specified by:

listObjects in interface Repository

Overrides:

listObjects in class AbstractRepository

Throws:

RepositoryException

search

public QueryResults<DigitalObject> search(java.lang.String query,
                                 QueryParams queryParams)
                                   throws RepositoryException

Throws:

RepositoryException

searchHandles

public QueryResults<java.lang.String> searchHandles(java.lang.String query,
                                           QueryParams queryParams)
                                             throws RepositoryException

Throws:

RepositoryException

search

@Deprecated
public QueryResults<DigitalObject> search(java.lang.String query)
                                   throws RepositoryException

Deprecated.

Specified by:

search in interface Repository

Overrides:

search in class AbstractRepository

Throws:

RepositoryException

search

public QueryResults<DigitalObject> search(Query query,
                                 QueryParams queryParams)
                                   throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.

Specified by:

search in interface Repository

Overrides:

search in class AbstractRepository

Parameters:

query - the query to perform

queryParams - parameters for the query, or null for default parameters

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

searchHandles

@Deprecated
public QueryResults<java.lang.String> searchHandles(java.lang.String query)
                                             throws RepositoryException

Deprecated.

Specified by:

searchHandles in interface Repository

Overrides:

searchHandles in class AbstractRepository

Throws:

RepositoryException

searchHandles

public QueryResults<java.lang.String> searchHandles(Query query,
                                           QueryParams queryParams)
                                             throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object and the parameters defined in the QueryParams object.

Specified by:

searchHandles in interface Repository

Overrides:

searchHandles in class AbstractRepository

Parameters:

query - the query to perform

queryParams - parameters for the query, or null for default parameters

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

queryToString

public static java.lang.String queryToString(Query q)
                                      throws RepositoryException

Throws:

RepositoryException

close

public void close()

Description copied from interface: Repository

Close the repository and release all resources.

consumeEntity

public static void consumeEntity(org.apache.http.HttpEntity entity)
                          throws java.io.IOException

Throws:

java.io.IOException

consumeQuietly

public static void consumeQuietly(org.apache.http.HttpEntity entity)