oracle.ifs.core.agents

Class ContentAgent

java.lang.Object

oracle.ifs.core.runtime.Server

oracle.ifs.core.runtime.IfsServer

oracle.ifs.core.runtime.ClusteredServer

oracle.ifs.core.agents.BaseAgent

oracle.ifs.core.agents.ContentAgent

All Implemented Interfaces:

IfsEventHandler, ServerInterface, TimerContext

public class ContentAgent
extends BaseAgent
implements IfsEventHandler

A ContentAgent performs content-related background tasks.

(Unpublished)

Nested Class Summary

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

IfsServer.ServerRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	IFS_SERVER_AGENT_CONTENTAGENT_ExtractContentForIndexingBatchSize
static String	IFS_SERVER_AGENT_CONTENTAGENT_FilteredContentRemovalPeriod
static String	IFS_SERVER_AGENT_CONTENTAGENT_FreedContentBatchSize
static String	IFS_SERVER_TIMER_ActivationPeriod
static String	IFS_SERVER_TIMER_InitialDelay
static String	IFS_SERVER_TIMER_InitialTimeOfDay

Fields inherited from class oracle.ifs.core.agents.BaseAgent

ERROR_COUNT_CUMULATIVE, ERROR_COUNT_LAST_ACTIVATION

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
ContentAgent() Constructs the ContentAgent.

Method Summary

Modifier and Type	Method and Description
protected void	activate() Handle timer expired.
void	disableEventListening() Disable listening for events.
void	enableEventListening() Enable listening events on any ContentVaultEntry.
IfsLogger	getLogger() Gets the appropriate logger for this server.
void	handleEvent(IfsEvent event) Handles events.
protected void	handleResumeRequest() handle the resume request.
protected void	handleSuspendRequest() handle the suspend request.
void	initialize() Initialize prior to running
protected void	initOnRun() Initialize at start of run method.
static void	main(String[] args) This is used to run the ContentAgent in the standalone mode.
void	postRun() Performs post-run tasks.
void	processEvent(IfsEvent event) Process the next event.
protected void	processWithinRun() Process within the run loop.

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

addToProperty, handleStopRequest, handleTimerExpired, incrementProperty, isAgent, publishProperty, run, standardPostRun, 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, handlePropertyChangeRequest, handleRequest, handleRequests, handleServerStateControllerRequest, isNonCompeting, isPropertyReadonly, 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

Field Detail

IFS_SERVER_TIMER_InitialTimeOfDay

public static final String IFS_SERVER_TIMER_InitialTimeOfDay

See Also:

Constant Field Values

IFS_SERVER_TIMER_ActivationPeriod

public static final String IFS_SERVER_TIMER_ActivationPeriod

See Also:

Constant Field Values

IFS_SERVER_TIMER_InitialDelay

public static final String IFS_SERVER_TIMER_InitialDelay

See Also:

Constant Field Values

IFS_SERVER_AGENT_CONTENTAGENT_FilteredContentRemovalPeriod

public static final String IFS_SERVER_AGENT_CONTENTAGENT_FilteredContentRemovalPeriod

See Also:

Constant Field Values

IFS_SERVER_AGENT_CONTENTAGENT_FreedContentBatchSize

public static final String IFS_SERVER_AGENT_CONTENTAGENT_FreedContentBatchSize

See Also:

Constant Field Values

IFS_SERVER_AGENT_CONTENTAGENT_ExtractContentForIndexingBatchSize

public static final String IFS_SERVER_AGENT_CONTENTAGENT_ExtractContentForIndexingBatchSize

See Also:

Constant Field Values

Constructor Detail

ContentAgent

public ContentAgent()
             throws IfsException

Constructs the ContentAgent.

Throws:

IfsException - (IFS-46000) if the operation fails

(Unpublished)

Method Detail

main

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

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

Throws:

Exception

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 BaseAgent

Returns:

the logger

initialize

public void initialize()
                throws Exception

Initialize prior to running

Overrides:

initialize in class BaseAgent

Throws:

Exception - if the operation fails

initOnRun

protected void initOnRun()
                  throws Exception

Initialize at start of run method.

Overrides:

initOnRun in class BaseAgent

Throws:

Exception

postRun

public void postRun()

Performs post-run tasks.

Overrides:

postRun in class BaseAgent

(Unpublished)

handleSuspendRequest

protected void handleSuspendRequest()
                             throws Exception

Description copied from class: BaseAgent

handle the suspend request. Overridden here for logging and stopping the timmer.

Overrides:

handleSuspendRequest in class BaseAgent

Throws:

Exception - if the operation fails

handleResumeRequest

protected void handleResumeRequest()
                            throws Exception

Description copied from class: BaseAgent

handle the resume request. Overridden here for logging and starting the timer.

Overrides:

handleResumeRequest in class BaseAgent

Throws:

Exception - if the operation fails

enableEventListening

public void enableEventListening()
                          throws IfsException

Enable listening events on any ContentVaultEntry.

Throws:

IfsException - if the operation fails

disableEventListening

public void disableEventListening()
                           throws IfsException

Disable listening for events.

Throws:

IfsException - if the operation fails

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Handles events.

Specified by:

handleEvent in interface IfsEventHandler

Parameters:

event - the event

Throws:

IfsException - if the operation fails

processEvent

public void processEvent(IfsEvent event)
                  throws IfsException

Process the next event.

Overrides:

processEvent in class IfsServer

Parameters:

event - The next event to process.

Throws:

IfsException - if the operation fails

processWithinRun

protected void processWithinRun()
                         throws IfsException

Process within the run loop.

Overrides:

processWithinRun in class BaseAgent

Throws:

IfsException - if the operation fails

activate

protected void activate()
                 throws IfsException

Handle timer expired.

Overrides:

activate in class BaseAgent

Throws:

IfsException - if the operation fails

(Unpublished)