com.raritantechnologies.federated.eRoom
Class ERoomUpdateProcess

java.lang.Object
  com.raritantechnologies.federated.eRoom.ERoomUpdateProcess

All Implemented Interfaces:

IConfigurable, IJobProcess

public class ERoomUpdateProcess

extends java.lang.Object

implements IJobProcess

Manages a recurring eRoom Collection update process. Uses IGatewayOutputProcessor to create, update and delete eRoom / collection mapping.

When the ERoomUpdateProcess is run by the scheduler or initiated by a command-line process execution, the ERoom facility to determine whether a document should be created, updated or deleted from the available eRooms XML Configuration Template:

   <JobProcess class="com.raritantechnologies.federated.eRoom.ERoomUpdateProcess"
      batchSize="10"
      retryDelete="true"
      holdDeleteDuration="5"
      eRoomPersistenceTableName="[ Name Of Database Tracking Table"  (default is 'document') ]"
      trackingFields="[ comma separated list of fields to track in the IResult ]"
      removeFilesAfterProcessing="[true(default)|false]"
      cleanUpAfterHours="[ number of hours to leave stale temp files ]"
      tempFileDirectory="[ path to temp file directory ]"
      filePathField="[ field in result with file path ]"
      maxProcesses="[ maximum number of concurrent eRoomGateway processes to run ]"
      statsFile="[ file path to Stats File ]" >

     <ERoomGateway >
        <!-- See configuration details for ERoomGateway -->
     </ERoomGateway>

     <!-- OutputProcessor should support "indexMode" attribute to handle CREATE | UPDATE | DELETE -->
     <OutputProcessor class="[ class of com.raritantechnologies.searchApp.dataCollection.IGatewayOutputProcessor"
                         indexMode="[ CREATE | UPDATE | FORCE_UPDATE | DELETE (Note: this attribute will be inserted by the ERoomUpdateProcess) ]" >

    </OutputProcessor>

   </JobProcess>
 

Developed by Raritan Technologies .

Author:

Pat Crabtree

Field Summary

static java.lang.String	ADD_MODE
static java.lang.String	CREATE_STATUS
static java.lang.String	DELETE_MODE
static java.lang.String	DELETED_STATUS
static java.lang.String	FORCE_UPDATE
static int	MAX_BATCH_SIZE
static java.lang.String	NOCHANGE_STATUS
static java.lang.String	UNKNOWN_STATUS
static java.lang.String	UPDATE_MODE
static java.lang.String	UPDATE_STATUS

Constructor Summary

ERoomUpdateProcess()

Method Summary

void	executeJob(RaritanPageContext rpc)
void	executeJob(java.lang.String[] args) Initiates the update process.
java.lang.String	getConfigurationXML()
ERoomGateway	getERoomGateway()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setERoomConnection(java.lang.String eRoomName, java.lang.String eRoomURL, java.lang.String userName, java.lang.String password)
void	setERoomGateway(ERoomGateway roomGateway)

Methods inherited from class java.lang.Object

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

Field Detail

CREATE_STATUS

public static java.lang.String CREATE_STATUS

UPDATE_STATUS

public static java.lang.String UPDATE_STATUS

NOCHANGE_STATUS

public static java.lang.String NOCHANGE_STATUS

UNKNOWN_STATUS

public static java.lang.String UNKNOWN_STATUS

DELETED_STATUS

public static java.lang.String DELETED_STATUS

ADD_MODE

public static java.lang.String ADD_MODE

UPDATE_MODE

public static java.lang.String UPDATE_MODE

FORCE_UPDATE

public static java.lang.String FORCE_UPDATE

DELETE_MODE

public static java.lang.String DELETE_MODE

MAX_BATCH_SIZE

public static int MAX_BATCH_SIZE

Constructor Detail

ERoomUpdateProcess

public ERoomUpdateProcess()

Method Detail

executeJob

public void executeJob(RaritanPageContext rpc)

Specified by:

executeJob in interface IJobProcess

executeJob

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

Initiates the update process.

Specified by:

executeJob in interface IJobProcess

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML 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

getERoomGateway

public ERoomGateway getERoomGateway()

setERoomGateway

public void setERoomGateway(ERoomGateway roomGateway)

setERoomConnection

public void setERoomConnection(java.lang.String eRoomName,
                               java.lang.String eRoomURL,
                               java.lang.String userName,
                               java.lang.String password)