com.indexdata.mkjsf.pazpar2

Class Pz2Client

java.lang.Object

com.indexdata.mkjsf.pazpar2.Pz2Client

All Implemented Interfaces:

Configurable, SearchClient, java.io.Serializable

public class Pz2Client
extends java.lang.Object
implements SearchClient

Search client handling straight Pazpar2 requests.

Although it is described here as straight Pazpar2, the client itself actually represents a layer between Pazpar2 and the JSF application because it uses the Pazpar2 client from the library masterkey-common.

That client, which is the one also used by the Service Proxy, does perform certain types of session handling, bootstraps lost sessions, avoids repeating already executed queries etc, so it is -- in other words -- still a mediated interaction with Pazpar2 that takes place. At least for now.

Configuration

Configuration name: pz2client.

When configuring the client using the Mk2Config scheme, this is the prefix to use in the .properties file. When using web.xml context parameters for configuration the configuration name has no effect.

Pz2Client will acknowledge following configuration parameters:

• (pz2client.)PAZPAR2_URL
• (pz2client.)SERVICE_ID

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	DEFAULTS PAZPAR2_URL=none, PROXY_MODE=1, SERIALIZE_REQUESTS=false, STREAMBUFF_SIZE=4096, PARSE_RESPONSES=true
static java.lang.String	MODULENAME

Constructor Summary

Constructors

Constructor and Description
Pz2Client()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	authenticate()
Pz2Client	cloneMe()
void	configure(ConfigurationReader configReader) Configures the Configurable using the configuration obtained by the provided configuration reader
java.util.List<java.lang.String>	documentConfiguration() Provides configuration documentation -- mostly for diagnosing problems
HttpResponseWrapper	executeCommand(Pazpar2Command command) Runs the give Pazpar2 command and returns a response wrapper with either the received response or with some form of error message.
Configuration	getConfiguration() Returns the current client configuration - mainly for error resolution.
java.util.Map<java.lang.String,java.lang.String>	getDefaults() Returns default configuration parameters for the client.
java.lang.String	getModuleName() Returns the configuration name of the client
java.lang.String	getServiceId() Returns the Pazpar2 Service ID
java.lang.String	getServiceUrl() Returns the currently configured Papzar2 URL.
boolean	hasServiceUrl() Returns true if a Papzar2 URL was defined yet.
boolean	isAuthenticated()
boolean	isAuthenticatingClient() Basically says if this client accesses a Service Proxy, which (usually) requires some form of authentication, or Pazpar2, which don't.
void	setSearchCommand(Pazpar2Command command) Search commands are saved for management purposes, like bootstrapping expired sessions and write log statements.
void	setServiceId(java.lang.String serviceId) Sets the service ID that Pazpar2 should use when servicing requests
void	setServiceUrl(java.lang.String serviceUrl) Sets the Pazpar2 URL to use for requests.

Methods inherited from class java.lang.Object

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

Field Detail

MODULENAME

public static final java.lang.String MODULENAME

See Also:

Constant Field Values

DEFAULTS

public static java.util.Map<java.lang.String,java.lang.String> DEFAULTS

PAZPAR2_URL=none, PROXY_MODE=1, SERIALIZE_REQUESTS=false, STREAMBUFF_SIZE=4096, PARSE_RESPONSES=true

Constructor Detail

Pz2Client

public Pz2Client()

Method Detail

configure

public void configure(ConfigurationReader configReader)
               throws ConfigurationException

Description copied from interface: Configurable

Configures the Configurable using the configuration obtained by the provided configuration reader

Specified by:

configure in interface Configurable

Parameters:

configReader - used for reading the configuration

Throws:

ConfigurationException

isAuthenticatingClient

public boolean isAuthenticatingClient()

Description copied from interface: SearchClient

Basically says if this client accesses a Service Proxy, which (usually) requires some form of authentication, or Pazpar2, which don't.

Specified by:

isAuthenticatingClient in interface SearchClient

Returns:

isAuthenticated

public boolean isAuthenticated()

authenticate

public boolean authenticate()

setSearchCommand

public void setSearchCommand(Pazpar2Command command)

Description copied from interface: SearchClient

Search commands are saved for management purposes, like bootstrapping expired sessions and write log statements.

Specified by:

setSearchCommand in interface SearchClient

executeCommand

public HttpResponseWrapper executeCommand(Pazpar2Command command)

Runs the give Pazpar2 command and returns a response wrapper with either the received response or with some form of error message. It is intended that this method never throws an exception. All events are supposed to be captured and returned in some form of response.

Specified by:

executeCommand in interface SearchClient

Returns:

cloneMe

public Pz2Client cloneMe()

Specified by:

cloneMe in interface SearchClient

getDefaults

public java.util.Map<java.lang.String,java.lang.String> getDefaults()

Returns default configuration parameters for the client.

Specified by:

getDefaults in interface Configurable

Returns:

getModuleName

public java.lang.String getModuleName()

Returns the configuration name of the client

Specified by:

getModuleName in interface Configurable

Returns:

name of the part that is to be configured

documentConfiguration

public java.util.List<java.lang.String> documentConfiguration()

Provides configuration documentation -- mostly for diagnosing problems

Specified by:

documentConfiguration in interface Configurable

Returns:

a list of Strings describing configuration details

getConfiguration

public Configuration getConfiguration()

Description copied from interface: SearchClient

Returns the current client configuration - mainly for error resolution.

Specified by:

getConfiguration in interface SearchClient

Returns:

getServiceUrl

public java.lang.String getServiceUrl()

Returns the currently configured Papzar2 URL.

Specified by:

getServiceUrl in interface SearchClient

Returns:

URL as a String

hasServiceUrl

public boolean hasServiceUrl()

Returns true if a Papzar2 URL was defined yet.

Specified by:

hasServiceUrl in interface SearchClient

Returns:

true is service was selected, false otherwise.

setServiceUrl

public void setServiceUrl(java.lang.String serviceUrl)

Sets the Pazpar2 URL to use for requests.

Specified by:

setServiceUrl in interface SearchClient

getServiceId

public java.lang.String getServiceId()

Returns the Pazpar2 Service ID

setServiceId

public void setServiceId(java.lang.String serviceId)

Sets the service ID that Pazpar2 should use when servicing requests

Parameters:

serviceId -