com.indexdata.mkjsf.pazpar2

Class ServiceProxyClient

java.lang.Object

com.indexdata.mkjsf.pazpar2.ServiceProxyClient

All Implemented Interfaces:

Configurable, SearchClient, java.io.Serializable

public class ServiceProxyClient
extends java.lang.Object
implements SearchClient

Search client handling Service Proxy requests.

Configuration

Configuration name: proxyclient

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.

ServiceProxyClient will acknowledge following configuration parameters:

• (proxyclient.)SERVICE_PROXY_URL

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceProxyClient.ProxyPz2ResponseHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODULENAME
static java.lang.String	SP_INIT_DOC_PATHS

Constructor Summary

Constructors

Constructor and Description
ServiceProxyClient()

Method Summary

Methods

Modifier and Type	Method and Description
ServiceProxyClient	cloneMe()
void	configure(ConfigurationReader configReader) Configures the Configurable using the configuration obtained by the provided configuration reader
java.util.List<java.lang.String>	documentConfiguration() The components documentation of how it was configured.
HttpResponseWrapper	executeCommand(Pazpar2Command command) Issues the provided command against the selected Pazpar2 service.
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.util.List<java.lang.String>	getInitDocPaths()
java.lang.String	getModuleName() Returns the configuration name of the client
java.lang.String	getReasonPhrase()
java.lang.String	getServiceUrl() Returns the URL of the currently selected Pazpar2/SP service
int	getStatusCode()
boolean	hasServiceUrl() Returns true if a Service Proxy URL was defined yet.
boolean	isAuthenticatingClient() Basically says if this client accesses a Service Proxy, which (usually) requires some form of authentication, or Pazpar2, which don't.
HttpResponseWrapper	postInitDoc(byte[] initDoc, Pazpar2Command command)
ClientCommandResponse	postInitDoc(java.lang.String filePath)
ClientCommandResponse	send(Pazpar2Command command) Makes the request
void	setSearchCommand(Pazpar2Command command) Does nothing in Service Proxy context
void	setServiceUrl(java.lang.String url) Sets the URL of the Service Proxy that should service 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

SP_INIT_DOC_PATHS

public static final java.lang.String SP_INIT_DOC_PATHS

See Also:

Constant Field Values

Constructor Detail

ServiceProxyClient

public ServiceProxyClient()

Method Detail

configure

public void configure(ConfigurationReader configReader)
               throws MissingConfigurationContextException

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:

MissingConfigurationContextException

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:

send

public ClientCommandResponse send(Pazpar2Command command)

Makes the request

Parameters:

request -

Returns:

HTTP response as a String

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

getStatusCode

public int getStatusCode()

getReasonPhrase

public java.lang.String getReasonPhrase()

setSearchCommand

public void setSearchCommand(Pazpar2Command command)

Does nothing in Service Proxy context

Specified by:

setSearchCommand in interface SearchClient

executeCommand

public HttpResponseWrapper executeCommand(Pazpar2Command command)

Description copied from interface: SearchClient

Issues the provided command against the selected Pazpar2 service.

Specified by:

executeCommand in interface SearchClient

Returns:

cloneMe

public ServiceProxyClient 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()

Description copied from interface: Configurable

The components documentation of how it was configured.

Specified by:

documentConfiguration in interface Configurable

Returns:

a list of Strings describing configuration details

postInitDoc

public ClientCommandResponse postInitDoc(java.lang.String filePath)
                                  throws java.io.IOException

Throws:

java.io.IOException

getInitDocPaths

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

postInitDoc

public HttpResponseWrapper postInitDoc(byte[] initDoc,
                              Pazpar2Command command)

setServiceUrl

public void setServiceUrl(java.lang.String url)

Sets the URL of the Service Proxy that should service requests.

Specified by:

setServiceUrl in interface SearchClient

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()

Description copied from interface: SearchClient

Returns the URL of the currently selected Pazpar2/SP service

Specified by:

getServiceUrl in interface SearchClient

Returns:

URL as a String

hasServiceUrl

public boolean hasServiceUrl()

Returns true if a Service Proxy URL was defined yet.

Specified by:

hasServiceUrl in interface SearchClient

Returns:

true is service was selected, false otherwise.