com.raritantechnologies.federated.eRoom
Class ERoomSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.federated.eRoom.ERoomSearchSource

All Implemented Interfaces:

IXmlQueryCommandHandler

public class ERoomSearchSource

extends SearchSource

implements IXmlQueryCommandHandler

RTI SearchSource that can retrieve records from a Documentum eRoom.

XML Configuration Template:

Developed by Raritan Technologies .

Author:

Pat Crabtree

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

ERoomSearchSource()

Method Summary

void	addStaticField(java.lang.String fieldID, java.lang.String value)
SOAPMessage	constructSearchQuery(OrderedMap inputParameters)
void	createXmlCommand(SOAPElement seCommand, java.lang.String query)
void	createXmlCommand(SOAPElement seCommand, java.lang.String query, OrderedMap childProperties)
java.lang.String	getERoomURI()
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	getProxyUser()
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
java.lang.String[]	getSourcePropertyNames() Returns a list of Source type specific property names.
java.lang.String	getUserName()
boolean	isUseSessionLogin()
IResultSet	processSearchCommand(SOAPMessage soapMessage, java.lang.String location)
boolean	processXmlQueryChildren(MessageElement meResponse, IResultSet brs)
void	setDEBUG(boolean debug)
void	setERoomURI(java.lang.String roomURI)
void	setPassword(java.lang.String password)
void	setProxyHost(java.lang.String proxyHost)
void	setProxyPassword(java.lang.String proxyPassword)
void	setProxyPort(java.lang.String proxyPort)
void	setProxyUser(java.lang.String proxyUser)
void	setUserName(java.lang.String userName)
void	setUseSessionLogin(java.lang.String useSess)

Methods inherited from class com.raritantechnologies.searchApp.SearchSource

addFieldFormatter, addSearchField, addSourceAttributes, 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

ERoomSearchSource

public ERoomSearchSource()

Method Detail

processSearchCommand

public IResultSet processSearchCommand(SOAPMessage soapMessage,
                                       java.lang.String location)
                                throws java.lang.Exception

Throws:

java.lang.Exception

constructSearchQuery

public SOAPMessage constructSearchQuery(OrderedMap inputParameters)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

createXmlCommand

public void createXmlCommand(SOAPElement seCommand,
                             java.lang.String query,
                             OrderedMap childProperties)
                      throws SOAPException

Specified by:

createXmlCommand in interface IXmlQueryCommandHandler

Throws:

SOAPException

createXmlCommand

public void createXmlCommand(SOAPElement seCommand,
                             java.lang.String query)
                      throws SOAPException

Specified by:

createXmlCommand in interface IXmlQueryCommandHandler

Throws:

SOAPException

processXmlQueryChildren

public boolean processXmlQueryChildren(MessageElement meResponse,
                                       IResultSet brs)

Specified by:

processXmlQueryChildren in interface IXmlQueryCommandHandler

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

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

getERoomURI

public java.lang.String getERoomURI()

setERoomURI

public void setERoomURI(java.lang.String roomURI)

getUserName

public java.lang.String getUserName()

setUserName

public void setUserName(java.lang.String userName)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

setDEBUG

public void setDEBUG(boolean debug)

getProxyHost

public java.lang.String getProxyHost()

setProxyHost

public void setProxyHost(java.lang.String proxyHost)

getProxyPort

public java.lang.String getProxyPort()

setProxyPort

public void setProxyPort(java.lang.String proxyPort)

getProxyUser

public java.lang.String getProxyUser()

setProxyUser

public void setProxyUser(java.lang.String proxyUser)

getProxyPassword

public java.lang.String getProxyPassword()

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

addStaticField

public void addStaticField(java.lang.String fieldID,
                           java.lang.String value)

Overrides:

addStaticField in class SearchSource

setUseSessionLogin

public void setUseSessionLogin(java.lang.String useSess)

isUseSessionLogin

public boolean isUseSessionLogin()