com.prosyst.mprm.net.tunnel.interceptor

Class InterceptorResolution

java.lang.Object

com.prosyst.mprm.net.tunnel.interceptor.InterceptorResolution

public class InterceptorResolution
extends java.lang.Object

Represents the response of the custom HTTP tunneling request interceptor - as returned by method TunnelRequestInterceptor.validateRequest(String, HttpRequestHeader). The possible resolutions are:

• InterceptorResolution.Resolution.PROCEED (created by method proceed()) - instructs the HTTP tunnel to proceed with forwarding of this request to the target device.
• InterceptorResolution.Resolution.DENY (created by method 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 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InterceptorResolution.Resolution

Method Summary

Modifier and Type	Method and Description
static InterceptorResolution	deny() Creates InterceptorResolution result which instructs the HTTP tunnel to NOT forward the request to the target device and to return 403 Forbidden to the caller.
int	getHttpResponse() Valid only if the resolution is InterceptorResolution.Resolution.RETURN_RESPONSE
InterceptorResolution.Resolution	getResolution()
java.util.Map<java.lang.String,java.lang.String>	getResponseHeaders() Valid only if the resolution is InterceptorResolution.Resolution.RETURN_RESPONSE
java.lang.String	getResponsePhrase() Valid only if the resolution is InterceptorResolution.Resolution.RETURN_RESPONSE
static InterceptorResolution	proceed() Creates InterceptorResolution result which instructs the HTTP tunnel to proceed with forwarding of the request.
static InterceptorResolution	response(int httpResponse, java.lang.String responsePhrase, java.util.Map<java.lang.String,java.lang.String> responseHeaders) Creates InterceptorResolution result which instructs the HTTP tunnel to NOT forward the request to the target device and to return HTTP response specified by the interceptor.

Methods inherited from class java.lang.Object

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

Method Detail

proceed

public static InterceptorResolution proceed()

Creates InterceptorResolution result which instructs the HTTP tunnel to proceed with forwarding of the request.

Returns:

InterceptorResolution with resolution InterceptorResolution.Resolution.PROCEED.

deny

public static InterceptorResolution deny()

Creates InterceptorResolution result which instructs the HTTP tunnel to NOT forward the request to the target device and to return 403 Forbidden to the caller.

Returns:

InterceptorResolution with resolution InterceptorResolution.Resolution.DENY.

response

public static InterceptorResolution response(int httpResponse,
                                             java.lang.String responsePhrase,
                                             java.util.Map<java.lang.String,java.lang.String> responseHeaders)

Creates InterceptorResolution result which instructs the HTTP tunnel to NOT forward the request to the target device and to return HTTP response specified by the interceptor.

Parameters:

httpResponse - the HTTP response code to be returned to the caller.

responsePhrase - the HTTP response phrase to be returned to the caller.

responseHeaders - the HTTP response headers to be returned to the caller.

Returns:

InterceptorResolution with resolution InterceptorResolution.Resolution.RETURN_RESPONSE.

getResolution

public InterceptorResolution.Resolution getResolution()

Returns:

resolution

getHttpResponse

public int getHttpResponse()

Valid only if the resolution is InterceptorResolution.Resolution.RETURN_RESPONSE

Returns:

the HTTP response code to be returned to the caller.

getResponsePhrase

public java.lang.String getResponsePhrase()

Valid only if the resolution is InterceptorResolution.Resolution.RETURN_RESPONSE

Returns:

the HTTP response phrase to be returned to the caller.

getResponseHeaders

public java.util.Map<java.lang.String,java.lang.String> getResponseHeaders()

Valid only if the resolution is InterceptorResolution.Resolution.RETURN_RESPONSE

Returns:

the HTTP response headers to be returned to the caller.