org.pipservices.rpc.services

Class HeartbeatRestService

java.lang.Object

org.pipservices.rpc.services.RestService

org.pipservices.rpc.services.HeartbeatRestService

All Implemented Interfaces:

org.pipservices.commons.config.IConfigurable, org.pipservices.commons.refer.IReferenceable, org.pipservices.commons.refer.IUnreferenceable, org.pipservices.commons.run.IClosable, org.pipservices.commons.run.IOpenable, IRegisterable

public class HeartbeatRestService
extends RestService

Service returns heartbeat via HTTP/REST protocol.

The service responds on /heartbeat route (can be changed) with a string with the current time in UTC.

This service route can be used to health checks by loadbalancers and container orchestrators.

### Configuration parameters ###

• base_route: base route for remote URI (default: "")
• route: route to heartbeat operation (default: "heartbeat")
• dependencies:
  • endpoint: override for HTTP Endpoint dependency
• connection(s):
  • discovery_key: (optional) a key to retrieve the connection from IDiscovery
  • protocol: connection protocol: http or https
  • host: host name or IP address
  • port: port number
  • uri: resource URI or connection string with all parameters in it

### References ###

• *:logger:*:*:1.0 (optional) ILogger components to pass log messages
• *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements
• *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection
• *:endpoint:http:*:1.0 (optional) HttpEndpoint reference

### Example ###

 
 HeartbeatService service = new HeartbeatService();
 service.configure(ConfigParams.fromTuples(
     "route", "ping",
     "connection.protocol", "http",
     "connection.host", "localhost",
     "connection.port", 8080
 ));
 
 service.open("123");
 System.out.println("The Heartbeat service is accessible at http://+:8080/ping");
 
 

See Also:

RestService

Field Summary

Fields inherited from class org.pipservices.rpc.services.RestService

_baseRoute, _counters, _dependencyResolver, _endpoint, _logger, _server, _url

Constructor Summary

Constructors

Constructor and Description
HeartbeatRestService() Creates a new instance of this service.

Method Summary

Modifier and Type	Method and Description
void	configure(org.pipservices.commons.config.ConfigParams config) Configures component by passing configuration parameters.
void	register() Registers all service routes in HTTP endpoint.

Methods inherited from class org.pipservices.rpc.services.RestService

close, getBodyAsJson, getBodyAsString, getQueryParameter, instrument, isOpen, open, registerResource, registerRoute, sendCreatedResult, sendDeleted, sendEmptyResult, sendError, sendResult, setReferences, unsetReferences

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeartbeatRestService

public HeartbeatRestService()

Creates a new instance of this service.

Method Detail

configure

public void configure(org.pipservices.commons.config.ConfigParams config)
               throws org.pipservices.commons.errors.ConfigException

Configures component by passing configuration parameters.

Specified by:

configure in interface org.pipservices.commons.config.IConfigurable

Overrides:

configure in class RestService

Parameters:

config - configuration parameters to be set.

Throws:

org.pipservices.commons.errors.ConfigException - when configuration is wrong.

register

public void register()

Registers all service routes in HTTP endpoint.