com.indexdata.mkjsf.pazpar2

Interface SearchClient

All Superinterfaces:

Configurable, java.io.Serializable

All Known Implementing Classes:

Pz2Client, ServiceProxyClient

public interface SearchClient
extends Configurable, java.io.Serializable

Interface abstracting Pazpar2 and Service Proxy services.

Method Summary

Methods

Modifier and Type	Method and Description
SearchClient	cloneMe()
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.lang.String	getServiceUrl() Returns the URL of the currently selected Pazpar2/SP service
boolean	hasServiceUrl() Returns true if a service has been selected, whether by configuration or runtime.
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	setServiceUrl(java.lang.String url) Sets the URL of the Pazpar2/SP service to use for searching.

Methods inherited from interface com.indexdata.mkjsf.config.Configurable

configure, documentConfiguration, getDefaults, getModuleName

Method Detail

setSearchCommand

void setSearchCommand(Pazpar2Command command)

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

Parameters:

command -

executeCommand

HttpResponseWrapper executeCommand(Pazpar2Command command)

Issues the provided command against the selected Pazpar2 service.

Parameters:

command -

Returns:

cloneMe

SearchClient cloneMe()

isAuthenticatingClient

boolean isAuthenticatingClient()

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

Returns:

getConfiguration

Configuration getConfiguration()

Returns the current client configuration - mainly for error resolution.

Returns:

getServiceUrl

java.lang.String getServiceUrl()

Returns the URL of the currently selected Pazpar2/SP service

Returns:

URL as a String

setServiceUrl

void setServiceUrl(java.lang.String url)

Sets the URL of the Pazpar2/SP service to use for searching.

Parameters:

url -

hasServiceUrl

boolean hasServiceUrl()

Returns true if a service has been selected, whether by configuration or runtime.

Returns:

true is service was selected, false otherwise.