net.cnri.repository.networked

Class NetworkedRepository

java.lang.Object

net.cnri.repository.AbstractRepository

net.cnri.repository.networked.NetworkedRepository

All Implemented Interfaces:

Repository

Direct Known Subclasses:

InternalRepository, ServletRepository

public class NetworkedRepository
extends AbstractRepository
implements Repository

A wrapper on net.cnri.do_api.Repository. Provides access to remote repositories using net.cnri.do_api.Repository providing the same interface as the other repository class in net.cnri.repository

Constructor Summary

Constructors

Constructor and Description
NetworkedRepository(DOAuthentication auth, DOServiceInfo service)
NetworkedRepository(DOAuthentication auth, java.lang.String repoId)
NetworkedRepository(java.lang.String repoHandle, java.lang.String userHandle, byte[] userPassword) Constructs a NetworkedRepository looking up connection parameters in the handle system and secret key authentication.
NetworkedRepository(java.lang.String repoHandle, java.lang.String host, int port, byte[] pubKeyBytes, java.lang.String userHandle, byte[] userPassword) Constructs a NetworkedRepository using a specified host and port and secret key authentication.
NetworkedRepository(java.lang.String repoHandle, java.lang.String host, int port, byte[] pubKeyBytes, java.lang.String userHandle, java.lang.String privateKeyFile, java.lang.String passphrase) Constructs a NetworkedRepository using a specified host and port and public key authentication.
NetworkedRepository(java.lang.String repoHandle, java.lang.String userHandle, java.lang.String privateKeyFile, java.lang.String passphrase) Constructs a NetworkedRepository looking up connection parameters in the handle system and public key authentication.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the repository and release all resources.
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.
void	ensureIndexUpToDate() Sends the repository a 1037/indexUpToDate operation.
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.
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.
StreamPair	performOperation(java.lang.String objectId, java.lang.String operationId, HeaderSet parameters) Perform an arbitrary operation.
StreamPair	performOperation(java.lang.String objectId, java.lang.String operationId, java.util.Map<java.lang.String,java.lang.String> parameters) Perform an arbitrary operation.
static java.lang.String	queryToString(Query q)
void	reindexAllObjects()
void	reindexObject(java.lang.String objectId) Reindex the object with the specified handle.
QueryResults<DigitalObject>	search(Query query) Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object with default parameters.
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) Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object with default parameters.
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)
CloseableIterator<java.util.Map<java.lang.String,java.lang.String>>	searchMapping(java.lang.String query) Deprecated.
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

getOrCreateDigitalObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.cnri.repository.Repository

getOrCreateDigitalObject

Constructor Detail

NetworkedRepository

public NetworkedRepository(DOAuthentication auth,
                   java.lang.String repoId)
                    throws RepositoryException

Throws:

RepositoryException

NetworkedRepository

public NetworkedRepository(DOAuthentication auth,
                   DOServiceInfo service)
                    throws RepositoryException

Throws:

RepositoryException

NetworkedRepository

public NetworkedRepository(java.lang.String repoHandle,
                   java.lang.String host,
                   int port,
                   byte[] pubKeyBytes,
                   java.lang.String userHandle,
                   byte[] userPassword)
                    throws RepositoryException

Constructs a NetworkedRepository using a specified host and port and secret key authentication.

Parameters:

repoHandle - handle of the repository.

host -

port -

pubKeyBytes - public key of the server (for the client to authenticate the server). This is the "publickey" file from the server directory.

userHandle - handle of the user for client authentication. May coincide with the repository handle if authenticating as the server itself. (The server will look up this handle first in the password.dct file, then in the Handle System.)

