oracle.ifs.core.beans

Class ServerSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.ServerSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieServerSpecification

public class ServerSpecification
extends TieSystemObject

Specifies a Server that shall be managed by the system.

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DESCRIPTION_ATTRIBUTE The description of this ServerSpecification.
static String	NAME_ATTRIBUTE The name of this ServerSpecification.
static String	RUNTIMECLASSIFICATION_ATTRIBUTE The hierarchical identifier describing the type of this server for runtime management purposes.
static String	SERVERCONFIGURATION_ATTRIBUTE The ServerConfiguration that defines the configuration for this server.
static String	SERVERSTATE_ATTRIBUTE The current ServerState reflecting the runtime state for the server.
static String	SETTINGS_ATTRIBUTE The name of the Attribute representing the settings used to describe the ServerSpecification.

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	ServerSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs an ServerSpecification object.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates this instance.
void	addSetting(String key, AttributeValue value) Adds a setting (SimpleProperty) for this object.
void	deactivate() Deactivates this instance.
static ServerSpecification[]	findAll(LibrarySession session) Returns the set of defined ServerSpecifications.
static ServerSpecification	findByName(LibrarySession session, String name) Returns the a ServerSpecification matching the specified name.
String	getDescription() Returns the description of this ServerSpecification.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find ServerSpecification instances by name.
String	getRuntimeClassification() Returns the hierarchical identifier describing the type of this server for runtime management purposes.
ServerConfiguration	getServerConfiguration() Returns the ServerConfiguration that defines the configuration for this server.
ServerState	getServerState() Returns the ServerState for this ServerSpecification.
SimpleProperty[]	getSettings() Gets the settings used to describe the instance.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
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	setServerState(ServerState ss) Sets the ServerState

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

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of this ServerSpecification. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The description of this ServerSpecification. (String[2000])

See Also:

Constant Field Values

RUNTIMECLASSIFICATION_ATTRIBUTE

public static final String RUNTIMECLASSIFICATION_ATTRIBUTE

The hierarchical identifier describing the type of this server for runtime management purposes. (String[700])

See Also:

Constant Field Values

SERVERCONFIGURATION_ATTRIBUTE

public static final String SERVERCONFIGURATION_ATTRIBUTE

The ServerConfiguration that defines the configuration for this server.

See Also:

Constant Field Values

SERVERSTATE_ATTRIBUTE

public static final String SERVERSTATE_ATTRIBUTE

The current ServerState reflecting the runtime state for the server.

See Also:

Constant Field Values

SETTINGS_ATTRIBUTE

public static final String SETTINGS_ATTRIBUTE

The name of the Attribute representing the settings used to describe the ServerSpecification.

See Also:

Constant Field Values

Constructor Detail

ServerSpecification

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

Constructs an ServerSpecification 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.

getDescription

public String getDescription()
                      throws IfsException

Returns the description of this ServerSpecification.

Returns:

the description of this ServerSpecification, or null.

Throws:

IfsException - if the operation fails.

getRuntimeClassification

public String getRuntimeClassification()
                                throws IfsException

Returns the hierarchical identifier describing the type of this server for runtime management purposes.

Returns:

the classification which describes the type of server

Throws:

IfsException - if the operation fails

getServerState

public ServerState getServerState()
                           throws IfsException

Returns the ServerState for this ServerSpecification.

Can be null if the Server is not currently running.

Returns:

the ServerState

Throws:

IfsException - if the operation fails.

getServerConfiguration

public ServerConfiguration getServerConfiguration()
                                           throws IfsException

Returns the ServerConfiguration that defines the configuration for this server.

Returns:

the ServerConfiguration

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

setServerState

public void setServerState(ServerState ss)
                    throws IfsException

Sets the ServerState

Parameters:

ss - the ServerState

Throws:

IfsException - if the operation fails

(Published)

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

activate

public void activate()
              throws IfsException

Activates this instance.

Throws:

IfsException - if the operation fails.

deactivate

public void deactivate()
                throws IfsException

Deactivates this instance.

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.

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find ServerSpecification instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

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

Returns the set of defined ServerSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of ServerSpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns the a ServerSpecification matching the specified name.

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

Parameters:

session - the session context

name - the ServerSpecification name

Returns:

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

Throws:

IfsException - if the operation fails.