oracle.ifs.core.beans

Class ControllerLoadRatio

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.ControllerLoadRatio

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieControllerLoadRatio

public class ControllerLoadRatio
extends TieSimpleObject

A ControllerLoadRatio represents a load balancing ratio the Controller uses to assign Nodes when there are multiple options.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	NAME_ATTRIBUTE The name of the Attribute representing The name of the ControllerLoadRatio.
static String	NODECOUNT_ATTRIBUTE The name of the Attribute representing The number of Nodes being load balanced.
static String	RATIOS_ATTRIBUTE The array of relative ratios to use when assigning Nodes to Servers or Handlers.
static String	UUID_ATTRIBUTE The name of the Attribute representing the UUID.

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ControllerLoadRatio[]	findAll(LibrarySession session) Returns the set of defined ControllerLoadRatios.
static ControllerLoadRatio	findByName(LibrarySession session, String name) Returns the a ControllerLoadRatio matching the specified name.
static ControllerLoadRatio	findOrCreate(LibrarySession sess, String name) Find or create a ControllerLoadRatio from its name.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find ControllerLoadRatio instances by name.
int	getNodeCount() Gets The number of Nodes being load balanced.
int[]	getRatios() Gets the array of relative ratios to use when assigning Nodes to Servers or Handlers.
String	getUuid() Gets the value of the UUID attribute.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Methods inherited from class oracle.ifs.beans.SimpleObject

free, handleCreate, isValidEventType

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, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postCreate, postEvent, postEvent, postFree, postUpdate, preCreate, preFree, prePostAuditEvent, preUpdate, 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

UUID_ATTRIBUTE

public static final String UUID_ATTRIBUTE

The name of the Attribute representing the UUID.

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the Attribute representing The name of the ControllerLoadRatio.

See Also:

Constant Field Values

NODECOUNT_ATTRIBUTE

public static final String NODECOUNT_ATTRIBUTE

The name of the Attribute representing The number of Nodes being load balanced.

See Also:

Constant Field Values

RATIOS_ATTRIBUTE

public static final String RATIOS_ATTRIBUTE

The array of relative ratios to use when assigning Nodes to Servers or Handlers.

See Also:

Constant Field Values

Constructor Detail

ControllerLoadRatio

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

Construct a ControllerLoadRatio object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

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.

getUuid

public String getUuid()
               throws IfsException

Gets the value of the UUID attribute.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getNodeCount

public int getNodeCount()
                 throws IfsException

Gets The number of Nodes being load balanced.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getRatios

public int[] getRatios()
                throws IfsException

Gets the array of relative ratios to use when assigning Nodes to Servers or Handlers.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

findOrCreate

public static ControllerLoadRatio findOrCreate(LibrarySession sess,
                                               String name)
                                        throws IfsException

Find or create a ControllerLoadRatio from its name.

Parameters:

sess - the session context

name - the ControllerLoadRatio name, reflecting node count and ratios

Returns:

the ControllerLoadRatio

Throws:

IfsException - if the operation fails

(Published)

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find ControllerLoadRatio instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

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

Returns the set of defined ControllerLoadRatios.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of ControllerLoadRatios; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns the a ControllerLoadRatio matching the specified name.

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

Parameters:

session - the session context

name - the ControllerLoadRatio name

Returns:

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

Throws:

IfsException - if the operation fails.