oracle.ifs.core.agents

Class MultipleTimerAgent

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.MultipleTimerAgent

All Implemented Interfaces:

ServerInterface, TimerContext

Direct Known Subclasses:

DatabaseManagementAgent

public abstract class MultipleTimerAgent
extends BaseAgent

MultipleTimerAgent is an abstract class that provides framework for having multiple timed actions within the same agent.

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MultipleTimerAgent.MultipleTimerTask A MultipleTimerTask is a TimerTask with its run() method implemented to post a request to the agent request queue, and an abstract method for execution of the task.

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

IfsServer.ServerRequest

Field Summary

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

Method Summary

Modifier and Type	Method and Description
protected void	activate() Dummy implementation for activate.
IfsLogger	getLogger() Gets the appropriate logger for this server.
protected void	handleRequest(IfsServer.ServerRequest request) Handles the specified pending request.
protected void	initOnRun() Perform Initialization at start of run method.
void	postRun() Performs post-run tasks.
protected abstract void	registerTasks() Perform Initialization at start of run method.
protected void	registerTimerTask(MultipleTimerAgent.MultipleTimerTask task, String execPeriod, String baseTimeOfDay, String timeFormat) Registers a MultipleTimerTask.

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

addToProperty, handleResumeRequest, handleStopRequest, handleSuspendRequest, handleTimerExpired, incrementProperty, initialize, isAgent, processWithinRun, 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, handleRequests, handleServerStateControllerRequest, isNonCompeting, isPropertyReadonly, isServiceAvailable, isTimerActive, postCheckServerStateRequest, postRequest, preRun, processEvent, 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

MultipleTimerAgent

public MultipleTimerAgent()
                   throws IfsException

Constructs the MultipleTimerAgent.

Throws:

IfsException - if the operation fails

(Published)

Method Detail

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

initOnRun

protected void initOnRun()
                  throws Exception

Perform Initialization at start of run method.

Overrides:

initOnRun in class BaseAgent

Throws:

Exception - if the operation fails

(Unpublished)

registerTasks

protected abstract void registerTasks()
                               throws IfsException

Perform Initialization at start of run method.

Throws:

IfsException

(Published)

postRun

public void postRun()

Performs post-run tasks.

Overrides:

postRun in class BaseAgent

(Unpublished)

registerTimerTask

protected void registerTimerTask(MultipleTimerAgent.MultipleTimerTask task,
                                 String execPeriod,
                                 String baseTimeOfDay,
                                 String timeFormat)
                          throws IfsException

Registers a MultipleTimerTask.

Parameters:

task - the task

execPeriod - the execution period (e.g. "12H")

baseTimeOfDay - the base time of day

timeFormat - the time format; if null, use "HH:mm:ss"

Throws:

IfsException - if the operation fails

(Published)

handleRequest

protected void handleRequest(IfsServer.ServerRequest request)
                      throws IfsException

Handles the specified pending request.

Overridden to handle the custom requests for this agent. Defers to super for the standard request types.

Overrides:

handleRequest in class IfsServer

Parameters:

request - the request to handle

Throws:

IfsException - if the operation fails

(Unpublished)

activate

protected void activate()
                 throws IfsException

Dummy implementation for activate.

Overrides:

activate in class BaseAgent

Throws:

IfsException - if operation fails

(Published)