CommandableHttpController

Abstract service that receives remote calls via HTTP/REST protocol to operations automatically generated for commands defined in ICommandable components.

Extends: RestController

See also RestController, CommandableHttpClient

Description

The CommandableHttpController class allows you to create services that receive remote calls via the HTTP/REST protocol to operations automatically generated for commands defined in ICommandable components.

Important points

  • Each command is exposed as POST operation that receives all parameters in the body object.
  • Commandable services require only three 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
  • *:traces:*:*:1.0 - (optional) ITracer components to record traces
  • *:discovery:*:*:1.0 - (optional) IDiscovery services to resolve connection

Constructors

Creates a new instance of the service.

public CommandableHttpController(String baseRoute)

  • baseRoute: String - a service base route.

Fields

_commandSet

Set of commands.

protected CommandSet _commandSet

_swaggerAuto

Boolean variable that defines whether the configuration of Swagger is autogenerated or not.

protected boolean _swaggerAuto = true

Instance methods

configure

Configures a component by passing configuration parameters.

public void configure(ConfigParams config) throws ConfigException

  • config: ConfigParams - configuration parameters to be set.

register

Registers all service routes in the HTTP endpoint.

public void register() throws ReferenceException

Examples

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

See also