org.apache.knox.gateway.dispatch

Class DefaultDispatch

java.lang.Object

org.apache.knox.gateway.dispatch.AbstractGatewayDispatch

org.apache.knox.gateway.dispatch.DefaultDispatch

All Implemented Interfaces:

Dispatch

Direct Known Subclasses:

ConfigurableDispatch, HeaderPreAuthFederationDispatch, URLDecodingDispatch

public class DefaultDispatch
extends AbstractGatewayDispatch

Field Summary

Fields

Modifier and Type	Field and Description
protected static Auditor	auditor
protected static String	EXCLUDE_ALL
protected static Set<String>	EXCLUDE_SET_COOKIES_DEFAULT
protected static SpiGatewayMessages	LOG
protected static SpiGatewayResources	RES
protected static String	SET_COOKIE
protected static String	WWW_AUTHENTICATE

Fields inherited from class org.apache.knox.gateway.dispatch.AbstractGatewayDispatch

client

Constructor Summary

Constructors

Constructor and Description
DefaultDispatch()

Method Summary

Modifier and Type	Method and Description
protected void	addCredentialsToRequest(org.apache.http.client.methods.HttpUriRequest outboundRequest) This method provides a hook for specialized credential propagation in subclasses.
protected void	closeInboundResponse(org.apache.http.HttpResponse response, InputStream stream)
void	copyResponseHeaderFields(javax.servlet.http.HttpServletResponse outboundResponse, org.apache.http.HttpResponse inboundResponse)
protected org.apache.http.HttpEntity	createRequestEntity(javax.servlet.http.HttpServletRequest request)
void	destroy()
void	doDelete(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doGet(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doHead(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doOptions(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doPatch(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doPost(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	doPut(URI url, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected org.apache.http.HttpResponse	executeOutboundRequest(org.apache.http.client.methods.HttpUriRequest outboundRequest)
protected void	executeRequest(org.apache.http.client.methods.HttpUriRequest outboundRequest, javax.servlet.http.HttpServletRequest inboundRequest, javax.servlet.http.HttpServletResponse outboundResponse)
protected void	executeRequestWrapper(org.apache.http.client.methods.HttpUriRequest outboundRequest, javax.servlet.http.HttpServletRequest inboundRequest, javax.servlet.http.HttpServletResponse outboundResponse) Wrapper around execute request to accommodate any request processing such as additional HA logic.
protected String	getInboundResponseContentType(org.apache.http.HttpEntity entity)
Set<String>	getOutboundResponseExcludedSetCookieHeaderDirectives()
Set<String>	getOutboundResponseExcludeHeaders()
protected int	getReplayBufferSize()
protected int	getReplayBufferSizeInBytes()
String	getServiceRole()
protected void	outboundResponseWrapper(org.apache.http.client.methods.HttpUriRequest outboundRequest, javax.servlet.http.HttpServletRequest inboundRequest, javax.servlet.http.HttpServletResponse outboundResponse) A outbound response wrapper used by classes extending this class to modify any outgoing response i.e.
protected void	setReplayBufferSize(int size)
protected void	setReplayBufferSizeInBytes(int size)
void	setServiceRole(String serviceRole)
protected void	writeOutboundResponse(org.apache.http.client.methods.HttpUriRequest outboundRequest, javax.servlet.http.HttpServletRequest inboundRequest, javax.servlet.http.HttpServletResponse outboundResponse, org.apache.http.HttpResponse inboundResponse)

Methods inherited from class org.apache.knox.gateway.dispatch.AbstractGatewayDispatch

copyRequestHeaderFields, encodeUnwiseCharacters, getDispatchUrl, getHttpClient, getOutboundRequestExcludeHeaders, init, setHttpClient, writeResponse

Methods inherited from class java.lang.Object

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

Field Detail

SET_COOKIE

protected static final String SET_COOKIE

See Also:

Constant Field Values

WWW_AUTHENTICATE

protected static final String WWW_AUTHENTICATE

See Also:

Constant Field Values

EXCLUDE_SET_COOKIES_DEFAULT

protected static final Set<String> EXCLUDE_SET_COOKIES_DEFAULT

LOG

protected static final SpiGatewayMessages LOG

RES

protected static final SpiGatewayResources RES

auditor

protected static final Auditor auditor

EXCLUDE_ALL

protected static final String EXCLUDE_ALL

See Also:

Constant Field Values

Constructor Detail

DefaultDispatch

public DefaultDispatch()

Method Detail

destroy

public void destroy()

getReplayBufferSize

protected int getReplayBufferSize()

getServiceRole

public String getServiceRole()

setServiceRole

public void setServiceRole(String serviceRole)

setReplayBufferSize

@Configure
protected void setReplayBufferSize(@Default(value="-1")
                                              int size)

getReplayBufferSizeInBytes

protected int getReplayBufferSizeInBytes()

setReplayBufferSizeInBytes

protected void setReplayBufferSizeInBytes(int size)

executeRequestWrapper

protected void executeRequestWrapper(org.apache.http.client.methods.HttpUriRequest outboundRequest,
                                     javax.servlet.http.HttpServletRequest inboundRequest,
                                     javax.servlet.http.HttpServletResponse outboundResponse)
                              throws IOException

Wrapper around execute request to accommodate any request processing such as additional HA logic.

Parameters:

outboundRequest -

inboundRequest -

outboundResponse -

Throws:

IOException

outboundResponseWrapper

protected void outboundResponseWrapper(org.apache.http.client.methods.HttpUriRequest outboundRequest,
                                       javax.servlet.http.HttpServletRequest inboundRequest,
                                       javax.servlet.http.HttpServletResponse outboundResponse)

A outbound response wrapper used by classes extending this class to modify any outgoing response i.e. cookies

executeRequest

protected void executeRequest(org.apache.http.client.methods.HttpUriRequest outboundRequest,
                              javax.servlet.http.HttpServletRequest inboundRequest,
                              javax.servlet.http.HttpServletResponse outboundResponse)
                       throws IOException

Throws:

IOException

executeOutboundRequest

protected org.apache.http.HttpResponse executeOutboundRequest(org.apache.http.client.methods.HttpUriRequest outboundRequest)
                                                       throws IOException

Throws:

IOException

writeOutboundResponse

protected void writeOutboundResponse(org.apache.http.client.methods.HttpUriRequest outboundRequest,
                                     javax.servlet.http.HttpServletRequest inboundRequest,
                                     javax.servlet.http.HttpServletResponse outboundResponse,
                                     org.apache.http.HttpResponse inboundResponse)
                              throws IOException

Throws:

IOException

getInboundResponseContentType

protected String getInboundResponseContentType(org.apache.http.HttpEntity entity)

closeInboundResponse

protected void closeInboundResponse(org.apache.http.HttpResponse response,
                                    InputStream stream)
                             throws IOException

Throws:

IOException

addCredentialsToRequest

protected void addCredentialsToRequest(org.apache.http.client.methods.HttpUriRequest outboundRequest)

This method provides a hook for specialized credential propagation in subclasses.

Parameters:

outboundRequest - outboundRequest to add credentials to

createRequestEntity

protected org.apache.http.HttpEntity createRequestEntity(javax.servlet.http.HttpServletRequest request)
                                                  throws IOException

Throws:

IOException

doGet

public void doGet(URI url,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws IOException

Specified by:

doGet in interface Dispatch

Overrides:

doGet in class AbstractGatewayDispatch

Throws:

IOException

doOptions

public void doOptions(URI url,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws IOException

Specified by:

doOptions in interface Dispatch

Overrides:

doOptions in class AbstractGatewayDispatch

Throws:

IOException

doPut

public void doPut(URI url,
                  javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws IOException

Specified by:

doPut in interface Dispatch

Overrides:

doPut in class AbstractGatewayDispatch

Throws:

IOException

doPatch

public void doPatch(URI url,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws IOException

Specified by:

doPatch in interface Dispatch

Overrides:

doPatch in class AbstractGatewayDispatch

Throws:

IOException

doPost

public void doPost(URI url,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   URISyntaxException

Specified by:

doPost in interface Dispatch

Overrides:

doPost in class AbstractGatewayDispatch

Throws:

IOException

URISyntaxException

doDelete

public void doDelete(URI url,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws IOException

Specified by:

doDelete in interface Dispatch

Overrides:

doDelete in class AbstractGatewayDispatch

Throws:

IOException

doHead

public void doHead(URI url,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws IOException

Specified by:

doHead in interface Dispatch

Overrides:

doHead in class AbstractGatewayDispatch

Throws:

IOException

copyResponseHeaderFields

public void copyResponseHeaderFields(javax.servlet.http.HttpServletResponse outboundResponse,
                                     org.apache.http.HttpResponse inboundResponse)

getOutboundResponseExcludeHeaders

public Set<String> getOutboundResponseExcludeHeaders()

getOutboundResponseExcludedSetCookieHeaderDirectives

public Set<String> getOutboundResponseExcludedSetCookieHeaderDirectives()