org.pipservices.rpc.clients

Class DirectClient<T>

java.lang.Object

org.pipservices.rpc.clients.DirectClient<T>

All Implemented Interfaces:

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

public abstract class DirectClient<T>
extends Object
implements org.pipservices.commons.config.IConfigurable, org.pipservices.commons.run.IOpenable, org.pipservices.commons.refer.IReferenceable

Abstract client that calls controller directly in the same memory space.

It is used when multiple microservices are deployed in a single container (monolyth) and communication between them can be done by direct calls rather then through the network.

### Configuration parameters ###

• dependencies:
  • controller: override controller descriptor

### References ###

• *:logger:*:*:1.0 (optional) ILogger components to pass log messages
• *:counters:*:*:1.0 (optional) ICounters components to pass collected measurements
• *:controller:*:*:1.0 controller to call business methods

### Example ###

 
 class MyDirectClient extends DirectClient<IMyController> implements IMyClient {
 
   public MyDirectClient() {
       super();
       this._dependencyResolver.put('controller', new Descriptor(
           "mygroup", "controller", "*", "*", "*"));
    }
    ...
 
    public MyData getData(String correlationId, String id) {        
        Timing timing = this.instrument(correlationId, 'myclient.get_data');
        MyData result = this._controller.getData(correlationId, id);
        timing.endTiming();
        return result;        
    }
    ...
 }
 
 MyDirectClient client = new MyDirectClient();
 client.setReferences(References.fromTuples(
     new Descriptor("mygroup","controller","default","default","1.0"), controller
 ));
 
 MyData data = client.getData("123", "1");
 ...
 
 

Field Summary

Fields

Modifier and Type	Field and Description
protected T	_controller The controller reference.
protected org.pipservices.components.count.CompositeCounters	_counters The performance counters
protected org.pipservices.commons.refer.DependencyResolver	_dependencyResolver The dependency resolver to get controller reference.
protected org.pipservices.components.log.CompositeLogger	_logger The logger.
protected boolean	_opened The open flag.

Constructor Summary

Constructors

Constructor and Description
DirectClient() Creates a new instance of the client.

Method Summary

Modifier and Type	Method and Description
void	close(String correlationId) Closes component and frees used resources.
void	configure(org.pipservices.commons.config.ConfigParams config) Configures component by passing configuration parameters.
protected org.pipservices.components.count.Timing	instrument(String correlationId, String methodName) Adds instrumentation to log calls and measure call time.
boolean	isOpen() Checks if the component is opened.
void	open(String correlationId) Opens the component.
void	setReferences(org.pipservices.commons.refer.IReferences references) Sets references to dependent components.

Methods inherited from class java.lang.Object

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

Field Detail

_controller

protected T _controller

The controller reference.

_logger

protected org.pipservices.components.log.CompositeLogger _logger

The logger.

_counters

protected org.pipservices.components.count.CompositeCounters _counters

The performance counters

_dependencyResolver

protected org.pipservices.commons.refer.DependencyResolver _dependencyResolver

The dependency resolver to get controller reference.

_opened

protected boolean _opened

The open flag.

Constructor Detail

DirectClient

public DirectClient()

Creates a new instance of the client.

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

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

Sets references to dependent components.

Specified by:

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

Parameters:

references - references to locate the component dependencies.

Throws:

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

instrument

protected org.pipservices.components.count.Timing instrument(String correlationId,
                                                             String methodName)

Adds instrumentation to log calls and measure call time. It returns a Timing object that is used to end the time measurement.

Parameters:

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

methodName - a method name.

Returns:

Timing object to end the time measurement.

isOpen

public boolean isOpen()

Checks if the component is opened.

Specified by:

isOpen in interface org.pipservices.commons.run.IOpenable

Returns:

true if the component has been opened and false otherwise.

open

public void open(String correlationId)
          throws org.pipservices.commons.errors.ConnectionException

Opens the component.

Specified by:

open in interface org.pipservices.commons.run.IOpenable

Parameters:

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

Throws:

org.pipservices.commons.errors.ConnectionException - when controller reference is missing.

close

public void close(String correlationId)

Closes component and frees used resources.

Specified by:

close in interface org.pipservices.commons.run.IClosable

Parameters:

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