Package eu.clarin.sru.client

Class SRUClient

java.lang.Object

eu.clarin.sru.client.SRUClient

public class SRUClient
extends Object

A client to perform SRU operations. The response of a SRU request is wrapped in a SRU response.

This client is reusable but not thread-safe: the application may reuse a client object, but it may not be concurrently shared between multiple threads.

Constructor Summary

Constructors

Constructor	Description
SRUClient(SRUClientConfig config)	Constructor.

Method Summary

Modifier and Type	Method	Description
SRUExplainResponse	explain(SRUExplainRequest request)	Perform a explain operation.
SRUScanResponse	scan(SRUScanRequest request)	Perform a scan operation.
SRUSearchRetrieveResponse	searchRetrieve(SRUSearchRetrieveRequest request)	Perform a searchRetrieve operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SRUClient

public SRUClient(SRUClientConfig config)

Constructor.

Parameters:

config - the configuration to be used for this client.

Throws:

NullPointerException - if argument config is null

IllegalArgumentException - if an error occurred while registering record data parsers

See Also:

SRUClientConfig

Method Detail

explain

public SRUExplainResponse explain(SRUExplainRequest request)
                           throws SRUClientException

Perform a explain operation.

Parameters:

request - an instance of a SRUExplainRequest object

Returns:

a SRUExplainResponse object

Throws:

SRUClientException - if an unrecoverable error occurred

NullPointerException - if any required argument is null

scan

public SRUScanResponse scan(SRUScanRequest request)
                     throws SRUClientException

Perform a scan operation.

Parameters:

request - an instance of a SRUScanRequest object

Returns:

a SRUScanResponse object

Throws:

SRUClientException - if an unrecoverable error occurred

NullPointerException - if any required argument is null

searchRetrieve

public SRUSearchRetrieveResponse searchRetrieve(SRUSearchRetrieveRequest request)
                                         throws SRUClientException

Perform a searchRetrieve operation.

Parameters:

request - an instance of a SRUSearchRetrieveRequest object

Returns:

a SRUSearchRetrieveRequest object

Throws:

SRUClientException - if an unrecoverable error occurred

NullPointerException - if any required argument is null