HealthState (Java API Reference for Oracle WebLogic Server)

java.lang.Object
- weblogic.health.HealthState

All Implemented Interfaces:

java.io.Serializable
```
public final class HealthState
extends java.lang.Object
implements java.io.Serializable
```
This class encapsulates the health information returned by a Server Service. Services register with the server self-health monitor service and provide health information through this class.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`HEALTH_CRITICAL` Something must be done now to prevent service failure.
`static int`	`HEALTH_FAILED` Service has failed - must be restarted.
`static int`	`HEALTH_OK` Server Service is healthy.
`static int`	`HEALTH_OVERLOADED` Service is functioning normally but there is too much work in it.
`static int`	`HEALTH_WARN` Service could have problems in the future.
`private boolean`	`isCritical`
`static java.lang.String`	`ITEM_COMPONENT`
`static java.lang.String`	`ITEM_HEALTH_STATE`
`static java.lang.String`	`ITEM_IS_CRITICAL`
`static java.lang.String`	`ITEM_MBEAN`
`static java.lang.String`	`ITEM_PARTITION`
`static java.lang.String`	`ITEM_REASON_CODE`
`static java.lang.String`	`ITEM_SYMPTOMS`
`private static java.lang.String[]`	`itemDescriptions`
`private static java.lang.String[]`	`itemNames`
`private static int[]`	`logicalSeverityOrder`
`static java.lang.String`	`LOW_MEMORY_REASON` Reason code that indicates that the server is low on memory.
`private java.lang.String`	`mbeanName`
`private java.lang.String`	`mbeanType`
`private static java.lang.String[]`	`NULL_REASONS`
`private static Symptom[]`	`NULL_SYMPTOMS`
`static java.lang.String`	`OPEN_DESCRIPTION`
`static java.lang.String`	`OPEN_TYPE_NAME`
`private java.lang.String`	`partitionName`
`private java.lang.String[]`	`reasonCode`
`private static long`	`serialVersionUID`
`private int`	`state`
`private java.lang.String`	`subsystemName`
`private Symptom[]`	`symptoms`

Constructor Summary

Constructors
Constructor and Description
`HealthState(int s)` Construct a HealthState with given state.
`HealthState(int state, Symptom symptom)` Construct a HealthState with given state and a symptom.
`HealthState(int state, Symptom[] symptoms)` Construct a HealthState with given state and an array of symptoms.
`HealthState(int state, Symptom[] symptoms, java.lang.String partitionName)` Construct a HealthState with given state and an array of symptoms.
`HealthState(int state, Symptom symptom, java.lang.String partitionName)` Construct a HealthState with given state and a symptom.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static int`	`compareSeverities(int aState, int baseState)`
`int`	`compareSeverityTo(HealthState other)` Compares the severity of the supplied HealthState to this object's severity.
`int`	`compareSeverityTo(int otherState)`
`protected java.util.Map`	`getCompositeDataMap()` creates a map of attribute values for use in CompositeData construction
`protected javax.management.openmbean.CompositeType`	`getCompositeType()` creates the open data CompositType instance for this object
`java.lang.String`	`getMBeanName()`
`java.lang.String`	`getMBeanType()`
`java.lang.String`	`getPartitionName()` Get partition name for this health state
`java.lang.String[]`	`getReasonCode()` Deprecated.
`java.lang.String`	`getReasonCodeSummary()` Returns the reason codes array values concatenated into a single String, to allow the reason codes to be collected by WLDF Harvester.
`int`	`getState()` Health state returned by this service.
`java.lang.String`	`getSubsystemName()` Name of the service providing health information
`Symptom[]`	`getSymptoms()` Get symptoms for this health state
`boolean`	`isCritical()`
`static java.lang.String`	`mapToString(int intValue)` Provides string representation of health states.
`void`	`setCritical(boolean isCritical)`
`void`	`setMBeanName(java.lang.String name)`
`void`	`setMBeanType(java.lang.String type)`
`void`	`setPartitionName(java.lang.String partitionName)`
`void`	`setSubsystemName(java.lang.String key)`
`private java.lang.String[]`	`symptomsToReasoncode(Symptom[] symptoms)`
`javax.management.openmbean.CompositeData`	`toCompositeData()` Converts a `ConsumerInfo` instance to a CompositeData representation.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - HEALTH_OK
```
public static final int HEALTH_OK
```
    Server Service is healthy.
    
    See Also:
    
    Constant Field Values
  - HEALTH_WARN
```
public static final int HEALTH_WARN
```
    Service could have problems in the future. Check the server logs and the corresponding RuntimeMBean for more details.
    
    See Also:
    
    Constant Field Values
  - HEALTH_CRITICAL
```
public static final int HEALTH_CRITICAL
```
    Something must be done now to prevent service failure. Check the server logs and the corresponding RuntimeMBean for more details.
    
    See Also:
    
    Constant Field Values
  - HEALTH_FAILED
```
public static final int HEALTH_FAILED
```
    Service has failed - must be restarted. Check the server logs and the corresponding RuntimeMBean for more details.
    
    See Also:
    
    Constant Field Values
  - HEALTH_OVERLOADED
```
public static final int HEALTH_OVERLOADED
```
    Service is functioning normally but there is too much work in it. CRITICAL and OVERLOADED are different. A subsystem is in critical state when a part of it is malfunctioning e.g stuck threads. An overloaded state means that there is more work assigned to the Service than the configured threshold. A service might refuse more work in this state.
    
    See Also:
    
    Constant Field Values
  - LOW_MEMORY_REASON
```
public static final java.lang.String LOW_MEMORY_REASON
```
    Reason code that indicates that the server is low on memory. Administrators can configure low and high thresholds for memory usage and the server health changes to OVERLOADED with this reason code if the low threshold is reached.
    
    See Also:
    
    OverloadProtectionMBean, Constant Field Values
  - NULL_REASONS
```
private static final java.lang.String[] NULL_REASONS
```
  - NULL_SYMPTOMS
```
private static final Symptom[] NULL_SYMPTOMS
```
  - state
```
private final int state
```
  - reasonCode
```
private final java.lang.String[] reasonCode
```
  - symptoms
```
private final Symptom[] symptoms
```
  - partitionName
```
private java.lang.String partitionName
```
  - subsystemName
```
private java.lang.String subsystemName
```
  - OPEN_TYPE_NAME
```
public static final java.lang.String OPEN_TYPE_NAME
```
    See Also:
    
    Constant Field Values
  - OPEN_DESCRIPTION
```
public static final java.lang.String OPEN_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - ITEM_COMPONENT
```
public static final java.lang.String ITEM_COMPONENT
```
    See Also:
    
    Constant Field Values
  - ITEM_HEALTH_STATE
