Class ProxyBuilder

java.lang.Object

org.chenile.proxy.builder.ProxyBuilder

public class ProxyBuilder
extends Object

Creates a proxy for a chenile interface. A proxy allows the clients to avail the benefits of interception, transformation, caching etc. The chain of execution includes a router that determine if a local or remote http proxy must be used to invoke the actual service

Author:

Raja Shankar Kolluru

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ProxyBuilder.ProxyClass
static enum	ProxyBuilder.ProxyMode

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVOCATION_METHOD
(package private) LocalProxyInvoker	localProxyInvoker
(package private) ProxyTypeRouter	proxyTypeRouter
private ProxyUtils	proxyUtils
static final String	REMOTE_URL_BASE
(package private) RemoteProxyInvoker	remoteProxyInvoker

Constructor Summary

Constructors

Constructor	Description
ProxyBuilder()

Method Summary

Modifier and Type	Method	Description
<T> T	buildProxy(Class<T> interfaceToProxy, String serviceName, HeaderCopier headerCopier)	Build proxy for an interface.
<T> T	buildProxy(Class<T> interfaceToProxy, String serviceName, HeaderCopier headerCopier, String baseUrl)	Build proxy for an interface.
<T> T	buildProxy(Class<T> interfaceToProxy, String serviceName, HeaderCopier headerCopier, ProxyBuilder.ProxyMode proxyMode)
<T> T	buildProxy(Class<T> interfaceToProxy, String serviceName, HeaderCopier headerCopier, ProxyBuilder.ProxyMode proxyMode, String baseUrl)	This is used for testing purposes.

Methods inherited from class Object

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

Field Details

REMOTE_URL_BASE

public static final String REMOTE_URL_BASE

See Also:

• Constant Field Values

INVOCATION_METHOD

public static final String INVOCATION_METHOD

See Also:

• Constant Field Values

proxyUtils

@Autowired
private ProxyUtils proxyUtils

proxyTypeRouter

@Autowired
ProxyTypeRouter proxyTypeRouter

localProxyInvoker

@Autowired
LocalProxyInvoker localProxyInvoker

remoteProxyInvoker

@Autowired
RemoteProxyInvoker remoteProxyInvoker

Constructor Details

ProxyBuilder

public ProxyBuilder()

Method Details

buildProxy

public <T> T buildProxy(Class<T> interfaceToProxy,
 String serviceName,
 HeaderCopier headerCopier,
 ProxyBuilder.ProxyMode proxyMode)

buildProxy

public <T> T buildProxy(Class<T> interfaceToProxy,
 String serviceName,
 HeaderCopier headerCopier)

Build proxy for an interface. The headers from the current request are copied using the headerCopier. The service name is the service which is being proxied

Type Parameters:

T - - the interface represented by a generic

Parameters:

interfaceToProxy - the interface that is implemented by the service

serviceName - service name of the chenile service

headerCopier - any special treatment of header parameters

Returns:

the mock proxy that implements the interface

buildProxy

public <T> T buildProxy(Class<T> interfaceToProxy,
 String serviceName,
 HeaderCopier headerCopier,
 String baseUrl)

Build proxy for an interface. The headers from the current request are copied using the headerCopier. The service name is the service which is being proxied

Type Parameters:

T - - the interface represented by a generic

Parameters:

interfaceToProxy - the interface that is implemented by the service

serviceName - service name of the chenile service

headerCopier - any special treatment of header parameters

Returns:

the mock proxy that implements the interface

buildProxy

public <T> T buildProxy(Class<T> interfaceToProxy,
 String serviceName,
 HeaderCopier headerCopier,
 ProxyBuilder.ProxyMode proxyMode,
 String baseUrl)

This is used for testing purposes. For production, please make sure that proxy mode is set to COMPUTE_DYNAMICALLY

Type Parameters:

T - Interface to proxy class

Parameters:

interfaceToProxy - the interface that needs to be proxied

serviceName - - name of the service

headerCopier - this copies headers from the source to the target CHenile exchange

proxyMode - - can be set to always proxy local or remote for testing purposes

Returns:

the proxy that can be used in lieu of the service