Coding Guidelines

The following coding guidelines will help the user while implementing Custom Service Health Check method.
Note: All the beans must be instantiated. That is, an Object Instance must be created.

Bean: CustomComponentResponse

Contained Element Type and Setter Description
CustomInnerComponent
  • Simple/Complex: List<Complex>
  • Type: Complex
  • Setter: GetCustomInnerComponent().add(CustomInnerComponentInstance)
As it is a list, getCustomInnerComponent() on an Object of CustomComponentResponse returns a reference list. In the list, you can add an Object instance of CustomInnerComponent.
CustomComponentReference
  • Simple/Complex: List<Complex>
  • Type: Complex
  • Setter: GetCustomComponentReference().add(CustomComponentReferenceInstance)
As it is a list, GetCustomComponentReference() on an Object of CustomComponentResponse returns a reference list. In the list, you can add an Object instance of CustomComponentReference.
CustomSharedResource
  • Simple/Complex: List<Complex>
  • Type: Complex
  • Setter: GetCustomSharedResource().add(CustomSharedResourceInstance)
As it is a list, GetCustomSharedResource() on an Object of CustomComponentResponse returns a reference list. In the list, you can add an Object instance of CustomSharedResource.
Error
  • Simple/Complex: Complex
  • Type: Complex
  • Setter: setCustomError(ErrorInstance)
Creates Object instance of CustomError and the instance can be set in CustomComponentResponse using the set method.
status
  • Simple/Complex: Simple
  • Type: Enum
  • Setter: setStatus
Possible Values are CustomStatus.PASSED, CustomStatus.FAILED, CustomStatus.TIMEOUT.
description
  • Simple/Complex: Simple
  • Type: String
  • Setter: setDescription
Simple string set method for the string field.

Bean: CustomComponentReference

Contained Element Type and Setter Description
Error Simple/Complex: Complex

Type: Complex

Setter: setCustomError(ErrorInstance)

Creates Object instance of CustomError and the instance can be set in CustomComponentResponse using the set method.
name Simple/Complex: Simple

Type: String

Setter: setName

Simple string set method for the string field.
status Simple/Complex: Simple Type: Enum

Setter: setStatus

Possible Values are CustomStatus.PASSED, CustomStatus.FAILED, CustomStatus.TIMEOUT
description Simple/Complex: Simple

Type: String

Setter: setDescription

Simple string set method for the string field.

Bean: CustomInnerComponent

Contained Element Type and Setter Description
Error Simple/Complex: Complex

Type: Complex

Setter:setCustomError(ErrorInstance)

Creates Object instance of CustomError and the instance can be set in CustomComponentResponse using the set method.
name Simple/Complex: Simple

Type:String

Setter: setName

Simple string set method for the string field.
description Simple/Complex: Simple

Type: String

Setter:setDescription

Simple string set method for the string field.
status Simple/Complex: Simple

Type: Enum

Setter: setStatus

Possible Values are CustomStatus.PASSED, CustomStatus.FAILED, CustomStatus.TIMEOUT

Bean: CustomSharedResource

Contained Element Type and Setter Description
Error Simple/Complex: Complex

Type: Complex

Setter: setCustomError(ErrorInstance)

Creates Object instance of CustomError and the instance can be set in CustomComponentResponse using the set method.
name Simple/Complex: Simple

Type: String

Setter: setName

Simple string set method for the string field.
resourceName Simple/Complex: Simple

Type: String

Setter: setResourceName

Simple string set method for the string field.
resourceType Simple/Complex: Simple

Type: String

Setter: setResourceType

Simple string set method for the string field.
status Simple/Complex: Simple

Type: Enum

Setter: setStatus

Possible Values are CustomStatus.PASSED, CustomStatus.FAILED, CustomStatus.TIMEOUT
description Simple/Complex: Simple

Type: String

Setter: setDescription

Simple string set method for the string field.

Bean: CustomError

Contained Element Type and Setter Description
errorCode Simple/Complex: Simple

Type: String

Setter: setErrorCode

Simple string set method for the string field.
errorString Simple/Complex: Simple

Type: String

Setter: setErrorString

Simple string set method for the string field.
stackTrace Simple/Complex: Simple

Type: String

Setter: setStackTrace

Simple string set method for the string field.