com.raritantechnologies.HTML
Class HTTPRestOutputProcessor

java.lang.Object
  com.raritantechnologies.HTML.HTTPRestOutputProcessor

All Implemented Interfaces:

IConfigurable, IGatewayOutputProcessor, IResultSetProcessor

public class HTTPRestOutputProcessor

extends java.lang.Object

implements IResultSetProcessor, IGatewayOutputProcessor

Uses HTTP REST API to execute some action on one or more IResult metadata objects.

XML Configuration Template:

  <ResultSetProcessor class="com.raritantechnologies.HTML.HTTPRestOutputProcessor"
                         requestURL="[ base URL for the HTTP request ]"
                         requestMethod="[ GET | POST | GET_AUTHORIZED | POST_AUTHORIZED ]"
                         userLoginName="[ login credentials in UserInfo ]" >

    <!-- List user attributes to add to request -->
    <UserAttributes>
       <Attribute name="[ name of user attribute ]" />
    </UserAttributes>

    <!-- Uses a ResultRenderer to create the request packet -->
    <ResultRenderer class="[ class of com.raritantechnologies.searchApp.taglibrary.IResultRenderer ]" >

    </ResultRenderer>

    <!-- Alternatively can use an IXMLResultRenderer to get the request packet -->
    <XMLResultRenderer class="[ class of com.raritantechnologies.xml.IXMLResultRenderer ]" >

    </XMLResultRenderer>
  
  </ResultSetProcessor>
 

Constructor Summary

HTTPRestOutputProcessor()

Method Summary

void	dataComplete() Data feed is complete.
java.lang.String	getConfigurationXML()
void	initialize(org.w3c.dom.Element elem) Initialize the from XML Element.
void	initialize(org.w3c.dom.Element configElem, ISearchFieldMap sfMap) Initialize the GatewayOutputProcessor from XML Configuration Element.
void	initialize(java.util.Map initParams) Dynamic initialization.
java.lang.String	processData(IResultSet data) returns name of XML File created/appended.
void	processResultSet(java.lang.String sessionID, IResultSet data) processes the IResultSet (somehow)

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPRestOutputProcessor

public HTTPRestOutputProcessor()

Method Detail

processData

public java.lang.String processData(IResultSet data)

Description copied from interface: IGatewayOutputProcessor

returns name of XML File created/appended.

Specified by:

processData in interface IGatewayOutputProcessor

processResultSet

public void processResultSet(java.lang.String sessionID,
                             IResultSet data)

Description copied from interface: IResultSetProcessor

processes the IResultSet (somehow)

Specified by:

processResultSet in interface IResultSetProcessor

dataComplete

public void dataComplete()

Description copied from interface: IResultSetProcessor

Data feed is complete.

Specified by:

dataComplete in interface IResultSetProcessor

initialize

public void initialize(java.util.Map initParams)

Description copied from interface: IResultSetProcessor

Dynamic initialization.

Specified by:

initialize in interface IResultSetProcessor

initialize

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

Initialize the from XML Element.

Specified by:

initialize in interface IResultSetProcessor

initialize

public void initialize(org.w3c.dom.Element configElem,
                       ISearchFieldMap sfMap)

Description copied from interface: IGatewayOutputProcessor

Initialize the GatewayOutputProcessor from XML Configuration Element.

Specified by:

initialize in interface IGatewayOutputProcessor

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IGatewayOutputProcessor