|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.indexdata.mkjsf.pazpar2.Pz2Client
public class Pz2Client
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.
Field Summary | |
---|---|
static Map<String,String> |
DEFAULTS
|
static String |
MODULENAME
|
Constructor Summary | |
---|---|
Pz2Client()
|
Method Summary | |
---|---|
boolean |
authenticate()
|
Pz2Client |
cloneMe()
|
void |
configure(ConfigurationReader configReader)
Configures the Configurable using the configuration obtained by the provided configuration reader |
List<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()
|
Map<String,String> |
getDefaults()
Returns default configuration parameters for the client. |
String |
getModuleName()
Returns the configuration name of the client |
String |
getServiceId()
Returns the Pazpar2 Service ID |
String |
getServiceUrl()
Returns the currently configured Papzar2 URL. |
boolean |
hasServiceUrl()
Returns true if a Papzar2 URL was defined yet. |
boolean |
isAuthenticated()
|
boolean |
isAuthenticatingClient()
|
void |
setSearchCommand(Pazpar2Command command)
|
void |
setServiceId(String serviceId)
Sets the service ID that Pazpar2 should use when servicing requests |
void |
setServiceUrl(String serviceUrl)
Sets the Pazpar2 URL to use for requests. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String MODULENAME
public static Map<String,String> DEFAULTS
Constructor Detail |
---|
public Pz2Client()
Method Detail |
---|
public void configure(ConfigurationReader configReader) throws ConfigurationException
Configurable
configure
in interface Configurable
configReader
- used for reading the configuration
ConfigurationException
public boolean isAuthenticatingClient()
isAuthenticatingClient
in interface SearchClient
public boolean isAuthenticated()
public boolean authenticate()
public void setSearchCommand(Pazpar2Command command)
setSearchCommand
in interface SearchClient
public HttpResponseWrapper executeCommand(Pazpar2Command command)
executeCommand
in interface SearchClient
public Pz2Client cloneMe()
cloneMe
in interface SearchClient
public Map<String,String> getDefaults()
getDefaults
in interface Configurable
public String getModuleName()
getModuleName
in interface Configurable
public List<String> documentConfiguration()
documentConfiguration
in interface Configurable
public Configuration getConfiguration()
getConfiguration
in interface SearchClient
public String getServiceUrl()
getServiceUrl
in interface SearchClient
public boolean hasServiceUrl()
hasServiceUrl
in interface SearchClient
public void setServiceUrl(String serviceUrl)
setServiceUrl
in interface SearchClient
public String getServiceId()
public void setServiceId(String serviceId)
serviceId
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |