oracle.ifs.beans

Class NodeConfiguration

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.ApplicationObject

oracle.ifs.beans.TieApplicationObject

oracle.ifs.beans.NodeConfiguration

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieNodeConfiguration

public class NodeConfiguration
extends TieApplicationObject

A NodeConfiguration is used to manage the configuation of a node in IFS. A Node configuration will hold information about services and servers that are part of the node.

Version:

1.0

Author:

Vijayanth Devadhar

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_ATTRIBUTE The name of the ACTIVE attribute.
static String	CLASS_NAME This class name for this class.
static String	SERVERS_ATTRIBUTE The name of the SERVERS attribute.
static String	SERVICES_ATTRIBUTE The name of the SERVICES attribute.
static String	SUPERNODECONFIGURATION_ATTRIBUTE The name of the SUPERNODECONFIGURATION attribute.
static String	UNIQUENAME_ATTRIBUTE The uniquename of the service that the NodeConfiguration describes.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_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	NodeConfiguration(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a NodeConfiguration.

Method Summary

Modifier and Type	Method and Description
static NodeConfiguration[]	findAll(LibrarySession session) Returns the set of defined NodeConfiguration instances.
static NodeConfiguration	findByName(LibrarySession session, String name) Returns a NodeConfiguration matching the specified name.
String[]	getDisabledInheritedPropertyNames() Gets the array of Property names that should not be inherited from the Super NodeConfiguration.
String[]	getDisabledInheritedServerNames() Gets the array of Server names that should not be inherited from the Super NodeConfiguration.
AttributeValueTable	getEffectivePropertyTable() Gets the effective set of properties, combining this instance's properties with any defined on the super NodeConfiguration.
AttributeValueTable	getEffectiveServersTable() Gets the effective set of servers, combining this instance's servers with any defined on the super NodeConfiguration.
String[]	getEnabledInheritedPropertyNames() Gets the array of Property names that should ONLY be inherited from the Super NodeConfiguration.
String[]	getEnabledInheritedServerNames() Gets the array of Server names that should ONLY be inherited from the Super NodeConfiguration.
PropertyBundle	getServers() Gets the Servers property bundle.
PropertyBundle	getServices() Gets the Services property bundle.
NodeConfiguration	getSuperNodeConfiguration() Gets the "super" NodeConfiguration - the NodeConfiguration that this instance extends.
String	getUniqueName() Gets the unique name for this instance.
boolean	isActive() Returns true if the node is Active.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
void	setActive(boolean status) Sets the value of ACTIVE attribute.
void	setServers(PropertyBundle servers) Sets the Servers Property bundle.
void	setServices(PropertyBundle services) Sets the Services Property bundle.
void	setSuperNodeConfiguration(NodeConfiguration nc) Sets the "super" NodeConfiguration - the NodeConfiguration that this instance extends.

Methods inherited from class oracle.ifs.beans.ApplicationObject

auditPublicObjectLocked, auditPublicObjectUnlocked, auditUpdated, constructApplicationObject, constructApplicationObjectVector, isValidEventType, postCreate, reportApplicationObjectCreated, reportApplicationObjectFreed

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryFolderPathIds, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, 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, 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, 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

This class name for this class.

See Also:

Constant Field Values

(Published)

UNIQUENAME_ATTRIBUTE

public static final String UNIQUENAME_ATTRIBUTE

The uniquename of the service that the NodeConfiguration describes.

See Also:

Constant Field Values

(Published)

ACTIVE_ATTRIBUTE

public static final String ACTIVE_ATTRIBUTE

The name of the ACTIVE attribute.

See Also:

Constant Field Values

(Published)

SERVICES_ATTRIBUTE

public static final String SERVICES_ATTRIBUTE

The name of the SERVICES attribute.

See Also:

Constant Field Values

(Published)

SERVERS_ATTRIBUTE

public static final String SERVERS_ATTRIBUTE

The name of the SERVERS attribute.

See Also:

Constant Field Values

(Published)

SUPERNODECONFIGURATION_ATTRIBUTE

public static final String SUPERNODECONFIGURATION_ATTRIBUTE

The name of the SUPERNODECONFIGURATION attribute.

See Also:

Constant Field Values

(Published)

Constructor Detail

NodeConfiguration

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

Constructs a NodeConfiguration.

Parameters:

session - the session

id - the id

classId - the class id

data - the NodeConfiguration data

Throws:

IfsException - if an error occurs

(Unpublished)

Method Detail

getUniqueName

public String getUniqueName()
                     throws IfsException

Gets the unique name for this instance.

Returns:

the unique name

Throws:

IfsException - if operation fails

isActive

public boolean isActive()
                 throws IfsException

Returns true if the node is Active. Otherwise, returns false. An active node gets started by Domain Controller when it is started.

Returns:

true if node is active; false otherwise.

Throws:

IfsException - if the operation fails

(Published)

getServices

public PropertyBundle getServices()
                           throws IfsException

Gets the Services property bundle.

Returns:

PropertyBundle that holds the list of services in this node.

Throws:

IfsException - if the operation fails

(Published)

getServers

public PropertyBundle getServers()
                          throws IfsException

Gets the Servers property bundle.

Returns:

PropertyBundle that holds the list of servers in this node.

Throws:

IfsException - if the operation fails

(Published)

getSuperNodeConfiguration

public NodeConfiguration getSuperNodeConfiguration()
                                            throws IfsException

Gets the "super" NodeConfiguration - the NodeConfiguration that this instance extends.

Returns:

the "super" NodeConfiguration

Throws:

IfsException - if the operation fails

(Published)

getDisabledInheritedPropertyNames

public String[] getDisabledInheritedPropertyNames()
                                           throws IfsException

Gets the array of Property names that should not be inherited from the Super NodeConfiguration.

Returns:

array of Property names that should not be inherited

Throws:

IfsException - if the operation fails

(Published)

getEnabledInheritedPropertyNames

public String[] getEnabledInheritedPropertyNames()
                                          throws IfsException

Gets the array of Property names that should ONLY be inherited from the Super NodeConfiguration.

Returns:

array of Property names that should only be inherited

Throws:

IfsException - if the operation fails

(Published)

getDisabledInheritedServerNames

public String[] getDisabledInheritedServerNames()
                                         throws IfsException

Gets the array of Server names that should not be inherited from the Super NodeConfiguration.

Returns:

array of Server names that should not be inherited

Throws:

IfsException - if the operation fails

(Published)

getEnabledInheritedServerNames

public String[] getEnabledInheritedServerNames()
                                        throws IfsException

Gets the array of Server names that should ONLY be inherited from the Super NodeConfiguration.

Returns:

array of Server names that should only be inherited

Throws:

IfsException - if the operation fails

(Published)

getEffectivePropertyTable

public AttributeValueTable getEffectivePropertyTable()
                                              throws IfsException

Gets the effective set of properties, combining this instance's properties with any defined on the super NodeConfiguration.

The target object's properties take precedence over the properties defined in the super NodeConfiguration.

Returns:

the table of effective properties

Throws:

IfsException - if the operation fails

(Published)

getEffectiveServersTable

public AttributeValueTable getEffectiveServersTable()
                                             throws IfsException

Gets the effective set of servers, combining this instance's servers with any defined on the super NodeConfiguration.

The target object's servers take precedence over the servers defined in the super NodeConfiguration.

Returns:

the table of effective servers

Throws:

IfsException - if the operation fails

(Published)

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: PublicObject

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

Override to free all existing categories, in such a way that the PO doesn't get updated for each category free.

Overrides:

preFree in class ApplicationObject

Parameters:

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

Throws:

IfsException - if operation fails.

setActive

public void setActive(boolean status)
               throws IfsException

Sets the value of ACTIVE attribute.

Parameters:

status - true to make active; false otherwise

Throws:

IfsException - if the operation fails

(Published)

setServices

public void setServices(PropertyBundle services)
                 throws IfsException

Sets the Services Property bundle.

Parameters:

services - property bundle that holds the services in the node

Throws:

IfsException - if the operation fails

(Published)

setServers

public void setServers(PropertyBundle servers)
                throws IfsException

Sets the Servers Property bundle.

Parameters:

servers - property bundle that holds the servers in the node

Throws:

IfsException - if the operation fails

(Published)

setSuperNodeConfiguration

public void setSuperNodeConfiguration(NodeConfiguration nc)
                               throws IfsException

Sets the "super" NodeConfiguration - the NodeConfiguration that this instance extends.

Parameters:

nc - the "super" NodeConfiguration

Throws:

IfsException - if the operation fails

(Published)

findAll

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

Returns the set of defined NodeConfiguration instances.

The instances will be sorted by unique name.

Parameters:

session - the session context

Returns:

the set of NodeConfiguration instances; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns a NodeConfiguration matching the specified name.

Use UNIQUENAME, which is a forced-upper variant of the name.

Parameters:

session - the session context

name - the NodeConfiguration name

Returns:

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

Throws:

IfsException - if the operation fails.