class CIM_J2eeManagedObject : CIM_EnabledLogicalElement

Description:

CIM_J2eeManagedObject is a class for defining operations that may supported by all J2EE managed objects. It contains the attributes and methods that are common to all J2EE managed objects. The J2EE Managed objects - for eg. J2eeServer should participate in instances of the CIM_LogicalIdentity association with the corresponding instance of the J2eeManagedObject class. The start and stop methods of JSR77's J2eeManagedObject find an equivalent in the RequestStateChange method inherited from EnabledLogicalElement. Using Enabled/Disabled as inputs to RequestStateChange, one can effect start and stop.

Definition:

Feature Type Class Origin Qualifiers
InstanceID string CIM_ManagedElement
Key TRUE
Override InstanceID
Description InstanceID identifies a unique instance of a J2EE ManagedObject's Capabilities in a given namespace. In order to ensure uniqueness, the value of InstanceID MUST be constructed using the form specified in JSR77.3.1.1.1 in order to avoid the need for manual key propagation.
MappingStrings JSR77.JCP|JSR77.3.1.1.1 objectName|V1.0
ModelCorrespondence CIM_J2eeManagedObject.ElementName
Caption string CIM_ManagedElement
Description The Caption property is a short textual description (one- line string) of the object.
MaxLen 64
Description string CIM_ManagedElement
Description The Description property provides a textual description of the object.
ElementName string CIM_ManagedElement
Override ElementName
Description The name of a J2EE managed object. The name MUST be constructed using the form specified in JSR77.3.1.1.1 in order to avoid the need for manual key propagation.
MaxLen 256
MappingStrings JSR77.JCP|JSR77.3.1.1.1 objectName|V1.0
ModelCorrespondence CIM_J2eeManagedObject.InstanceID
InstallDate datetime CIM_ManagedSystemElement
Description A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
MappingStrings MIF.DMTF|ComponentID|001.5
Name string CIM_ManagedSystemElement
Description The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.
MaxLen 1024
OperationalStatus uint16[] CIM_ManagedSystemElement
Override OperationalStatus
Description The current state of the entity for J2ee managed objects that support state management. If the StateManageable property is FALSE, the value of this property MUST be set to 0 - Unknown. The mapping from the J2ee management states to OperationalStatus is as follows - j2ee.state.starting - Starting, j2ee.state.running - OK, j2ee.state.stopping - Stopping, j2ee.state.stopped - Stopped, and j2ee.state.failed - Error.
ValueMap 0, 2, 6, 8, 9, 10
Values "Unknown" [0]
"OK" [2]
"Error" [6]
"Starting" [8]
"Stopping" [9]
"Stopped" [10]
MappingStrings JSR77.JCP|JSR77.5.1.1.1 state|V1.0
ModelCorrespondence CIM_J2eeManagedObjectCapabilities.StateManageable
ArrayType Indexed
StatusDescriptions string[] CIM_ManagedSystemElement
Description Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.
ArrayType Indexed
ModelCorrespondence CIM_ManagedSystemElement.OperationalStatus
Status string CIM_ManagedSystemElement
Deprecated CIM_ManagedSystemElement.OperationalStatus
Description A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.
ValueMap OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped
MaxLen 10
HealthState uint16 CIM_ManagedSystemElement
Description Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: "Non-recoverable Error" (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. "Critical Failure" (25) - The element is non-functional and recovery might not be possible. "Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. "Minor Failure" (15) - All functionality is available but some might be degraded. "Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. "OK" (5) - The element is fully functional and is operating within normal operational parameters and without error. "Unknown" (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
ValueMap 0, 5, 10, 15, 20, 25, 30, ..
Values "Unknown" [0]
"OK" [5]
"Degraded/Warning" [10]
"Minor failure" [15]
"Major failure" [20]
"Critical failure" [25]
"Non-recoverable error" [30]
"DMTF Reserved" [..]
EnabledState uint16 CIM_EnabledLogicalElement
Description EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
ValueMap 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535
Values "Unknown" [0]
"Other" [1]
"Enabled" [2]
"Disabled" [3]
"Shutting Down" [4]
"Not Applicable" [5]
"Enabled but Offline" [6]
"In Test" [7]
"Deferred" [8]
"Quiesce" [9]
"Starting" [10]
"DMTF Reserved" [11..32767]
"Vendor Reserved" [32768..65535]
ModelCorrespondence CIM_EnabledLogicalElement.OtherEnabledState
OtherEnabledState string CIM_EnabledLogicalElement
Description A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
ModelCorrespondence CIM_EnabledLogicalElement.EnabledState
RequestedState uint16 CIM_EnabledLogicalElement
Description RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. "Unknown" (0) indicates the last requested state for the element is unknown. Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".
ValueMap 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535
Values "Unknown" [0]
"Enabled" [2]
"Disabled" [3]
"Shut Down" [4]
"No Change" [5]
"Offline" [6]
"Test" [7]
"Deferred" [8]
"Quiesce" [9]
"Reboot" [10]
"Reset" [11]
"Not Applicable" [12]
"DMTF Reserved" [..]
"Vendor Reserved" [32768..65535]
ModelCorrespondence CIM_EnabledLogicalElement.EnabledState
EnabledDefault uint16 CIM_EnabledLogicalElement
Write TRUE
Description An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).
ValueMap 2, 3, 5, 6, 7, 9, .., 32768..65535
Values "Enabled" [2]
"Disabled" [3]
"Not Applicable" [5]
"Enabled but Offline" [6]
"No Default" [7]
"Quiesce" [9]
"DMTF Reserved" [..]
"Vendor Reserved" [32768..65535]
TimeOfLastStateChange datetime CIM_EnabledLogicalElement
Description The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.
RequestStateChange method CIM_EnabledLogicalElement
Description Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. A return code of 0 shall indicate the state change was successfully initiated. A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter. A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
ValueMap 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
Values "Completed with No Error" [0]
"Not Supported" [1]
"Unknown or Unspecified Error" [2]
"Cannot complete within Timeout Period" [3]
"Failed" [4]
"Invalid Parameter" [5]
"In Use" [6]
"DMTF Reserved" [..]
"Method Parameters Checked - Job Started" [4096]
"Invalid State Transition" [4097]
"Use of Timeout Parameter Not Supported" [4098]
"Busy" [4099]
"Method Reserved" [4100..32767]
"Vendor Specific" [32768..65535]
ModelCorrespondence CIM_EnabledLogicalElement.RequestedState
StartTime datetime CIM_J2eeManagedObject
Description The time that the J2EE managed object was started, represented as a datetime interval measured as the time interval since January 1, 1970, 00:00:00. If the StateManageable property of the CIM_J2eeManagedObjectCapabilities class is false, this value MUST be set to a zero time interval.
MappingStrings JSR77.JCP|JSR77.5.1.1.2 startTime|V1.0
ModelCorrespondence CIM_J2eeManagedObjectCapabilities.StateManageable
StartRecursive method CIM_J2eeManagedObject
Description Starts the J2EE managed object. This operation can only be invoked in when State is Stopped. This method, causes State to become Starting initially, and eventually becomes the RUNNING state. Additionally, StartRecursive() is called on all the child StateManageable instances that are registered with this entity and are in the Stopped state. The method returns 0 on success and non-zero for failure.
MappingStrings JSR77.JCP|JSR77.5.1.2.2 startRecursive|V1.0
Start method CIM_J2eeManagedObject
Description This method starts the J2EE managed object. This operation can only be invoked when the OperationalStatus is Stopped. Note that StartService() will not be called on any of the child StateManageable instances that are registered with this instance. It is the responsibility of the calling application to start the child if required. The method returns 0 on success and non-zero for failure.
MappingStrings JSR77.JCP|JSR77.5.1.2.1 start|V1.0
Stop method CIM_J2eeManagedObject
Description This method stops the J2EE managed object and all dependent objects that can be identified by following the Dependency/Component associations this object's identity participates in.
MappingStrings JSR77.JCP|JSR77.5.1.2.3 stop|V1.0

Typographical Conventions:

  1. Inherited properties are italicized.
  2. Local properties are bolded.
  3. Key properties are highlighted in gold

Generated by mof2html v.2.1.0(002). simplewbem.org Mon Nov 2 09:43:14 2009