org.pipservices.rpc.connect

Class HttpConnectionResolver

java.lang.Object

org.pipservices.rpc.connect.HttpConnectionResolver

All Implemented Interfaces:

org.pipservices.commons.config.IConfigurable, org.pipservices.commons.refer.IReferenceable

public class HttpConnectionResolver
extends Object
implements org.pipservices.commons.refer.IReferenceable, org.pipservices.commons.config.IConfigurable

Helper class to retrieve connections for HTTP-based services abd clients.

In addition to regular functions of ConnectionResolver is able to parse http:// URIs and validate connection parameters before returning them.

### Configuration parameters ###

• connection:
  • discovery_key: (optional) a key to retrieve the connection from IDiscovery
  • ... other connection parameters
• connections: alternative to connection
  • [connection params 1]: first connection parameters
  • ...
  • [connection params N]: Nth connection parameters
  • ...

### References ###

• *:discovery:*:*:1.0 (optional) IDiscovery services

### Example ###

 
 ConfigParams config = ConfigParams.fromTuples(
      "connection.host", "10.1.1.100",
      "connection.port", 8080
 );
 
 HttpConnectionResolver connectionResolver = new HttpConnectionResolver();
 connectionResolver.configure(config);
 connectionResolver.setReferences(references);
 
 ConnectionParams params = connectionResolver.resolve("123");
 
 

See Also:

ConnectionParams, ConnectionResolver

Field Summary

Fields

Modifier and Type	Field and Description
protected org.pipservices.components.connect.ConnectionResolver	_connectionResolver The base connection resolver.

Constructor Summary

Constructors

Constructor and Description
HttpConnectionResolver()

Method Summary

Modifier and Type	Method and Description
void	configure(org.pipservices.commons.config.ConfigParams config) Configures component by passing configuration parameters.
void	register(String correlationId) Registers the given connection in all referenced discovery services.
org.pipservices.components.connect.ConnectionParams	resolve(String correlationId) Resolves a single component connection.
List<org.pipservices.components.connect.ConnectionParams>	resolveAll(String correlationId) Resolves all component connection.
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

_connectionResolver

protected org.pipservices.components.connect.ConnectionResolver _connectionResolver

The base connection resolver.

Constructor Detail

HttpConnectionResolver

public HttpConnectionResolver()

Method Detail

configure

public void configure(org.pipservices.commons.config.ConfigParams config)

Configures component by passing configuration parameters.

Specified by:

configure in interface org.pipservices.commons.config.IConfigurable

Parameters:

config - configuration parameters to be set.

setReferences

public void setReferences(org.pipservices.commons.refer.IReferences references)

Sets references to dependent components.

Specified by:

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

Parameters:

references - references to locate the component dependencies.

resolve

public org.pipservices.components.connect.ConnectionParams resolve(String correlationId)
                                                            throws org.pipservices.commons.errors.ApplicationException

Resolves a single component connection. If connections are configured to be retrieved from Discovery service it finds a IDiscovery and resolves the connection there.

Parameters:

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

Returns:

resolved connection.

Throws:

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

resolveAll

public List<org.pipservices.components.connect.ConnectionParams> resolveAll(String correlationId)
                                                                     throws org.pipservices.commons.errors.ApplicationException

Resolves all component connection. If connections are configured to be retrieved from Discovery service it finds a IDiscovery and resolves the connection there.

Parameters:

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

Returns:

resolved connections.

Throws:

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

register

public void register(String correlationId)
              throws org.pipservices.commons.errors.ApplicationException

Registers the given connection in all referenced discovery services. This method can be used for dynamic service discovery.

Parameters:

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

Throws:

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