com.prosyst.mprm.net.tunnel.interceptor

Interface TunnelRequestInterceptor

public interface TunnelRequestInterceptor

This interface can be implemented and registered as an OSGi service by the custom bundles willing to intercept HTTP tunneling requests before they are redirected to the target remote device. This can be used, e.g. for implementing of custom access control of the remote requests.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TARGET Service property identifying the interceptor target.

Method Summary

Modifier and Type	Method and Description
InterceptorResolution	validateRequest(java.lang.String targetDeviceId, HttpRequestHeader header) This method is invoked by the mPRM HTTP Tunnel for every HTTP tunneling request after the target device is determined but before the request is sent to it.

Field Detail

TARGET

static final java.lang.String TARGET

Service property identifying the interceptor target. The value of this property must be of type String.

See Also:

Constant Field Values

Method Detail

validateRequest

InterceptorResolution validateRequest(java.lang.String targetDeviceId,
                                      HttpRequestHeader header)

This method is invoked by the mPRM HTTP Tunnel for every HTTP tunneling request after the target device is determined but before the request is sent to it. Depending of the result returned by the method the request gets forwarded to the target devices or not.

Parameters:

targetDeviceId - the device which the HTTP request will be forwarded to.

header - HTTP request header data

Returns:

the resolution object which determined how the HTTP tunnel should handle this HTTP request. The possible resolutions are:

• InterceptorResolution.Resolution.PROCEED (created by method InterceptorResolution.proceed()) - instructs the HTTP tunnel to proceed with forwarding of this request to the target device.
• InterceptorResolution.Resolution.DENY (created by method InterceptorResolution.deny()) - instructs the HTTP tunnel to NOT forward the request to the target gateway and to return error 403 Forbidden to the caller.
• InterceptorResolution.Resolution.RETURN_RESPONSE (created by method InterceptorResolution.response(int, String, Map)) - instructs the HTTP tunnel to NOT forward the request to the target gateway and to return the specified HTTP response to the caller.