oracle.ifs.core.beans

Class DispatchingHandlerSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.DispatchingHandlerSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieDispatchingHandlerSpecification

public class DispatchingHandlerSpecification
extends TieSystemObject

A DispatchingHandlerSpecification specifies information used by a dispatching handler to dispatch AuditEvents to working handlers.

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVEWORKERCOUNT_ATTRIBUTE The name of the attribute that holds the number of working handlers that are active.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DESCRIPTION_ATTRIBUTE The name of the attribute that holds a textual description of the DispatchingHandlerSpecification.
static String	MAXWORKERCOUNT_ATTRIBUTE The name of the attribute that holds the maximum number of working handlers that can be active.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of this DispatchingHandlerSpecification.
static String	SETTINGS_ATTRIBUTE The name of the Attribute representing the settings used to perform dispatching.
static String	WORKERS_ATTRIBUTE The name of the attribute that holds the complete set of Working handlers defined.
static String	WORKERTEMPLATE_ATTRIBUTE The name of the attribute that holds the AuditSpecification that is used as the template for the working handlers.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DispatchingHandlerSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a DispatchingHandlerSpecification object.

Method Summary

Modifier and Type	Method and Description
void	addSetting(String key, AttributeValue value) Adds a setting (SimpleProperty) for this object.
static DispatchingHandlerSpecification[]	findAll(LibrarySession session) Returns the set of defined DispatchingHandlerSpecifications.
static DispatchingHandlerSpecification	findByName(LibrarySession session, String name) Returns the a DispatchingHandlerSpecification matching the specified name.
int	getActiveWorkerCount() Gets the number of working handlers that are active.
AuditSpecification[]	getActiveWorkers() Gets the set of active Working handlers defined.
String	getDescription() Gets the description of this DispatchingHandlerSpecification.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find DispatchingHandlerSpecification instances by name.
int	getMaxWorkerCount() Gets the maximum number of working handlers that can be active.
AttributeValue	getSetting(String key) Gets the setting on this object for the specified key.
SimpleProperty[]	getSettings() Gets the settings used to describe the instance.
AuditSpecification[]	getWorkers() Gets the complete set of Working handlers defined.
AuditSpecification	getWorkerTemplate() Returns the AuditSpecification that is used as the template for the working handlers.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isActiveWorkerRebalanceRequested() See if there is a pending request for the dispatching handler associated with this instance to perform a rebalancing operation for its active workers.
boolean	isInactiveWorkerRebalanceRequested() See if there is a pending request for the dispatching handler associated with this instance to perform a rebalancing operation for its inactive workers.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a SystemObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a PublicObject.
void	removeSetting(String key) Removes a setting (SimpleProperty) for this object.
void	setActiveWorkerRebalanceRequested(boolean val) Set or clear a request for the dispatching handler associated with this instance to perform a rebalancing operation for its active workers.
void	setInactiveWorkerRebalanceRequested(boolean val) Set or clear a request for the dispatching handler associated with this instance to perform a rebalancing operation for its inactive workers.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postUpdate, preCreate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the attribute that holds the name of this DispatchingHandlerSpecification. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The name of the attribute that holds a textual description of the DispatchingHandlerSpecification. (String[2000])

See Also:

Constant Field Values

MAXWORKERCOUNT_ATTRIBUTE

public static final String MAXWORKERCOUNT_ATTRIBUTE

The name of the attribute that holds the maximum number of working handlers that can be active. (Integer)

See Also:

Constant Field Values

ACTIVEWORKERCOUNT_ATTRIBUTE

public static final String ACTIVEWORKERCOUNT_ATTRIBUTE

The name of the attribute that holds the number of working handlers that are active. (Integer)

See Also:

Constant Field Values

WORKERTEMPLATE_ATTRIBUTE

public static final String WORKERTEMPLATE_ATTRIBUTE

The name of the attribute that holds the AuditSpecification that is used as the template for the working handlers. (AuditSpecifcation)

See Also:

Constant Field Values

WORKERS_ATTRIBUTE

public static final String WORKERS_ATTRIBUTE

The name of the attribute that holds the complete set of Working handlers defined. (AuditSpecifcation[])

See Also:

Constant Field Values

SETTINGS_ATTRIBUTE

public static final String SETTINGS_ATTRIBUTE

The name of the Attribute representing the settings used to perform dispatching. (SimpleProperty[])

