com.raritantechnologies.federated.SOAP
Class SOAPSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.federated.SOAP.SOAPSearchSource

public class SOAPSearchSource

extends SearchSource

Describes a SOAP search source. Uses helper classes ISOAPMethodSequence and SOAPMethod to define the SOAP method/response process needed to implement the query defined for this source in the SOAPSearchSource configuration (see SOAPSearchSourceFactory).

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from class com.raritantechnologies.searchApp.SearchSource

ID_FIELD, IS_FEDERATED, NUMBER_OF_FIELDS, SECURE, SOURCE_NAME, SOURCE_TYPE, TITLE_FIELD, URL_FIELD

Constructor Summary

SOAPSearchSource()

Method Summary

void	addSOAPMethod(SOAPMethod sMethod)
org.w3c.dom.Document	doSOAPCall(java.util.Map queryParams, ILoginInfo userInfo, java.lang.Integer pageSize, java.lang.Integer startRec, SOAPQueryProcessor soapQProc) Performs the SOAP method call using one or more SOAPMethod objects.
java.lang.String	getHtmlParserClass()
java.lang.String	getPassword()
java.lang.Object	getProperty(java.lang.String property) returns a Source Property.
java.lang.String	getProxyHost()
java.lang.String	getProxyPassword()
java.lang.String	getProxyPort()
java.lang.String	getProxyUserName()
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
java.lang.String	getResultType()
java.lang.String	getScrapeXML()
java.lang.String	getScrapeXSL()
SOAPMethod	getSOAPMethod()
SOAPMethod	getSOAPMethod(java.lang.String name)
ISOAPMethodSequence	getSOAPMethodSequence()
java.lang.String	getSOAPTransform()
javax.xml.transform.Transformer	getSOAPTransformer()
java.lang.String[]	getSourcePropertyNames() Returns a list of Source type specific property names.
java.lang.String	getTargetObjectURI()
boolean	getTotalDocsAreReliable()
java.lang.String	getUserName()
boolean	needsRetransform()
void	setHtmlParserClass(java.lang.String prophtmlParserClass)
void	setNeedsRetransform(boolean needsSecondTransform)
void	setProxyHost(java.lang.String proxyHost)
void	setProxyPassword(java.lang.String proxyPassword)
void	setProxyPort(java.lang.String proxyPort)
void	setProxyUserName(java.lang.String proxyUserName)
void	setResultType(java.lang.String propResultType)
void	setScrapeXML(java.lang.String propScrapeXML)
void	setScrapeXSL(java.lang.String propScrapeXSL)
void	setSOAPMethodSequence(ISOAPMethodSequence smSeq)
void	setSOAPTransform(java.lang.String soapTransform)
void	setSOAPTransformer(javax.xml.transform.Transformer soapTransformer)
void	setSOAPUserLogin(java.lang.String userName, java.lang.String password)
void	setTargetObjectURI(java.lang.String propTargetObjectURI)
void	setTotalDocsAreReliable(boolean areReliable)

Methods inherited from class com.raritantechnologies.searchApp.SearchSource

addFieldFormatter, addSearchField, addSourceAttributes, addStaticField, addStaticFields, addUserSearchField, canAccess, canConsolidateSources, consolidateSources, delSearchField, formatResult, formatResult, formatResultField, formatResultField, formatResults, formatResults, getAccessableFields, getAttributes, getBasePath, getConfigPath, getDisplayName, getFieldFormatters, getIDField, getName, getSearchField, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, getTitleField, getType, getURLField, getUserSearchFields, isMultiThreaded, setConfigPath, setDisplayName, setIDField, setMultiThreaded, setName, setSecurityManagerName, setSecurityModel, setSortMap, setSourcePropertyInfoSource, setTitleField, setType, setURLField, shouldFormatResults, supportsBackgroundSort

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPSearchSource

public SOAPSearchSource()

Method Detail

getQueryProcessor

public IQueryProcessor getQueryProcessor()

Description copied from class: SearchSource

returns the type of QueryProcessor that can access this SearchSource.

Specified by:

getQueryProcessor in class SearchSource

getTargetObjectURI

public java.lang.String getTargetObjectURI()

setTargetObjectURI

public void setTargetObjectURI(java.lang.String propTargetObjectURI)

getResultType

public java.lang.String getResultType()

setResultType

public void setResultType(java.lang.String propResultType)

getHtmlParserClass

public java.lang.String getHtmlParserClass()

setHtmlParserClass

public void setHtmlParserClass(java.lang.String prophtmlParserClass)

getScrapeXML

public java.lang.String getScrapeXML()

setScrapeXML

public void setScrapeXML(java.lang.String propScrapeXML)

getScrapeXSL

public java.lang.String getScrapeXSL()

setScrapeXSL

public void setScrapeXSL(java.lang.String propScrapeXSL)

getSOAPTransform

public java.lang.String getSOAPTransform()

setSOAPTransform

public void setSOAPTransform(java.lang.String soapTransform)

getSOAPTransformer

public javax.xml.transform.Transformer getSOAPTransformer()

setSOAPTransformer

public void setSOAPTransformer(javax.xml.transform.Transformer soapTransformer)

setNeedsRetransform

public void setNeedsRetransform(boolean needsSecondTransform)

needsRetransform

public boolean needsRetransform()

doSOAPCall

public org.w3c.dom.Document doSOAPCall(java.util.Map queryParams,
                                       ILoginInfo userInfo,
                                       java.lang.Integer pageSize,
                                       java.lang.Integer startRec,
                                       SOAPQueryProcessor soapQProc)

Performs the SOAP method call using one or more SOAPMethod objects. The SOAPEnvelope response from the last SOAPMethod in the list is returned as a DOM Document.

addSOAPMethod

public void addSOAPMethod(SOAPMethod sMethod)

getSOAPMethod

public SOAPMethod getSOAPMethod(java.lang.String name)

getSOAPMethod

public SOAPMethod getSOAPMethod()

setSOAPMethodSequence

public void setSOAPMethodSequence(ISOAPMethodSequence smSeq)

getSOAPMethodSequence

public ISOAPMethodSequence getSOAPMethodSequence()

getSourcePropertyNames

public java.lang.String[] getSourcePropertyNames()

Description copied from class: SearchSource

Returns a list of Source type specific property names.

Overrides:

getSourcePropertyNames in class SearchSource

getProperty

public java.lang.Object getProperty(java.lang.String property)

Description copied from class: SearchSource

returns a Source Property. The standard pattern is to return a String or Object if a property has a single value and a String or Object Array if the property has multiple values.

Overrides:

getProperty in class SearchSource

setTotalDocsAreReliable

public void setTotalDocsAreReliable(boolean areReliable)

getTotalDocsAreReliable

public boolean getTotalDocsAreReliable()

setProxyHost

public void setProxyHost(java.lang.String proxyHost)

getProxyHost

public java.lang.String getProxyHost()

setProxyPort

public void setProxyPort(java.lang.String proxyPort)

getProxyPort

public java.lang.String getProxyPort()

setProxyUserName

public void setProxyUserName(java.lang.String proxyUserName)

getProxyUserName

public java.lang.String getProxyUserName()

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

getProxyPassword

public java.lang.String getProxyPassword()

setSOAPUserLogin

public void setSOAPUserLogin(java.lang.String userName,
                             java.lang.String password)

getUserName

public java.lang.String getUserName()

getPassword

public java.lang.String getPassword()