oracle.ifs.core.agents

Class DanglingObjectAVCleanupAgent

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

All Implemented Interfaces:

ServerInterface, TimerContext

public class DanglingObjectAVCleanupAgent
extends BaseAgent

A DanglingObjectAVCleanupAgent cleans up dangling object type attribute references.

Version:

1.0

Author:

Sirisha Ayyagari

(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	BATCH_SIZE
static String	DANGLINGCOUNTCUMULATIVE
static String	DANGLINGCOUNTLASTACTIVATION
static String	EXCLUDEDATTRIBUTES
protected int	m_DanglingRowsCumulative The number of dangling rows this agent cleared since starting.

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

Method Summary

Modifier and Type	Method and Description
protected void	activate() Perform garbage collection.
static int	cleanupAllArrayReferences(LibrarySession session, String[] exclusions, int batchSize, boolean bestEffort) Fix broken array references for all array LibraryObject type Attributes.
static int	cleanupAllScalarReferences(LibrarySession session, String[] exclusions, int batchSize, boolean bestEffort) Fix broken scalar references for all scalar LibraryObject type Attributes.
static int	cleanupArrayReferences(LibrarySession session, Attribute attr, Long attrId, int batchSize) Fix broken array references for the specified Attribute.
static int	cleanupScalarReferences(LibrarySession session, Attribute attr, int batchSize) Fix broken scalar references for the specified Attribute.
IfsLogger	getLogger() Gets the appropriate logger for this server.
void	initialize() Register detailed status information into our ServerDetail.
static void	main(String[] args) This is used to run the server in the standalone mode.
void	preRun() Read in properties from property table.

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, 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

EXCLUDEDATTRIBUTES

public static final String EXCLUDEDATTRIBUTES

See Also:

Constant Field Values

BATCH_SIZE

public static final String BATCH_SIZE

See Also:

Constant Field Values

DANGLINGCOUNTCUMULATIVE

public static final String DANGLINGCOUNTCUMULATIVE

See Also:

Constant Field Values

DANGLINGCOUNTLASTACTIVATION

public static final String DANGLINGCOUNTLASTACTIVATION

See Also:

Constant Field Values

m_DanglingRowsCumulative

protected int m_DanglingRowsCumulative

The number of dangling rows this agent cleared since starting.

(Unpublished)

Constructor Detail

DanglingObjectAVCleanupAgent

public DanglingObjectAVCleanupAgent()
                             throws IfsException

Constructs the DanglingObjectAVCleanupAgent.

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

main

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

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

Parameters:

args - Commandline arguments

Throws:

Exception - if the operation fails

(Unpublished)

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

preRun

public void preRun()
            throws Exception

Read in properties from property table.

Overrides:

preRun in class IfsServer

Throws:

Exception - if the operation fails

(Unpublished)

initialize

public void initialize()
                throws Exception

Register detailed status information into our ServerDetail.

This is called automatically from within register() after a successful registration. The implementation in IfsAgent publishes the status and priority information; subclasses will often extend this to publish other agent information.

Overrides:

initialize in class BaseAgent

Throws:

Exception - if the operation fails

(Published)

activate

protected void activate()
                 throws IfsException

Perform garbage collection.

Overrides:

activate in class BaseAgent

Throws:

IfsException - if the operation fails

(Unpublished)

cleanupAllScalarReferences

public static int cleanupAllScalarReferences(LibrarySession session,
                                             String[] exclusions,
                                             int batchSize,
                                             boolean bestEffort)
                                      throws IfsException

Fix broken scalar references for all scalar LibraryObject type Attributes.

This will change a broken reference value to 0 in the column of all scalar LibraryObject type Attributes, except for those indicated to be "skipped".

Parameters:

session - the session context

exclusions - the array of class-qualified Attribute names that should be excluded; contains strings like "PublicObject.Owner"

batchSize - the batch size to use while processing

bestEffort - true if exceptions should just be caught and logged; false if they are thrown

Returns:

the number of objects fixed

Throws:

IfsException - if the operation fails

(Unpublished)

cleanupAllArrayReferences

public static int cleanupAllArrayReferences(LibrarySession session,
                                            String[] exclusions,
                                            int batchSize,
                                            boolean bestEffort)
                                     throws IfsException

Fix broken array references for all array LibraryObject type Attributes.

This will change a broken reference value to 0 in the column of all array LibraryObject type Attributes, except for those indicated to be "skipped".

Parameters:

session - the session context

exclusions - the array of class-qualified Attribute names that should be excluded; contains strings like "PublicObject.Owner"

batchSize - the batch size to use while processing

bestEffort - true if exceptions should just be caught and logged; false if they are thrown

Returns:

the number of objects fixed

Throws:

IfsException - if the operation fails

(Unpublished)

cleanupScalarReferences

public static int cleanupScalarReferences(LibrarySession session,
                                          Attribute attr,
                                          int batchSize)
                                   throws IfsException

Fix broken scalar references for the specified Attribute.

This will change a broken reference value to 0 in the column of the Attribute specified.

Parameters:

session - the session context

attr - the Attribute to process

batchSize - the batch size to use while processing

Returns:

the number of objects fixed

Throws:

IfsException - if the operation fails

(Published)

cleanupArrayReferences

public static int cleanupArrayReferences(LibrarySession session,
                                         Attribute attr,
                                         Long attrId,
                                         int batchSize)
                                  throws IfsException

Fix broken array references for the specified Attribute.

This will change a broken reference value to 0 in the array table's value column of the, in the array table indicated by the Attribute specified.

Parameters:

session - the session context

attr - the Attribute to process

attrId - the Attribute ID; non-null only for SimpleObject arrays

batchSize - the batch size to use while processing

Returns:

the number of objects fixed

Throws:

IfsException - if the operation fails

(Published)