com.raritantechnologies.HTML.tools
Class GetURLProcess

java.lang.Object
  com.raritantechnologies.HTML.tools.GetURLProcess

All Implemented Interfaces:

IConfigurable, IJobProcess

public class GetURLProcess

extends java.lang.Object

implements IJobProcess

Executes a GET request on some HTTP URL.

XML Configuration Template:

   <JobProcess class="com.raritantechnologies.HTML.tools.GetURLProcess" 
                  urlTemplate="[ URL to hit. { } can be used as placeholders for request parameters ]"
                  cookiesCacheKey="[ session cache key for Cookies ]" >

     <!-- Optional set of request parameters to map to URL Template -->
     <RequestParameters>
       <Param ID="[ name of request parameter ]" />
     </RequestParameters>

     <ResponseFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

     </ResponseFilter>

     <!-- Optional IJobProcess to send the response to ... -->
     <OutputProcess class="[ class of com.raritantechnologies.searchApp.scheduler.IJobProcess ]"
                       responseParam="[ name of response parameter to put args or RaritanPageContext - default='GetResponse' ]"
                       useMethod="[ String[] | RaritanPageContext ]" >

     </OutputProcess>

     <!-- can also send output to a GatewayOutputProcessor -->
     <GatewayOutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor ]"
                                responseParam="[ name of response parameter to put in IResult field - default='GetResponse' ]"  >

     </GatewayOutputProcessor>

   </JobProcess>
 

Constructor Summary

GetURLProcess()

Method Summary

void	executeJob(RaritanPageContext rpc)
void	executeJob(java.lang.String[] args)
java.lang.String	getConfigurationXML()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetURLProcess

public GetURLProcess()

Method Detail

executeJob

public void executeJob(java.lang.String[] args)

Specified by:

executeJob in interface IJobProcess

executeJob

public void executeJob(RaritanPageContext rpc)

Specified by:

executeJob in interface IJobProcess

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IJobProcess

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IJobProcess