org.pipservices.rpc.services

Class StatusRestService

java.lang.Object

org.pipservices.rpc.services.RestService

org.pipservices.rpc.services.StatusRestService

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 StatusRestService
extends RestService

Service that returns microservice status information via HTTP/REST protocol.

The service responds on /status route (can be changed) with a JSON object:

{

• "id": unique container id (usually hostname)
• "name": container name (from ContextInfo)
• "description": container description (from ContextInfo)
• "start_time": time when container was started
• "current_time": current time in UTC
• "uptime": duration since container start time in milliseconds
• "properties": additional container properties (from ContextInfo)
• "components": descriptors of components registered in the container

}

### Configuration parameters ###

• base_route: base route for remote URI
• route: status route (default: "status")
• dependencies:
  • endpoint: override for HTTP Endpoint dependency
  • controller: override for Controller 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 ###

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

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
StatusRestService() 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.
void	setReferences(org.pipservices.commons.refer.IReferences references) Sets references to dependent components.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusRestService

public StatusRestService()

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.

setReferences

public void setReferences(org.pipservices.commons.refer.IReferences references)
                   throws org.pipservices.commons.refer.ReferenceException,
                          org.pipservices.commons.errors.ConfigException

Sets references to dependent components.

Specified by:

setReferences in interface org.pipservices.commons.refer.IReferenceable

Overrides:

setReferences in class RestService

Parameters:

references - references to locate the component dependencies.

Throws:

org.pipservices.commons.refer.ReferenceException - when no found references.

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

register

public void register()

Registers all service routes in HTTP endpoint.