```
public static final java.lang.String ITEM_HEALTH_STATE
```
    See Also:
    
    Constant Field Values
  - ITEM_MBEAN
```
public static final java.lang.String ITEM_MBEAN
```
    See Also:
    
    Constant Field Values
  - ITEM_SYMPTOMS
```
public static final java.lang.String ITEM_SYMPTOMS
```
    See Also:
    
    Constant Field Values
  - ITEM_REASON_CODE
```
public static final java.lang.String ITEM_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - ITEM_IS_CRITICAL
```
public static final java.lang.String ITEM_IS_CRITICAL
```
    See Also:
    
    Constant Field Values
  - ITEM_PARTITION
```
public static final java.lang.String ITEM_PARTITION
```
    See Also:
    
    Constant Field Values
  - itemNames
```
private static java.lang.String[] itemNames
```
  - itemDescriptions
```
private static java.lang.String[] itemDescriptions
```
  - logicalSeverityOrder
```
private static final int[] logicalSeverityOrder
```
  - isCritical
```
private boolean isCritical
```
  - mbeanName
```
private java.lang.String mbeanName
```
  - mbeanType
```
private java.lang.String mbeanType
```
- Constructor Detail
  - HealthState
```
public HealthState(int s)
```
    Construct a HealthState with given state.
    
    Parameters:
    
    s - HealthState
    
    Excluded in public API Reference.
  - HealthState
```
public HealthState(int state,
                   Symptom symptom)
```
    Construct a HealthState with given state and a symptom.
    
    Parameters:
    
    state - health state
    
    symptom - Symptom
    
    Excluded in public API Reference.
  - HealthState
```
public HealthState(int state,
                   Symptom symptom,
                   java.lang.String partitionName)
```
    Construct a HealthState with given state and a symptom.
    
    Parameters:
    
    state - health state
    
    symptom - Symptom
    
    partitionName -
    
    Excluded in public API Reference.
  - HealthState
```
public HealthState(int state,
                   Symptom[] symptoms)
```
    Construct a HealthState with given state and an array of symptoms.
    
    Parameters:
    
    state - health state
    
    symptoms - array of Symptom
    
    Excluded in public API Reference.
  - HealthState
```
public HealthState(int state,
                   Symptom[] symptoms,
                   java.lang.String partitionName)
