org.pipservices.rpc.services

Class HttpEndpoint

java.lang.Object

org.pipservices.rpc.services.HttpEndpoint

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 HttpEndpoint
extends Object
implements org.pipservices.commons.run.IOpenable, org.pipservices.commons.config.IConfigurable, org.pipservices.commons.refer.IReferenceable

Used for creating HTTP endpoints. An endpoint is a URL, at which a given service can be accessed by a client.

### Configuration parameters ###

Parameters to pass to the configure() method for component configuration:

• connection(s): the connection resolver's connections;
  • "connection.discovery_key" - the key to use for connection resolving in a discovery service;
  • "connection.protocol" - the connection's protocol;
  • "connection.host" - the target host;
  • "connection.port" - the target port;
  • "connection.uri" - the target URI.

### References ###

A logger, counters, and a connection resolver can be referenced by passing the following references to the object's setReferences() method:

• logger: "*:logger:*:*:1.0";
• counters: "*:counters:*:*:1.0";
• discovery: "*:discovery:*:*:1.0" (for the connection resolver).

### Examples ###

 
     public MyMethod(String correlationId, ConfigParams _config, IReferences _references) {
         HttpEndpoint endpoint = new HttpEndpoint();
         if (this._config)
             endpoint.configure(this._config);
         if (this._references)
             endpoint.setReferences(this._references);
         ...
 
         this._endpoint.open(correlationId);
         ...
     }
 
 

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpConnectionResolver	_connectionResolver
protected org.pipservices.components.count.CompositeCounters	_counters
protected org.pipservices.commons.refer.DependencyResolver	_dependencyResolver
protected org.pipservices.components.log.CompositeLogger	_logger

Constructor Summary

Constructors

Constructor and Description
HttpEndpoint()

Method Summary

Modifier and Type	Method and Description
void	close(String correlationId) Closes this endpoint and the REST server (service) that was opened earlier.
void	configure(org.pipservices.commons.config.ConfigParams config) Configures this HttpEndpoint using the given configuration parameters.
protected org.pipservices.components.count.Timing	Instrument(String correlationId, String name) Adds instrumentation to log calls and measure call time.
boolean	isOpen() Checks if the component is opened.
void	open(String correlationId) Opens a connection using the parameters resolved by the referenced connection resolver and creates a REST server (service) using the set options and parameters.
void	register(IRegisterable registration) Registers a registerable object for dynamic endpoint discovery.
void	registerResource(org.glassfish.jersey.server.model.Resource resource) Registers resource in this objects Rest service.
void	registerRoute(String method, String route, org.glassfish.jersey.process.Inflector<javax.ws.rs.container.ContainerRequestContext,javax.ws.rs.core.Response> action) Registers an action in this objects REST server (service) by the given method and route.
void	setReferences(org.pipservices.commons.refer.IReferences references) Sets references to this endpoint's logger, counters, and connection resolver.
void	unregister(IRegisterable registration) Unregisters a registerable object, so that it is no longer used in dynamic endpoint discovery.

Methods inherited from class java.lang.Object

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

Field Detail

_connectionResolver

protected HttpConnectionResolver _connectionResolver

_logger

protected org.pipservices.components.log.CompositeLogger _logger

_counters

protected org.pipservices.components.count.CompositeCounters _counters

_dependencyResolver

protected org.pipservices.commons.refer.DependencyResolver _dependencyResolver

Constructor Detail

HttpEndpoint

public HttpEndpoint()

Method Detail

configure

public void configure(org.pipservices.commons.config.ConfigParams config)
               throws org.pipservices.commons.errors.ConfigException

Configures this HttpEndpoint using the given configuration parameters. __Configuration parameters:__ - __connection(s)__ - the connection resolver's connections; - "connection.discovery_key" - the key to use for connection resolving in a discovery service; - "connection.protocol" - the connection's protocol; - "connection.host" - the target host; - "connection.port" - the target port; - "connection.uri" - the target URI.

Specified by:

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

Parameters:

config - configuration parameters, containing a "connection(s)" section.

Throws:

org.pipservices.commons.errors.ConfigException - when configuration is wrong.

See Also:

ConfigParams

setReferences

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

Sets references to this endpoint's logger, counters, and connection resolver. __References:__ - logger: "\*:logger:\*:\*:1.0" - counters: "\*:counters:\*:\*:1.0" - discovery: "\*:discovery:\*:\*:1.0" (for the connection resolver)

Specified by:

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

Parameters:

references - an IReferences object, containing references to a logger, counters, and a connection resolver.

Throws:

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

See Also:

IReferences

Instrument

protected org.pipservices.components.count.Timing Instrument(String correlationId,
                                                             String name)

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.

name - 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:

whether or not this endpoint is open with an actively listening REST server.

open

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

Opens a connection using the parameters resolved by the referenced connection resolver and creates a REST server (service) using the set options and parameters.

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.ApplicationException - when error occured.

close

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

Closes this endpoint and the REST server (service) that was opened earlier.

Specified by:

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

Parameters:

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

Throws:

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

register

public void register(IRegisterable registration)

Registers a registerable object for dynamic endpoint discovery.

Parameters:

registration - the registration to add.

See Also:

IRegisterable

unregister

public void unregister(IRegisterable registration)

Unregisters a registerable object, so that it is no longer used in dynamic endpoint discovery.

Parameters:

registration - the registration to remove.

See Also:

IRegisterable

registerRoute

public void registerRoute(String method,
                          String route,
                          org.glassfish.jersey.process.Inflector<javax.ws.rs.container.ContainerRequestContext,javax.ws.rs.core.Response> action)

Registers an action in this objects REST server (service) by the given method and route.

Parameters:

method - the HTTP method of the route.

route - the route to register in this object's REST server (service).

action - the action to perform at the given route.

registerResource

public void registerResource(org.glassfish.jersey.server.model.Resource resource)

Registers resource in this objects Rest service.

Parameters:

resource - resource for registration