oracle.ifs.core.agents

Class ManualTextIndexingAgent

java.lang.Object

oracle.ifs.core.runtime.Server

oracle.ifs.core.runtime.IfsServer

oracle.ifs.core.runtime.ClusteredServer

oracle.ifs.core.agents.RetainedEventAgent

oracle.ifs.core.agents.ManualTextIndexingAgent

All Implemented Interfaces:

IfsEventHandler, ServerInterface, TimerContext

public class ManualTextIndexingAgent
extends RetainedEventAgent

A ManualTextIndexingAgent is used to process retained events that signal that an Action has been executed.

Author:

Dave Long

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.core.runtime.IfsServer

IfsServer.ServerRequest

Field Summary

Fields inherited from class oracle.ifs.core.runtime.Server

LEVEL_HIGH, LEVEL_LOW, LEVEL_MEDIUM, LEVEL_OFF

Fields inherited from interface oracle.ifs.core.runtime.ServerInterface

SERVERSTATUS_DISPOSED, SERVERSTATUS_RUNNING, SERVERSTATUS_STARTING, SERVERSTATUS_STOPPED, SERVERSTATUS_STOPPING, SERVERSTATUS_SUSPENDED, SERVERSTATUS_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ManualTextIndexingAgent() Constructs the ManualTextIndexingAgent.

Method Summary

Modifier and Type	Method and Description
void	disableEventListening() Disable listening for events on the ContentObject class.
void	enableEventListening() Enable listening events on ContentObject class.
protected String	getBatchSizePropertyName() Get the name of the property used to specify the event batch size.
protected String	getEventTargetKey() Get the event target key used for this agent.
IfsLogger	getLogger() Gets the appropriate logger for this server.
protected RetainedEvent	getRetainedEventSeed() Gets the retained event "seed" to select the appropriate type of retained events.
protected String	getRetryAttemptsPropertyName() Get the name of the property used to specify the number of times to retry process an event in case of failure.
void	initialize() Perform one time initialization tasks upon loading.
static void	main(String[] args) This is used to run the ManualTextIndexingAgent in the standalone mode.

Methods inherited from class oracle.ifs.core.agents.RetainedEventAgent

getBatchSize, getRetryAttempts, handleEvent, handlePropertyChangeRequest, handleResumeRequest, handleStopRequest, handleSuspendRequest, handleTimerExpired, isAgent, isPropertyReadonly, postProcessRetainedEvents, postRun, preBatchProcessing, processEvent, processRetainedEvent, run, supportsSuspendResume

Methods inherited from class oracle.ifs.core.runtime.ClusteredServer

cancelRegistration, checkRegistration, deriveAgentIdentifier, deriveRunningServerIdentifier, getAgentIdentifier, getAgentIdentifierPrefix, getRegistrationPeriod, getRunningNodeIdentifier, getRunningNodeName, getRunningServerIdentifier, initializeRegistration, isRegistered, isServerRunning, isTokenNonCompeting

Methods inherited from class oracle.ifs.core.runtime.IfsServer

checkSession, connectSession, constructSession, convertTimerInterval, convertTimerInterval, convertTimerInterval, dispose, getLastTimerActivation, getNextTimerActivation, getService, getTimerActivationPeriod, getTimerClassName, getTimerConfiguration, handlePriorityChangeRequest, handlePropertyChangeRequest, handleRequest, handleRequests, handleServerStateControllerRequest, isNonCompeting, isServiceAvailable, isTimerActive, postCheckServerStateRequest, postRequest, preRun, processEvents, queueEvent, resetTimer, restart, resume, serviceAvailabilityCheckNeeded, setPriority, setProperty, setProperty, start, startTimer, stop, stopRequested, stopTimer, suspend, timerExpired, waitForServiceAvailability, waitServer

Methods inherited from class oracle.ifs.core.runtime.Server

acquireSession, constructLibrarySessionPool, createServerState, deregister, disconnectSession, getConfigurationOverridesTable, getConfigurationTable, getCredential, getDesiredStatus, getIfsHome, getInitialConfigurationTable, getLoggerForLegacyLogging, getName, getNode, getNodeName, getOracleHome, getParameterTable, getPriority, getProperties, getProperty, getServerConfigurationName, getServerState, getServerStateValue, getServerType, getServiceName, getSession, getStateTable, getStatus, getSystemUserCredential, handleServerConfigurationOverrideRequest, handleServerStateEvent, initialize, initialize, isDisposed, isInitialized, isLogged, log, log, log, releaseSession, releaseSession, setDesiredStatus, setDesiredStatus, setSessionTimeoutPrevented, setStateProperty, setStatus, startStandalone, startStandalone, supportsPriority, toStatusLabel, toStatusLabel, toStatusLabel, verifyNotDisposed, verifyNotDisposed

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualTextIndexingAgent

public ManualTextIndexingAgent()
                        throws IfsException

Constructs the ManualTextIndexingAgent.

Throws:

IfsException - if the operation fails

Method Detail

main

public static void main(String[] args)
                 throws Exception

This is used to run the ManualTextIndexingAgent in the standalone mode.

Parameters:

args - command line args

Throws:

Exception - if the operation fails

getLogger

public IfsLogger getLogger()

Gets the appropriate logger for this server.

Typically overridden by subclasses to return the IfsLogger associatged with the specific server.

Overrides:

getLogger in class RetainedEventAgent

Returns:

the logger

initialize

public void initialize()
                throws Exception

Perform one time initialization tasks upon loading.

Overrides:

initialize in class RetainedEventAgent

Throws:

Exception - if the operation fails

getRetainedEventSeed

protected RetainedEvent getRetainedEventSeed()

Gets the retained event "seed" to select the appropriate type of retained events.

Specified by:

getRetainedEventSeed in class RetainedEventAgent

Returns:

an instance of the correct type of RetainedEvent that this agent processes

getEventTargetKey

protected String getEventTargetKey()

Get the event target key used for this agent.

Specified by:

getEventTargetKey in class RetainedEventAgent

Returns:

the event target key (to an object in the Domain property bundle)

getBatchSizePropertyName

protected String getBatchSizePropertyName()

Get the name of the property used to specify the event batch size.

Overrides:

getBatchSizePropertyName in class RetainedEventAgent

Returns:

the name of the "batch size" property

getRetryAttemptsPropertyName

protected String getRetryAttemptsPropertyName()

Get the name of the property used to specify the number of times to retry process an event in case of failure.

Overrides:

getRetryAttemptsPropertyName in class RetainedEventAgent

Returns:

the name of the "retry attempts" property

enableEventListening

public void enableEventListening()
                          throws IfsException

Enable listening events on ContentObject class.

Overrides:

enableEventListening in class RetainedEventAgent

Throws:

IfsException - if the operation fails

disableEventListening

public void disableEventListening()
                           throws IfsException

Disable listening for events on the ContentObject class.

Overrides:

disableEventListening in class RetainedEventAgent

Throws:

IfsException - if the operation fails