Client Status
The client status reflects its health with respect to the heartbeat parameter configured in the application. The CipherTrust Manager evaluates and updates status of all the CADP for Java clients after every heartbeat_interval based on the number of missed heartbeats. The following table summarizes the different client states, associated behavior, and their impact on license consumption.
| State | Description | Message | Behavior | Impact on license consumption |
|---|---|---|---|---|
| Healthy | A healthy client sends heartbeat on regular heartbeat_interval. | The client is in healthy state. | Client can perform cryptographic operations. | The licenses are being utilized. |
| Warning | The CipherTrust Manager moves a client to the warning state when the client skips sending heartbeat based on the defined heartbeat_interval. | The client is in warning state. | — The client can continue performing the cryptographic operations. — The application will keep working. | The licenses are being utilized. |
| Revoked | CipherTrust Manager will revoke a client if the number of missed heartbeat count = Heartbeat Timeout Count. | The maximum limit of heartbeat timeout count has reached. | — The client can no longer perform any cryptographic operations and it will be removed from single pane of glass. — The application will throw the following error: No connection with Key Manager. | The licenses are released. |
| Unauthorized | The client is considered unauthorized if: — it is has been deleted manually — it has been revoked manually — the client certificate has expired. | The client is either deleted, revoked, or expired. | — The client can no longer perform any cryptographic operations and it will be removed from single pane of glass. — The application will throw the following error: The client is either deleted, revoked, or expired.In case of unauthorized state, the client will be in healthy state for maximum 5 minutes. | The licenses are released. |
For revoked and unauthorized states, restart the application to continue with the cryptographic operations.
Tip
You can configure the client status notification in your application. Configuring client status notifications enhances operational efficiency by enabling proactive monitoring, timely issue resolution, and optimized license management. Refer to Integrate client status notification in application for details.