userPassword - password (secret key) for client authentication. (Note: this is the password either from the HS_SECKEY value in the user handle, or stored in the server's password.dct file.)

Throws:

RepositoryException

NetworkedRepository

public NetworkedRepository(java.lang.String repoHandle,
                   java.lang.String userHandle,
                   byte[] userPassword)
                    throws RepositoryException

Constructs a NetworkedRepository looking up connection parameters in the handle system and secret key authentication.

Parameters:

repoHandle - handle of the repository.

userHandle - handle of the user for client authentication. May coincide with the repository handle if authenticating as the server itself. (The server will look up this handle first in the password.dct file, then in the Handle System.)

userPassword - password (secret key) for client authentication. (Note: this is the password either from the HS_SECKEY value in the user handle, or stored in the server's password.dct file.)

Throws:

RepositoryException

NetworkedRepository

public NetworkedRepository(java.lang.String repoHandle,
                   java.lang.String host,
                   int port,
                   byte[] pubKeyBytes,
                   java.lang.String userHandle,
                   java.lang.String privateKeyFile,
                   java.lang.String passphrase)
                    throws RepositoryException

Constructs a NetworkedRepository using a specified host and port and public key authentication.

Parameters:

repoHandle - handle of the repository.

host -

port -

pubKeyBytes - public key of the server (for the client to authenticate the server). This is the "publickey" file from the server directory.

userHandle - handle of the user for client authentication. May coincide with the repository handle if authenticating as the server itself.

privateKeyFile - path to a file containing the user's (possibly encrypted) private key. If authenticating as the server itself, this is the "privatekey" file from the server directory.

passphrase - passphrase to be used the decrypt an encrypted private key file. Can be null if the private key file is not encrypted.

Throws:

RepositoryException

NetworkedRepository

public NetworkedRepository(java.lang.String repoHandle,
                   java.lang.String userHandle,
                   java.lang.String privateKeyFile,
                   java.lang.String passphrase)
                    throws RepositoryException

Constructs a NetworkedRepository looking up connection parameters in the handle system and public key authentication.

Parameters:

repoHandle - handle of the repository.

userHandle - handle of the user for client authentication. May coincide with the repository handle if authenticating as the server itself.

privateKeyFile - path to a file containing the user's (possibly encrypted) private key. If authenticating as the server itself, this is the "privatekey" file from the server directory.

passphrase - passphrase to be used the decrypt an encrypted private key file. Can be null if the private key file is not encrypted.

Throws:

RepositoryException

Method Detail

ensureIndexUpToDate

public void ensureIndexUpToDate()
                         throws RepositoryException

Sends the repository a 1037/indexUpToDate operation. This method does not return until the repositories index is up to date.

Throws:

RepositoryException

reindexAllObjects

public void reindexAllObjects()
                       throws DOException,
                              java.io.IOException,
                              RepositoryException

Throws:

DOException

java.io.IOException

RepositoryException

reindexObject

public void reindexObject(java.lang.String objectId)
                   throws java.io.IOException

Reindex the object with the specified handle. This method will not return until the reindex is complete. If you want a change to be reflected in the search results immediately after the change is made you need to call this method

Throws:

java.io.IOException

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.

Specified by:

createDigitalObject in interface Repository

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.

Specified by:

getDigitalObject in interface 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

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

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

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

search

public QueryResults<DigitalObject> search(Query query)
                                   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 with default parameters.

Specified by:

search in interface Repository

Overrides:

search in class AbstractRepository

Parameters:

query - the query to perform

Returns:

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

Throws:

RepositoryException

searchHandles

public QueryResults<java.lang.String> searchHandles(Query query)
                                             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 with default parameters.

Specified by:

searchHandles in interface Repository

Overrides:

searchHandles in class AbstractRepository

Parameters:

query - the query to perform

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

searchMapping

@Deprecated
public CloseableIterator<java.util.Map<java.lang.String,java.lang.String>> searchMapping(java.lang.String query)
                                                                                  throws RepositoryException

Deprecated.

Specified by:

searchMapping in interface Repository

Overrides:

searchMapping in class AbstractRepository

Throws:

RepositoryException

close

public void close()

Description copied from interface: Repository

Close the repository and release all resources.

Specified by:

close in interface Repository

performOperation

public StreamPair performOperation(java.lang.String objectId,
                          java.lang.String operationId,
                          java.util.Map<java.lang.String,java.lang.String> parameters)
                            throws RepositoryException

Perform an arbitrary operation.

Parameters:

objectId - the id of the target object.

operationId - the operation to perform.

parameters - parameters of the operation.

Returns:

a StreamPair for the input and output of the operation.

Throws:

RepositoryException

performOperation

public StreamPair performOperation(java.lang.String objectId,
                          java.lang.String operationId,
                          HeaderSet parameters)
                            throws RepositoryException

Perform an arbitrary operation.

Parameters:

objectId - the id of the target object.

operationId - the operation to perform.

parameters - parameters of the operation.

Returns:

a StreamPair for the input and output of the operation.

Throws:

RepositoryException