oracle.ifs.core.agents

Class GarbageCollectionAgent

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

All Implemented Interfaces:

ServerInterface, TimerContext

public class GarbageCollectionAgent
extends BaseAgent

A GarbageCollectionAgent performs a variety of cleanup tasks.

Version:

1.0

Author:

David Pitfield

(Unpublished)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GarbageCollectionAgent.PublicObjectInfo Represents info for a selected PublicObject.

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_GARBAGECOLLECTIONAGENT_ReplacementCreator
static String	IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementDeletor
static String	IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementModifier
static String	IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementOwner
static String	IFS_SERVER_TIMER_ActivationPeriod
static String	IFS_SERVER_TIMER_InitialDelay
static String	IFS_SERVER_TIMER_InitialTimeOfDay
protected int	m_ErrorCountThisActivation The number of errors occuring in the current Activation.

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

Method Summary

Modifier and Type	Method and Description
protected void	activate() Perform garbage collection.
IfsLogger	getLogger() Gets the appropriate logger for this server.
void	initialize() Initialize prior to running
static void	main(String[] args) Static main for running GarbageCollectionAgent Agent standalone.
protected GarbageCollectionAgent.PublicObjectInfo[]	selectIdBatch(LibrarySession session, String attrName, long lastId, int batchSize) Select a batch of PublicObject IDs that reference a non-existent user via one of the PublicObject attributes.

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

addToProperty, handleResumeRequest, handleStopRequest, handleSuspendRequest, handleTimerExpired, incrementProperty, initOnRun, isAgent, postRun, 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, handleRequest, 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

Field Detail

IFS_SERVER_TIMER_ActivationPeriod

public static final String IFS_SERVER_TIMER_ActivationPeriod

See Also:

Constant Field Values

IFS_SERVER_TIMER_InitialTimeOfDay

public static final String IFS_SERVER_TIMER_InitialTimeOfDay

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_GARBAGECOLLECTIONAGENT_ReplacementOwner

public static final String IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementOwner

See Also:

Constant Field Values

IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementDeletor

public static final String IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementDeletor

See Also:

Constant Field Values

IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementCreator

public static final String IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementCreator

See Also:

Constant Field Values

IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementModifier

public static final String IFS_SERVER_AGENT_GARBAGECOLLECTIONAGENT_ReplacementModifier

See Also:

Constant Field Values

m_ErrorCountThisActivation

protected int m_ErrorCountThisActivation

The number of errors occuring in the current Activation.

Constructor Detail

GarbageCollectionAgent

public GarbageCollectionAgent()
                       throws IfsException

Constructs the GarbageCollectionAgent.

Throws:

IfsException - if the operation fails

Method Detail

main

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

Static main for running GarbageCollectionAgent Agent standalone.

Parameters:

args - commandline 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 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

activate

protected void activate()
                 throws IfsException

Perform garbage collection.

Overrides:

activate in class BaseAgent

Throws:

IfsException - if the operation fails

selectIdBatch

protected GarbageCollectionAgent.PublicObjectInfo[] selectIdBatch(LibrarySession session,
                                                                  String attrName,
                                                                  long lastId,
                                                                  int batchSize)
                                                           throws IfsException

Select a batch of PublicObject IDs that reference a non-existent user via one of the PublicObject attributes.

Parameters:

session - session context

attrName - Name of the DirectoryUser attribute being handled

lastId - the last ID processed, included in the query to only process IDs greater than this value

batchSize - the maximum number of rows to be selected

Returns:

the batch of PublicObjectInfo

Throws:

SQLException - if the operation fails

IfsException