See Also:

Constant Field Values

Constructor Detail

DispatchingHandlerSpecification

protected DispatchingHandlerSpecification(LibrarySession session,
                                          Long id,
                                          Long classId,
                                          S_LibraryObjectData data)
                                   throws IfsException

Constructs a DispatchingHandlerSpecification object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getDescription

public String getDescription()
                      throws IfsException

Gets the description of this DispatchingHandlerSpecification.

Returns:

the object description

Throws:

IfsException - if operation fails

getMaxWorkerCount

public int getMaxWorkerCount()
                      throws IfsException

Gets the maximum number of working handlers that can be active.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getActiveWorkerCount

public int getActiveWorkerCount()
                         throws IfsException

Gets the number of working handlers that are active.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getWorkerTemplate

public AuditSpecification getWorkerTemplate()
                                     throws IfsException

Returns the AuditSpecification that is used as the template for the working handlers.

Returns:

the AuditSpecification

Throws:

IfsException - if the operation fails.

getWorkers

public AuditSpecification[] getWorkers()
                                throws IfsException

Gets the complete set of Working handlers defined.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getActiveWorkers

public AuditSpecification[] getActiveWorkers()
                                      throws IfsException

Gets the set of active Working handlers defined.

Returns:

the set of active Working handlers

Throws:

IfsException - if the operation fails

getSettings

public SimpleProperty[] getSettings()
                             throws IfsException

Gets the settings used to describe the instance.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getSetting

public AttributeValue getSetting(String key)
                          throws IfsException

Gets the setting on this object for the specified key.

Parameters:

key - the key

Returns:

the setting's value

Throws:

IfsException - if the operation fails

addSetting

public void addSetting(String key,
                       AttributeValue value)
                throws IfsException

Adds a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

value - the setting property's value

Throws:

IfsException - if the operation fails

removeSetting

public void removeSetting(String key)
                   throws IfsException

Removes a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

Throws:

IfsException - if the operation fails

isActiveWorkerRebalanceRequested

public boolean isActiveWorkerRebalanceRequested()
                                         throws IfsException

See if there is a pending request for the dispatching handler associated with this instance to perform a rebalancing operation for its active workers.

Returns:

true if a rebalance has been requested

Throws:

IfsException - if the operation fails

setActiveWorkerRebalanceRequested

public void setActiveWorkerRebalanceRequested(boolean val)
                                       throws IfsException

Set or clear a request for the dispatching handler associated with this instance to perform a rebalancing operation for its active workers.

Parameters:

val - true to make the request; false to clear it

Throws:

IfsException - if the operation fails

isInactiveWorkerRebalanceRequested

public boolean isInactiveWorkerRebalanceRequested()
                                           throws IfsException

See if there is a pending request for the dispatching handler associated with this instance to perform a rebalancing operation for its inactive workers.

Returns:

true if a rebalance has been requested

Throws:

IfsException - if the operation fails

setInactiveWorkerRebalanceRequested

public void setInactiveWorkerRebalanceRequested(boolean val)
                                         throws IfsException

Set or clear a request for the dispatching handler associated with this instance to perform a rebalancing operation for its inactive workers.

Parameters:

val - true to make the request; false to clear it

Throws:

IfsException - if the operation fails

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find DispatchingHandlerSpecification instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static DispatchingHandlerSpecification[] findAll(LibrarySession session)
                                                 throws IfsException

Returns the set of defined DispatchingHandlerSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of DispatchingHandlerSpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static DispatchingHandlerSpecification findByName(LibrarySession session,
                                                         String name)
                                                  throws IfsException

Returns the a DispatchingHandlerSpecification matching the specified name.

DispatchingHandlerSpecification names are case sensitive, so this operations requires an exact match with respect to case.

Parameters:

session - the session context

name - the DispatchingHandlerSpecification name

Returns:

the DispatchingHandlerSpecification matching the specified name; or null if there exists no matching DispatchingHandlerSpecification

Throws:

IfsException - if the operation fails.

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions after the creation of a SystemObject.

This assumes that a transaction context has already been established.

Overrides:

postCreate in class SystemObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions prior to the update of a PublicObject.

Set an option that indicates that Categories are NOT to be created from within S_SystemObject.

Overrides:

preUpdate in class SystemObject

Parameters:

lodef - definition used to define how the target object will be updated

Throws:

IfsException - if operation fails

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.