Custom Health Check Using Annotations

The default Service Health Check function invokes a few operations that check the health of specific resources. These operations are generic in nature because of the large number of use cases supported by the TIBCO ActiveMatrix Platform. In some customer use cases, additional Service Health Check information specific to the customer deployment may be required.

Starting with this release, you can specify your own Service Health Check operations using Java Annotations. You can generate the Custom Service Health Check method for either an existing or a new Application/Composite using TIBCO ActiveMatrix Business Studio. You can then implement the Custom Service Health Check method by coding this generated method.
Note: While the Base Service Health Check*** feature is available for the Java, Spring, Mediation Implementation Types, the Custom Service Health Check with Annotations feature is available only for the Java Implementation Type.

You can also choose whether the Base Service Health Check functionality should forward the Service Health Check request on to the component references or conclude the Service Health Check request at the component where the Annotation is implemented. Similarly, you can choose whether the Base Service Health Check operation should perform Service Health Check for Shared Resources.

When a Java Implementation Type component is Started, it is scanned for annotations by the Platform. The Custom Service Health Check method, if implemented, is registered for the Implementation Type component. The method stays registered until the Implementation Type component is Stopped.

Refer to section Scenarios Explaining Custom Service Health Check for some scenarios that depict the concepts of Custom Service Health Check in detail.

*** In this document, the term "Base Service Health Check" refers to the Service Health Check functionality implemented by TIBCO.