org.pipservices.rpc.clients

Class CommandableHttpClient

java.lang.Object

org.pipservices.rpc.clients.RestClient

org.pipservices.rpc.clients.CommandableHttpClient

All Implemented Interfaces:

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

public class CommandableHttpClient
extends RestClient

Abstract client that calls commandable HTTP service.

Commandable services are generated automatically for ICommandable objects. Each command is exposed as POST operation that receives all parameters in body object.

### Configuration parameters ###

• base_route: base route for remote URI
• 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
• options:
  • retries: number of retries (default: 3)
  • connect_timeout: connection timeout in milliseconds (default: 10 sec)
  • timeout: invocation timeout in milliseconds (default: 10 sec)

### 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

### Example ###

 
 class MyCommandableHttpClient extends CommandableHttpClient implements IMyClient {
    ...
 
    public MyData getData(String correlationId, String id) {
        return this.callCommand(
        	  MyData.class,
            "get_data",
            correlationId,
            new MyData(id)
        );        
    }
    ...
 }
 
 MyCommandableHttpClient client = new MyCommandableHttpClient();
 client.configure(ConfigParams.fromTuples(
     "connection.protocol", "http",
     "connection.host", "localhost",
     "connection.port", 8080
 ));
 
 MyData data = client.getData("123", "1");
 ...
 
 

Field Summary

Fields inherited from class org.pipservices.rpc.clients.RestClient

_baseRoute, _client, _connectionResolver, _counters, _logger, _options, _retries, _url

Constructor Summary

Constructors

Constructor and Description
CommandableHttpClient(String baseRoute) Creates a new instance of the client.

Method Summary

Modifier and Type	Method and Description
<T> T	callCommand(Class<T> type, String route, String correlationId, Object entity) Calls a remote method via HTTP commadable protocol.
<T> T	callCommand(javax.ws.rs.core.GenericType<T> type, String route, String correlationId, Object entity) Calls a remote method via HTTP commadable protocol.

Methods inherited from class org.pipservices.rpc.clients.RestClient

addCorrelationId, addFilterParams, addPagingParams, close, configure, execute, execute, executeRequest, instrument, isOpen, open, setReferences

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandableHttpClient

public CommandableHttpClient(String baseRoute)

Creates a new instance of the client.

Parameters:

baseRoute - a base route for remote service.

Method Detail

callCommand

public <T> T callCommand(Class<T> type,
                         String route,
                         String correlationId,
                         Object entity)
                  throws org.pipservices.commons.errors.ApplicationException

Calls a remote method via HTTP commadable protocol. The call is made via POST operation and all parameters are sent in body object. The complete route to remote method is defined as baseRoute + "/" + name.

Parameters:

type - the class type.

route - a name of the command to call.

correlationId - (optional) transaction id to trace execution through call chain.

entity - body object.

Returns:

result of the command.

Throws:

org.pipservices.commons.errors.ApplicationException - when error occured.

callCommand

public <T> T callCommand(javax.ws.rs.core.GenericType<T> type,
                         String route,
                         String correlationId,
                         Object entity)
                  throws org.pipservices.commons.errors.ApplicationException

Calls a remote method via HTTP commadable protocol. The call is made via POST operation and all parameters are sent in body object. The complete route to remote method is defined as baseRoute + "/" + name.

Parameters:

type - the generic class type.

route - a name of the command to call.

correlationId - (optional) transaction id to trace execution through call chain.

entity - body object.

Returns:

result of the command.

Throws:

org.pipservices.commons.errors.ApplicationException - when error occured.