Response Elements
The response from the annotated Service Health Check operation is appended to the Base Service Health Check response, specifically in the
CustomComponentResponse
tag of the
Component
tag.
These values are part of the Custom Response elements and are provided to the annotated method at Runtime during invocation.
StackTrace
in Custom Component response is not affected when
suppressStackTrace=true/false
in the Base Service Health Check request. You can customize the Custom response for
StackTrace
. The
StackTrace
boolean from the request parameter is passed to the Custom annotated method. The Custom annotated method can use it and suppress the
StackTrace
or the annotated method can choose to ignore the parameter.
Element | Type | Description |
---|---|---|
CustomComponentResponse |
Element | Complex element that provides Health information of a Custom Service Health Check operation. |
status | Attribute |
Status of the Custom Component Response. The
|
description | Attribute | Description of the Custom Component Response. |
CustomComponentReference | Element |
Complex element that provides Health information about a Component Reference. Child element of
This element can occur multiple times. The attributes are described below. |
CustomInnerComponent | Element |
Complex element that provides Health information about a Business Component. Child element of
This element can occur multiple times. The attributes are described below. |
CustomSharedResource | Element |
Complex element that provides Health information about a Shared Resource. Child element of
This element can occur multiple times. The attributes are described below. |
CustomComponentReference |
Element |
Complex element that provides Health information about a Component Reference. It represents the Health state of the Component Reference upon Custom Service Health Check and is to be populated by the Custom Service Health Check method. |
name |
Attribute | Name of the Component Reference. |
status | Attribute | Status of the Component Reference. The
status value is either
, or
Timeout . The default is
Passed . If the error element of the
CustomComponentResponse is populated or an error/exception is thrown from the annotated method, the
status field is
Failed or
Timeout .
|
description | Attribute | Description of the Component Reference. |
CustomInnerComponent |
Element | Complex element that provides Health information about a Business Component.
It represents the Health state of the Business Component upon Custom Service Health Check and is to be populated by the Custom Service Health Check method. For example, a Business Component could be a cache, property loader, and so on. |
name | Attribute | Name of the Business Component. |
status | Attribute | Status of the Business Component. The
status value is either
, or
Timeout . The default is
Passed . If the error element of the
CustomComponentResponse is populated or an error/exception is thrown from the annotated method, the
status field is
Failed or
Timeout .
|
description | Attribute | Description of the Business Component. |
CustomSharedResource |
Element | Complex element that provides Health information about a Shared Resource.
It represents the Health state of the Shared Resource upon Custom Service Health Check and is to be populated by the Custom Service Health Check method. |
name | Attribute | Name of the Shared Resource. |
status | Attribute | Status of the Shared Resource. The
status value is either
, or
Timeout . The default is
Passed . If the error element of the
CustomComponentResponse is populated or an error/exception is thrown from the annotated method, the
status field is
Failed or
Timeout .
|
description | Attribute | Description of the Shared Resource. |
resourcename | Attribute | Resource name for the Shared Resource. |
resourcetype | Attribute | Resource type for the Shared Resource.
For example, the resource type of a Shared Resource could be JDBC, JMS, and so on. |