```
    Construct a HealthState with given state and an array of symptoms.
    
    Parameters:
    
    state - health state
    
    symptoms - array of Symptom
    
    partitionName -
    
    Excluded in public API Reference.
- Method Detail
  - symptomsToReasoncode
```
private java.lang.String[] symptomsToReasoncode(Symptom[] symptoms)
```
  - getSubsystemName
```
public java.lang.String getSubsystemName()
```
    Name of the service providing health information
  - getState
```
public int getState()
```
    Health state returned by this service. Can be one of HEALTH_OK, HEALTH_WARN, HEALTH_CRITICAL, HEALTH_FAILED, HEALTH_OVERLOADED
  - compareSeverityTo
```
public int compareSeverityTo(HealthState other)
```
    Compares the severity of the supplied HealthState to this object's severity. BUG12620669 necessitated the need to logically compare the severity of different health state objects which could be done by getState() except the logical order is wrong where FAILED < OVERLOADED.
    
    Parameters:
    
    other -
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object's severity is less than, equal to, or greater than supplied object's severity.
  - compareSeverityTo
```
public int compareSeverityTo(int otherState)
```
  - compareSeverities
```
public static int compareSeverities(int aState,
                                    int baseState)
```
  - getReasonCode
```
@Deprecated
public java.lang.String[] getReasonCode()
```
    Deprecated.
    
    List of reasons corresponding to the current HealthState.
  - getReasonCodeSummary
```
public java.lang.String getReasonCodeSummary()
```
    Returns the reason codes array values concatenated into a single String, to allow the reason codes to be collected by WLDF Harvester.
    
    Excluded in public API Reference.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - mapToString
```
public static java.lang.String mapToString(int intValue)
```
    Provides string representation of health states.
    
    Excluded in public API Reference.
  - setSubsystemName
```
public void setSubsystemName(java.lang.String key)
```
    Excluded in public API Reference.
  - toCompositeData
```
public javax.management.openmbean.CompositeData toCompositeData()
                                                         throws javax.management.openmbean.OpenDataException
```
    Converts a ConsumerInfo instance to a CompositeData representation.
    
    Returns:
    
    the CompositeData representation of the object.
    
    Throws:
    
    javax.management.openmbean.OpenDataException - Thrown when an error occurs while constructing the CompositeData representation.
  - getCompositeType
```
protected javax.management.openmbean.CompositeType getCompositeType()
                                                             throws javax.management.openmbean.OpenDataException
```
    creates the open data CompositType instance for this object
    
    Throws:
    
    javax.management.openmbean.OpenDataException
  - getCompositeDataMap
```
protected java.util.Map getCompositeDataMap()
                                     throws javax.management.openmbean.OpenDataException
```
    creates a map of attribute values for use in CompositeData construction
    
    Throws:
    
    javax.management.openmbean.OpenDataException
  - setCritical
```
public void setCritical(boolean isCritical)
```
    Excluded in public API Reference.
  - isCritical
```
public boolean isCritical()
```
    Excluded in public API Reference.
  - setMBeanName
```
public void setMBeanName(java.lang.String name)
```
    Excluded in public API Reference.
  - getMBeanName
```
public java.lang.String getMBeanName()
```
    Excluded in public API Reference.
  - setMBeanType
```
public void setMBeanType(java.lang.String type)
```
    Excluded in public API Reference.
  - getMBeanType
```
public java.lang.String getMBeanType()
```
    Excluded in public API Reference.
  - getSymptoms
```
public Symptom[] getSymptoms()
```
    Get symptoms for this health state
  - getPartitionName
```
public java.lang.String getPartitionName()
```
    Get partition name for this health state
  - setPartitionName
```
public void setPartitionName(java.lang.String partitionName)
```
    Parameters:
    
    partitionName -
    
    Excluded in public API Reference.

Class HealthState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

HEALTH_OK

HEALTH_WARN

HEALTH_CRITICAL

HEALTH_FAILED

HEALTH_OVERLOADED

LOW_MEMORY_REASON

NULL_REASONS

NULL_SYMPTOMS

state

reasonCode

symptoms

partitionName

subsystemName

OPEN_TYPE_NAME

OPEN_DESCRIPTION

ITEM_COMPONENT

ITEM_HEALTH_STATE

ITEM_MBEAN

ITEM_SYMPTOMS

ITEM_REASON_CODE

ITEM_IS_CRITICAL

ITEM_PARTITION

itemNames

itemDescriptions

logicalSeverityOrder

isCritical

mbeanName

mbeanType

Constructor Detail

HealthState

HealthState

HealthState

HealthState

HealthState

Method Detail

symptomsToReasoncode

getSubsystemName

getState

compareSeverityTo

compareSeverityTo

compareSeverities

getReasonCode

getReasonCodeSummary

toString

mapToString

setSubsystemName

toCompositeData

getCompositeType

getCompositeDataMap

setCritical

isCritical

setMBeanName

getMBeanName

setMBeanType

getMBeanType

getSymptoms

getPartitionName

setPartitionName