oracle.ifs.core.beans

Class ControllerJob

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.core.beans.ControllerJob

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieControllerJob

public class ControllerJob
extends TieSimpleObject

A ControllerJob holds the details of a job the Controller has been asked to do.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVE_ATTRIBUTE The name of the Attribute reflecting the active status of the object.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	COMPLETIONDESCRIPTION_ATTRIBUTE The description of how the ControllerJob completed.
static String	COMPLETIONDESCRIPTION_CANCELLED_NEW_CONTROLLER Completion description indicating being cancelled by a new Controller that took over after the Job was created.
static String	COMPLETIONDESCRIPTION_FAILURE_UNKNOWN Completion description indicating an unknown failure.
static String	COMPLETIONDESCRIPTION_INVALID_DISPOSED_OBJECT Completion description indicating a disposed object was specified.
static String	COMPLETIONDESCRIPTION_INVALID_HANDLER Completion description indicating an invalid Handler specified.
static String	COMPLETIONDESCRIPTION_INVALID_REPLYCODE Completion description indicating an invalid ControllerReply code was received.
static String	COMPLETIONDESCRIPTION_INVALID_REQUEST_ALREADY_ACTIVE Completion description indicating a ControllerRequest was already in progress for the specified object.
static String	COMPLETIONDESCRIPTION_INVALID_SERVER Completion description indicating an invalid Server specified.
static String	COMPLETIONDESCRIPTION_INVALID_SETTINGS Completion description indicating an invalid job settings.
static String	COMPLETIONDESCRIPTION_SETTINGS_NOACTION Completion description indicating that the job settings resulted in no action taken.
static String	COMPLETIONDESCRIPTION_SUCCESS Completion description indicating normal success.
static String	COMPLEXJOBCLASSPATH_ATTRIBUTE The name of the Attribute representing the fully-qualified class name of the Java class which implements the ControllerJobInterface.
static String	DESCRIPTION_ATTRIBUTE The description of this ControllerJob.
static String	JOBDATE_ATTRIBUTE The name of the Attribute representing The date this ControllerJob was placed.
static String	JOBSETTING_KEY_NODEASSIGNABLE The JobSetting key that holds the target object (once the job is started).
static String	JOBSETTING_KEY_TARGETOBJECT The JobSetting key that holds the target object (once the job is started).
static String	JOBSETTINGS_ATTRIBUTE The name of the Attribute representing the settings used to describe the job.
static String	JOBTYPE_ATTRIBUTE The name of the Attribute representing the type of job, for example RESTART or SHUTDOWN.
static String	NAME_ATTRIBUTE The name of this ControllerJob.
static String	RUNTIMESTATETARGET_ATTRIBUTE Name of the RUNTIMESTATETARGET Attribute
static String	SIMPLEJOBCODE_ATTRIBUTE The name of the Attribute representing the code that identifies the type for simple ControllerJobs.
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	ControllerJob(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ControllerJob object.

Method Summary

Modifier and Type	Method and Description
void	addSetting(String key, AttributeValue value) Adds a setting (SimpleProperty) for this object.
void	complete() Mark the job as completed, by setting ACTIVE to false.
void	complete(String compDesc) Mark the job as completed, by setting ACTIVE to false and adding the specified completion description.
static ComplexControllerJob	constructComplexControllerJob(LibrarySession session, String classPath) Constucts the ComplexControllerJob instance implementation corresponding to the specified class path.
static ControllerJob	create(int code, RuntimeState rs) Create a simple ControllerJob.
static ControllerJob	createReconfigure(RuntimeState rs, AttributeValueTable settingsTable) Create a job to Reconfigure a RuntimeState object.
String	getCompletionDescription() Returns the description of how the ControllerJob completed.
ComplexControllerJob	getComplexControllerJob() Gets the ComplexControllerJob instance implementation corresponding to the ComplexJobClassPath.
String	getComplexJobClassPath() Returns the fully-qualified class name of the Java class which implements the ControllerJobInterface.
String	getDescription() Returns the description of this ControllerJob.
Date	getJobDate() Gets The date this ControllerJob was placed.
SimpleProperty[]	getJobSettings() Gets the settings used to describe the job.
AttributeValue	getJobSettingValue(String settingName) Gets a settings used to describe the job for the specified setting name.
String	getJobType() Returns the job type for this ControllerJob.
RuntimeState	getRuntimeStateTarget() Gets the RuntimeState that is the target (or subject) of this Job.
Integer	getSimpleJobCode() Gets the simple Job code number for simple ControllerJobs, using the same code numbers as for ControllerRequests.
String	getSimpleJobCodeName() Gets the simple Job code name for simple ControllerJobs.
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.
boolean	isActive() Gets the Active status.
boolean	isSimpleJob() Returns true if this is a simple Job.
void	performAsController() Perform the Job.
void	performComplexJob() Perform a complex Job.
void	performSimpleJob() Perform a simple Job.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a object.
protected void	preCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the creation of a object.
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 object.
void	setActive(boolean active) Sets the ACTIVE attribute for this object.

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, postEvent, postEvent, postFree, postUpdate, 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

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 this ControllerJob. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

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

See Also:

Constant Field Values

COMPLETIONDESCRIPTION_ATTRIBUTE

public static final String COMPLETIONDESCRIPTION_ATTRIBUTE

The description of how the ControllerJob completed. (String[2000])

See Also:

Constant Field Values

ACTIVE_ATTRIBUTE

public static final String ACTIVE_ATTRIBUTE

The name of the Attribute reflecting the active status of the object.

See Also:

Constant Field Values

(Published)

JOBTYPE_ATTRIBUTE

public static final String JOBTYPE_ATTRIBUTE

The name of the Attribute representing the type of job, for example RESTART or SHUTDOWN.

See Also:

Constant Field Values

SIMPLEJOBCODE_ATTRIBUTE

public static final String SIMPLEJOBCODE_ATTRIBUTE

The name of the Attribute representing the code that identifies the type for simple ControllerJobs.

See Also:

Constant Field Values

COMPLEXJOBCLASSPATH_ATTRIBUTE

public static final String COMPLEXJOBCLASSPATH_ATTRIBUTE

The name of the Attribute representing the fully-qualified class name of the Java class which implements the ControllerJobInterface.

See Also:

Constant Field Values

JOBDATE_ATTRIBUTE

public static final String JOBDATE_ATTRIBUTE

The name of the Attribute representing The date this ControllerJob was placed.

See Also:

Constant Field Values

RUNTIMESTATETARGET_ATTRIBUTE

public static final String RUNTIMESTATETARGET_ATTRIBUTE

Name of the RUNTIMESTATETARGET Attribute

See Also:

Constant Field Values

(Published)

JOBSETTINGS_ATTRIBUTE

public static final String JOBSETTINGS_ATTRIBUTE

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

See Also:

Constant Field Values

JOBSETTING_KEY_TARGETOBJECT

public static final String JOBSETTING_KEY_TARGETOBJECT

The JobSetting key that holds the target object (once the job is started).

See Also:

Constant Field Values

(Published)

JOBSETTING_KEY_NODEASSIGNABLE

public static final String JOBSETTING_KEY_NODEASSIGNABLE

The JobSetting key that holds the target object (once the job is started).

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_SUCCESS

public static final String COMPLETIONDESCRIPTION_SUCCESS

Completion description indicating normal success.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_FAILURE_UNKNOWN

public static final String COMPLETIONDESCRIPTION_FAILURE_UNKNOWN

Completion description indicating an unknown failure.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_INVALID_SETTINGS

public static final String COMPLETIONDESCRIPTION_INVALID_SETTINGS

Completion description indicating an invalid job settings.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_SETTINGS_NOACTION

public static final String COMPLETIONDESCRIPTION_SETTINGS_NOACTION

Completion description indicating that the job settings resulted in no action taken.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_INVALID_REPLYCODE

public static final String COMPLETIONDESCRIPTION_INVALID_REPLYCODE

Completion description indicating an invalid ControllerReply code was received.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_INVALID_SERVER

public static final String COMPLETIONDESCRIPTION_INVALID_SERVER

Completion description indicating an invalid Server specified.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_INVALID_HANDLER

public static final String COMPLETIONDESCRIPTION_INVALID_HANDLER

Completion description indicating an invalid Handler specified.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_INVALID_DISPOSED_OBJECT

public static final String COMPLETIONDESCRIPTION_INVALID_DISPOSED_OBJECT

Completion description indicating a disposed object was specified.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_INVALID_REQUEST_ALREADY_ACTIVE

public static final String COMPLETIONDESCRIPTION_INVALID_REQUEST_ALREADY_ACTIVE

Completion description indicating a ControllerRequest was already in progress for the specified object.

See Also:

Constant Field Values

(Published)

COMPLETIONDESCRIPTION_CANCELLED_NEW_CONTROLLER

public static final String COMPLETIONDESCRIPTION_CANCELLED_NEW_CONTROLLER

Completion description indicating being cancelled by a new Controller that took over after the Job was created.

See Also:

Constant Field Values

(Published)

Constructor Detail

ControllerJob

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

Construct a ControllerJob object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

create

public static ControllerJob create(int code,
                                   RuntimeState rs)
                            throws IfsException

Create a simple ControllerJob.

Parameters:

code - the ControllerRequest code

rs - the RuntimeState target

Returns:

the newly created ControllerJob

Throws:

IfsException - if the operation fails

(Published)

createReconfigure

public static ControllerJob createReconfigure(RuntimeState rs,
                                              AttributeValueTable settingsTable)
                                       throws IfsException

Create a job to Reconfigure a RuntimeState object.

Parameters:

rs - the RuntimeState target

settingsTable - the Property settings

Returns:

the newly created ControllerJob

Throws:

IfsException - if the operation fails

(Published)

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

getDescription

public String getDescription()
                      throws IfsException

Returns the description of this ControllerJob.

Returns:

the description of this ControllerJob, or null.

Throws:

IfsException - if the operation fails.

getCompletionDescription

public String getCompletionDescription()
                                throws IfsException

Returns the description of how the ControllerJob completed.

This is typically null when the job is completed successfully.

Returns:

the description of how the ControllerJob completed

Throws:

IfsException - if the operation fails.

isActive

public boolean isActive()
                 throws IfsException

Gets the Active status.

Returns:

the status for this object

Throws:

IfsException - if operation fails

(Published)

getJobType

public String getJobType()
                  throws IfsException

Returns the job type for this ControllerJob.

For example, this will return "RESTART" for the Simple ControllerJob with SimpleJobCode of ConrtollerRequest.CODE_RESTART. For complex ControllerJobs, it will return the name that was assigned when the job was created.

Returns:

the Job type

Throws:

IfsException - if the operation fails.

getSimpleJobCode

public Integer getSimpleJobCode()
                         throws IfsException

Gets the simple Job code number for simple ControllerJobs, using the same code numbers as for ControllerRequests.

Returns:

the simple Job code number, or null if this is not a simple ControllerJob

Throws:

IfsException - if the operation fails

getSimpleJobCodeName

public String getSimpleJobCodeName()
                            throws IfsException

Gets the simple Job code name for simple ControllerJobs.

Returns:

the simple Job code number, or null if this is not a simple ControllerJob

Throws:

IfsException - if the operation fails

getComplexJobClassPath

public String getComplexJobClassPath()
                              throws IfsException

Returns the fully-qualified class name of the Java class which implements the ControllerJobInterface.

Returns:

the fully-qualified class name

Throws:

IfsException - if the operation fails.

isSimpleJob

public boolean isSimpleJob()
                    throws IfsException

Returns true if this is a simple Job.

A simple job is one whose Job code matches a ControllerRequest code.

Returns:

true if this is a simple Job.

Throws:

IfsException - if the operation fails

getJobDate

public Date getJobDate()
                throws IfsException

Gets The date this ControllerJob was placed.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getJobSettings

public SimpleProperty[] getJobSettings()
                                throws IfsException

Gets the settings used to describe the job.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getJobSettingValue

public AttributeValue getJobSettingValue(String settingName)
                                  throws IfsException

Gets a settings used to describe the job for the specified setting name.

Parameters:

settingName - the setting name

Returns:

the settting value, or null if not defined

Throws:

IfsException - if the operation fails

getRuntimeStateTarget

public RuntimeState getRuntimeStateTarget()
                                   throws IfsException

Gets the RuntimeState that is the target (or subject) of this Job.

Returns:

the RuntimeState target

Throws:

IfsException - if operation fails

(Published)

getComplexControllerJob

public final ComplexControllerJob getComplexControllerJob()
                                                   throws IfsException

Gets the ComplexControllerJob instance implementation corresponding to the ComplexJobClassPath.

This implementation is cached for use by the session associated with this instance.

Returns:

the ComplexControllerJob implementation

Throws:

IfsException - if the operation fails

(Unpublished)

constructComplexControllerJob

public static ComplexControllerJob constructComplexControllerJob(LibrarySession session,
                                                                 String classPath)
                                                          throws IfsException

Constucts the ComplexControllerJob instance implementation corresponding to the specified class path.

Parameters:

session - the session context

classPath - the fully qualified class path

Returns:

the ComplexControllerJob implementation

Throws:

IfsException - if the operation fails

(Unpublished)

setActive

public void setActive(boolean active)
               throws IfsException

Sets the ACTIVE attribute for this object. This toggles between an active and inactive status for the object.

Parameters:

active - the new Active status value

Throws:

IfsException - if operation fails

(Published)

complete

public void complete()
              throws IfsException

Mark the job as completed, by setting ACTIVE to false.

This variant does not set a Completion description.

Throws:

IfsException - if operation fails

(Published)

complete

public void complete(String compDesc)
              throws IfsException

Mark the job as completed, by setting ACTIVE to false and adding the specified completion description.

Parameters:

compDesc - the completion description

Throws:

IfsException - if 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

preCreate

protected void preCreate(LibraryObjectDefinition lodef)
                  throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the creation of a object.

This method is typically overridden by subclasses that add attribute settings to the definition prior to the object being created, and/or create other objects that the target object depends on. At this point, the target object does not exist in the database, and therefore certain operations performed on the target will fail (such as getAttribute). Subclasses are expected to invoke super.preCreate.

Overrides:

preCreate in class LibraryObject

Parameters:

lodef - object definition that will be used to create the object

Throws:

IfsException - if operation fails.

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: LibraryObject

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

This method is typically overridden by subclasses that perform operations after an object is created. Subclasses are expected to invoke super.postCreate.

Overrides:

postCreate in class LibraryObject

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: LibraryObject

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

This method is typically overridden by subclasses that perform other operations prior to the target object being updated, in order to modify objects related to the target object. Subclasses are expected to invoke super.preUpdate.

Overrides:

preUpdate in class LibraryObject

Parameters:

lodef - object 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.

performAsController

public void performAsController()
                         throws IfsException

Perform the Job.

Throws:

IfsException - if operation fails

(Published)

performSimpleJob

public void performSimpleJob()
                      throws IfsException

Perform a simple Job.

Throws:

IfsException - if operation fails

(Published)

performComplexJob

public void performComplexJob()
                       throws IfsException

Perform a complex Job.

Throws:

IfsException - if operation fails

(Published)