org.sourceforge.vlibrary.util

Class SruSrwClientImpl

java.lang.Object

org.sourceforge.vlibrary.util.SruSrwClientImpl

All Implemented Interfaces:

SruSrwClientInterface

public class SruSrwClientImpl
extends Object
implements SruSrwClientInterface

Class to allow the lookup of books by identifiers (ISBN, etc) with SRU/SRW compliant service providers, to obtain: - Author - Title - Publisher - PublishedDate - SubjectsList

Constructor Summary

Constructors

Constructor and Description
SruSrwClientImpl()

Method Summary

Modifier and Type	Method and Description
Map	callSruSrwProvider(String identifier) Looks up using SRU/SRW defined endpoint an identifier (normally ISBN) and returns the first record returned by SRU/SRW as a HashMap of fields
String	getEndPointURL() Returns the the SRU/SRW service provider URI
String	getProxyHostName() Returns the proxy hostname
String	getProxyPasswd() Returns the proxy userid
String	getProxyPort() Returns the proxy port
String	getProxyUserId() Returns the proxy userid
org.apache.axiom.soap.SOAPEnvelope	getSOAPPayload(String isbn) Creates the full SOAPEnvelope to be sent to LOC, based on SRW schemas
void	setEndPointURL(String endPointURL) Sets the URI for the SRU/SRW service provider, default to http://z3950.loc.gov:7090/voyager
void	setProxyHostName(String proxyHostName) Set the proxy name if a proxy is required (ex.
void	setProxyPasswd(String proxyPasswd) Set the proxy password if proxy is required and configured (non-empty), ignored otherwise Default is "anonymous", if a non-authenticate proxy is used this value must be the default
void	setProxyPort(String proxyPort) Set the proxy port if proxy is required and configured (non-empty), ignored otherwise Content of the string must be between 1 and 65556 Default value is 8080
void	setProxyUserId(String proxyUserId) Set the proxy userid if proxy is required and configured (non-empty), ignored otherwise Default is "anonymous", if a non-authenticate proxy is used this value must be the default

Methods inherited from class java.lang.Object

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

Constructor Detail

SruSrwClientImpl

public SruSrwClientImpl()

Method Detail

setEndPointURL

public void setEndPointURL(String endPointURL)

Sets the URI for the SRU/SRW service provider, default to http://z3950.loc.gov:7090/voyager

getEndPointURL

public String getEndPointURL()

Returns the the SRU/SRW service provider URI

Returns:

The URI for the SRU/SRW service provider, default to http://z3950.loc.gov:7090/voyager Required for any request

setProxyHostName

public void setProxyHostName(String proxyHostName)

Set the proxy name if a proxy is required (ex. "127.0.0.1" ) Default is ""

getProxyHostName

public String getProxyHostName()

Returns the proxy hostname

Returns:

the proxy name

setProxyUserId

public void setProxyUserId(String proxyUserId)

Set the proxy userid if proxy is required and configured (non-empty), ignored otherwise Default is "anonymous", if a non-authenticate proxy is used this value must be the default

getProxyUserId

public String getProxyUserId()

Returns the proxy userid

Returns:

the proxy userid

setProxyPasswd

public void setProxyPasswd(String proxyPasswd)

Set the proxy password if proxy is required and configured (non-empty), ignored otherwise Default is "anonymous", if a non-authenticate proxy is used this value must be the default

getProxyPasswd

public String getProxyPasswd()

Returns the proxy userid

Returns:

the proxy password

setProxyPort

public void setProxyPort(String proxyPort)

Set the proxy port if proxy is required and configured (non-empty), ignored otherwise Content of the string must be between 1 and 65556 Default value is 8080

getProxyPort

public String getProxyPort()

Returns the proxy port

Returns:

the proxy port

callSruSrwProvider

public Map callSruSrwProvider(String identifier)
                       throws Exception

Looks up using SRU/SRW defined endpoint an identifier (normally ISBN) and returns the first record returned by SRU/SRW as a HashMap of fields

Specified by:

callSruSrwProvider in interface SruSrwClientInterface

Parameters:

identifier - Normally the isbn of the book to search, expressed in the "xxxxxxxxxx" format
ISBN can be in 10 or 13 digit format, no spaces or dashes

If something else is passed instead of an (unique) ISBN, the first record (of potentially many) is always returned.

This is a limitation due to the fact that the main SRU/SRW SP (LOC.GOV) does not seem to have implemented fully the dc (Dublin Core) context (missing especially the dc.identifier index).

For example, a search for Web Services will return: recordMap={TITLE=Introduction to Semantic Web and Semantic Web services /, PUBLISHER=Boca Raton, FL : CRC Press,, AUTHOR=Yu, Liyang., DATE=2007., SUBJECTSLIST=[Semantic Web., Web services.]}
Note that any dentifier strings containing spaces must be escaped (ex: "%22Web%20Services%22").

Returns:

Map containing the elements described above using the names: AUTHOR, TITLE, PUBLISHER, PUBLISHEDDATE, SUBJECTSLIST and String values, with the exception of SubjectsList whose value is a List of string subjects

Throws:

Exception - if either parameters are incorrect, the SRU/SRW enpoint cannot be called, if the returned XML cannot be parsed or if the record identified by identifier could not be found by provider

See Also:

SRU/SRW Specification for more details

getSOAPPayload

public org.apache.axiom.soap.SOAPEnvelope getSOAPPayload(String isbn)

Creates the full SOAPEnvelope to be sent to LOC, based on SRW schemas

Parameters:

isbn - The isbn of the book to search, expressed in the "xxxxxxxxxx" format ISBN can be in 10 or 13 digit format, no spaces or dashes

Returns:

SOAPEnvelope containing fully built payload to be passed to LOC