org.pipservices.rpc.services

Class CommandableHttpService

java.lang.Object

org.pipservices.rpc.services.RestService

org.pipservices.rpc.services.CommandableHttpService

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

Abstract service that receives remove calls via HTTP/REST protocol to operations automatically generated for commands defined in ICommandable components. Each command is exposed as POST operation that receives all parameters in body object.

Commandable services require only 3 lines of code to implement a robust external HTTP-based remote interface.

### Configuration parameters ###

• base_route: base route for remote URI
• 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 ###

 
 class MyCommandableHttpService extends CommandableHttpService {
    public MyCommandableHttpService() {
       super();
       this._dependencyResolver.put(
           "controller",
           new Descriptor("mygroup","controller","*","*","1.0")
       );
    }
 }
 
 MyCommandableHttpService service = new MyCommandableHttpService();
 service.configure(ConfigParams.fromTuples(
     "connection.protocol", "http",
     "connection.host", "localhost",
     "connection.port", 8080
 ));
 service.setReferences(References.fromTuples(
    new Descriptor("mygroup","controller","default","default","1.0"), controller
 ));
 
 service.open("123");
 System.out.println("The REST service is running on port 8080");
 
 

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
CommandableHttpService(String baseRoute) Creates a new instance of the service.

Method Summary

Modifier and Type	Method and Description
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, configure, 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

CommandableHttpService

public CommandableHttpService(String baseRoute)

Creates a new instance of the service.

Parameters:

baseRoute - a service base route.

Method Detail

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.