|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Pazpar2Client
Pazpar2 proxy API. The proxy class is always instantiated per request. No backend HTTP connection reuse occurs.
Method Summary | |
---|---|
Pazpar2Client |
cloneMe()
Creates a Pazpar2 client clone with the same Pazpar2 configuration and target settings as the original. |
Pazpar2HttpResponse |
executeCommand(ClientCommand command,
OutputStream os)
Forwards any Pazpar2 command and stores the results in the OutputStream |
Document |
getHit(String recid)
Finds a 'hit' element by record ID from the latest 'show' results |
Document |
getResults(String command)
Returns the results of the latest command of the kind processed by this proxy client |
ClientCommand |
getSearchCommand()
Returns the most recent search command registered with this client |
int |
getSearchCount()
Returns the number of searches so far on this pazpar2 client object |
String |
getSessionId()
Returns sessionId for currently used pazpar2 session. |
Pazpar2Settings |
getSettings()
|
long |
getTimeStamp(String command,
int searchNumber)
|
void |
init()
Obtain new pazpar2 session valid for unspecified time period. |
Document |
recordRequest(String recid)
Makes a non-managed/transient pazpar2 record request. |
Document |
recordRequest(String recid,
int offset)
Makes a non-managed/transient pazpar2 record offset request. |
Document |
searchRequest(String queryString)
Makes a non-managed pazpar2 search request on a cloned pazpar2 client This is for 'embedded' pazpar2 requests by other plug-ins than Relay and independently of the main pazpar2 session. |
void |
setSearchCommand(ClientCommand command)
Stores the latest search command issued through this proxy client |
Document |
showRequest()
Makes a non-managed/transient pazpar2 show request. |
Method Detail |
---|
void init() throws Pazpar2ErrorException, Pazpar2IOException
Pazpar2ErrorException
- on pazpar2 application-level errors
com.indexdata.masterkey.pazpar2.exceptions.Pazpar2IOException
com.indexdata.masterkey.pazpar2.exceptions.Pazpar2MalformedOutputException
Pazpar2IOException
String getSessionId()
Pazpar2Settings getSettings()
void setSearchCommand(ClientCommand command)
command
- ClientCommand getSearchCommand()
int getSearchCount()
Pazpar2HttpResponse executeCommand(ClientCommand command, OutputStream os) throws IOException, Pazpar2ErrorException
command
- os
-
IOException
Pazpar2ErrorException
Document getResults(String command)
command
-
long getTimeStamp(String command, int searchNumber)
Document getHit(String recid)
recid
-
Pazpar2Client cloneMe() throws ProxyErrorException, Pazpar2ErrorException, Pazpar2IOException
ProxyErrorException
Pazpar2ErrorException
Pazpar2IOException
Document searchRequest(String queryString) throws Pazpar2ErrorException, Pazpar2IOException
queryString
-
StandardServiceException
- on Pazpar2 errors or parsing errors.
UnsupportedOperationException
- if invoked on a client object that was not cloned.
Pazpar2ErrorException
Pazpar2IOException
Document recordRequest(String recid, int offset) throws Pazpar2ErrorException, Pazpar2IOException
queryString
-
StandardServiceException
- on Pazpar2 errors or parsing errors.
Pazpar2ErrorException
Pazpar2IOException
Document recordRequest(String recid) throws Pazpar2ErrorException, Pazpar2IOException
queryString
-
StandardServiceException
- on Pazpar2 errors or parsing errors.
Pazpar2ErrorException
Pazpar2IOException
Document showRequest() throws Pazpar2ErrorException, Pazpar2IOException
queryString
-
StandardServiceException
- on Pazpar2 errors or parsing errors.
Pazpar2ErrorException
Pazpar2IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |