oracle.ifs.core.agents

Class QuotaAgent

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

All Implemented Interfaces:

IfsEventHandler, ServerInterface, TimerContext

public class QuotaAgent
extends BaseAgent
implements IfsEventHandler

A QuotaAgent periodically calculates the Consumed Quota for directory users and updates the consumed storage.

The predicted consumed storage for each directory user and the number of events received is stored in a private class, ContentQuotaTracker. The Quota agent re-calculates the consumedStorage either when the predicted consumed storage is over the allocated storage, or when a timer event occurs and there has been some activity for the user since the last timer event.

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	IFS_SERVER_TIMER_ActivationPeriod
static String	IFS_SERVER_TIMER_InitialDelay
static String	IFS_SERVER_TIMER_InitialTimeOfDay
static String	LAST_QUOTA_ACTIVE_COUNT
static String	LAST_QUOTA_EXCEEDED_COUNT
protected int	m_LastQuotaActiveCount The number of Quotas this agent recalculated due to activity in last timer period
protected int	m_LastQuotaExceededCount The number of Quotas this agent recalculated due to a "quota exceeded" detection in last timer period,
protected Hashtable	m_QuotaTrackerTable The hashtable that maps contentquota objects to the corresponding QuotaTracker objects
protected int	m_TotalQuotaActiveCount The number of Quotas this agent recalculated due to activity since starting.
protected int	m_TotalQuotaExceededCount The number of Quotas this agent recalculated due to a "quota exceeded" detection since starting.
static String	TOTAL_QUOTA_ACTIVE_COUNT
static String	TOTAL_QUOTA_EXCEEDED_COUNT

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

Method Summary

Modifier and Type	Method and Description
protected void	activate() handle the timer expired request.
void	disableEventListening() Disable listening for ContentQuota object events.
void	enableEventListening() Enable listening for ContentQuota object events
IfsLogger	getLogger() Gets the appropriate logger for this server.
void	handleEvent(IfsEvent event) Handles events on ContentQuota objects.
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 Quota Agent in the standalone mode.
void	postRun() Performs post-run tasks for this QuotaAgent.
void	processEvent(IfsEvent event) Process the next event
protected void	publishProperties()

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

addToProperty, handleStopRequest, handleTimerExpired, incrementProperty, 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, 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_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

LAST_QUOTA_EXCEEDED_COUNT

public static final String LAST_QUOTA_EXCEEDED_COUNT

See Also:

Constant Field Values

TOTAL_QUOTA_EXCEEDED_COUNT

public static final String TOTAL_QUOTA_EXCEEDED_COUNT

See Also:

Constant Field Values

LAST_QUOTA_ACTIVE_COUNT

public static final String LAST_QUOTA_ACTIVE_COUNT

See Also:

Constant Field Values

TOTAL_QUOTA_ACTIVE_COUNT

public static final String TOTAL_QUOTA_ACTIVE_COUNT

See Also:

Constant Field Values

m_LastQuotaExceededCount

protected int m_LastQuotaExceededCount

The number of Quotas this agent recalculated due to a "quota exceeded" detection in last timer period,

(Unpublished)

m_TotalQuotaExceededCount

protected int m_TotalQuotaExceededCount

The number of Quotas this agent recalculated due to a "quota exceeded" detection since starting.

(Unpublished)

m_LastQuotaActiveCount

protected int m_LastQuotaActiveCount

The number of Quotas this agent recalculated due to activity in last timer period

(Unpublished)

m_TotalQuotaActiveCount

protected int m_TotalQuotaActiveCount

The number of Quotas this agent recalculated due to activity since starting.

(Unpublished)

m_QuotaTrackerTable

protected Hashtable m_QuotaTrackerTable

The hashtable that maps contentquota objects to the corresponding QuotaTracker objects

(Unpublished)

Constructor Detail

QuotaAgent

public QuotaAgent()
           throws IfsException

Constructs the QuotaAgent.

Throws:

IfsException - (IFS-46000) if the operation fails

(Published)

Method Detail

main

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

This is used to run the Quota Agent 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

Description copied from class: BaseAgent

Initialize at start of run method

Overrides:

initOnRun in class BaseAgent

Throws:

Exception

handleSuspendRequest

protected void handleSuspendRequest()
                             throws Exception

handle the suspend request. Subclasses can override this to perform custom tasks as part of a Suspend request.

Overrides:

handleSuspendRequest in class BaseAgent

Throws:

IfsException - if operation fails

Exception - if the operation fails

(Published)

handleResumeRequest

protected void handleResumeRequest()
                            throws Exception

handle the resume request. Subclasses can override this to perform custom tasks as part of a Resume request.

Overrides:

handleResumeRequest in class BaseAgent

Throws:

IfsException - if operation fails

Exception - if the operation fails

(Published)

activate

protected void activate()
                 throws IfsException

handle the timer expired request.

Overrides:

activate in class BaseAgent

Throws:

IfsException - if operation fails

(Published)

postRun

public void postRun()

Performs post-run tasks for this QuotaAgent.

Overrides:

postRun in class BaseAgent

(Unpublished)

enableEventListening

public void enableEventListening()
                          throws IfsException

Enable listening for ContentQuota object events

Throws:

IfsException

(Unpublished)

disableEventListening

public void disableEventListening()
                           throws IfsException

Disable listening for ContentQuota object events.

Throws:

IfsException

(Unpublished)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Handles events on ContentQuota objects. This queues the events for processing by the main agent thread.

Specified by:

handleEvent in interface IfsEventHandler

Parameters:

event - the event

Throws:

IfsException - if the operation fails

(Published)

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

(Unpublished)

publishProperties

protected void publishProperties()
                          throws IfsException

Throws:

IfsException