com.raritantechnologies.federated
Class RaritanWorker

java.lang.Object
  Worker
      com.raritantechnologies.federated.RaritanWorker

Direct Known Subclasses:

QueryProcessorFilterWorker, RaritanAutonomyWorker, RaritanDieselpointWorker, RaritanDQLWorker, RaritanERoomWorker, RaritanExaleadWorker, RaritanFastWorker, RaritanHTMLWorker, RaritanLDAPWorker, RaritanLuceneWorker, RaritanMarkLogicWorker, RaritanOmniFindWorker, RaritanSevWorker, RaritanSOAPWorker, RaritanSQLWorker, RaritanUltraseekWorker, RaritanVerityWorker, RaritanVWebServicesWorker, RaritanZ3950Worker

public abstract class RaritanWorker

extends Worker

Abstract base class for Raritan Technologies Verity Federated Workers.

Does mapping from ConfigurationManager etc and Federated API to the Raritan IQueryProcessor layer. Z39.50, HTML, SOAP and SQL are all QueryProcessors.

Handles Federated Parameters to create consolidated UI - connects these to the SearchFieldMap. Also handles mapping the IResultSet into the Verity Federated ResultSet. Conversion is done using an XSLT which is referenced by the Federated Configuration XML for each SearchSource. XSL Transforms for each SearchSource are obtained from the FederatedConfigurationManager.

Security will be handled by Federated Parameters passed from the Raritan User Interface. The parameters are then passed to the ISecurityManager by RaritanWorker to see if the user can access the SearchSources that this worker uses. Extensions of RaritanWorker (eg HTMLWorker, SOAPWorker, etc) handle the creation of the IQueryProcessor and loading any special modules that are needed.

Verity Configuration Schema
Extra parameters used by RaritanWorker:

• searchSource = The RTI SearchSource (worker) linked to this instance of RaritanWorker.
  
• searchForm = The RTI SearchForm used to provide search input (only for RTI Enhanced Federated).
• requestFields = Comma separated list of search fields that will be set to the value of the Verity "requestString" parameter. (for standard Verity Federated Applications).
• fixedParameters = comma separated list of param=value pairs (used with standard Verity Federated).

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

See Also:

Serialized Form

Field Summary

protected IQueryProcessor	theQueryProcessor
protected SearchSource[]	theSearchSource

Constructor Summary

RaritanWorker()

Method Summary

protected void	doSetCookie(WorkerRequest workerRequest, IResultSet frs)
protected abstract SearchSource	getSearchSource(ISearchFieldMap sfMap, java.lang.String sourceName) returns the SearchSource appropriate to the RaritanWorker subclass.
protected abstract IXMLSearchSourceFactory	getSearchSourceFactory()
void	handleRequest(WorkerRequest workerRequest) Translates workerrequest into HashMap which it passes to the IQueryProcessor Uses its SearchSource and the singleton ISearchFieldMap as params to executeQuery( ) Maps result XML to req.getResultSet( )
java.lang.Object	handleTargetedRequest(TargetedRequest req)
void	init(ReadAttributes attribs, ReadAttributes globalEnv) Uses the SearchSource "sourceName" contained in the Federated Config.XML to find the SearchSource from the ConfigurationManager SearchFieldMap.
void	setCookie(WorkerRequest workerRequest, java.lang.String cookieVal)

Methods inherited from class java.lang.Object

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

Field Detail

theSearchSource

protected SearchSource[] theSearchSource

theQueryProcessor

protected IQueryProcessor theQueryProcessor

Constructor Detail

RaritanWorker

public RaritanWorker()

Method Detail

init

public void init(ReadAttributes attribs,
                 ReadAttributes globalEnv)
          throws WorkerCreationException

Uses the SearchSource "sourceName" contained in the Federated Config.XML to find the SearchSource from the ConfigurationManager SearchFieldMap. Delegates to the subclass which knows which type of searchSource it needs and which type of QueryProcessor it uses.

Throws:

WorkerCreationException

getSearchSource

protected abstract SearchSource getSearchSource(ISearchFieldMap sfMap,
                                                java.lang.String sourceName)

returns the SearchSource appropriate to the RaritanWorker subclass.

getSearchSourceFactory

protected abstract IXMLSearchSourceFactory getSearchSourceFactory()

handleRequest

public void handleRequest(WorkerRequest workerRequest)

Translates workerrequest into HashMap which it passes to the IQueryProcessor Uses its SearchSource and the singleton ISearchFieldMap as params to executeQuery( ) Maps result XML to req.getResultSet( )

handleTargetedRequest

public java.lang.Object handleTargetedRequest(TargetedRequest req)
                                       throws TargetedRequestException

Throws:

TargetedRequestException

doSetCookie

protected void doSetCookie(WorkerRequest workerRequest,
                           IResultSet frs)

setCookie

public void setCookie(WorkerRequest workerRequest,
                      java.lang.String cookieVal)