org.wso2.transport.http.netty.contractimpl.sender

Class ForwardedHeaderUpdater

java.lang.Object

org.wso2.transport.http.netty.contractimpl.sender.ForwardedHeaderUpdater

public class ForwardedHeaderUpdater
extends Object

This class updates Forwarded/X-Forwarded-- headers in outbound request.

Constructor Summary

Constructors

Constructor and Description
ForwardedHeaderUpdater(HttpCarbonMessage httpOutboundRequest, String localAddress)

Method Summary

Modifier and Type	Method and Description
boolean	isForwardedHeaderRequired() Check header values and return true if Forwarded header needs to be set.
boolean	isXForwardedHeaderRequired() Check header values and return true if X-Forwarded-- headers need to be set.
void	setDefactoForwardedHeaders() Set X-Forwarded-- headers to outbound request.
void	setForwardedHeader() Set forwarded header to outbound request.
void	transformAndSetForwardedHeader() Transform X-Forwarded-- to Forwarded headers and set to outbound request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardedHeaderUpdater

public ForwardedHeaderUpdater(HttpCarbonMessage httpOutboundRequest,
                              String localAddress)

Method Detail

isForwardedHeaderRequired

public boolean isForwardedHeaderRequired()

Check header values and return true if Forwarded header needs to be set. Forwarded header is set, when both Forwarded or X-Forwarded-- headers not present or only the Forwarded header is present.

Returns:

a boolean to denote the required header

isXForwardedHeaderRequired

public boolean isXForwardedHeaderRequired()

Check header values and return true if X-Forwarded-- headers need to be set. X-Forwarded-- headers are set, when only the X-Forwarded-- headers are present.

Returns:

a boolean to denote the required header

setForwardedHeader

public void setForwardedHeader()

Set forwarded header to outbound request.

See Also:

rfc7239

transformAndSetForwardedHeader

public void transformAndSetForwardedHeader()

Transform X-Forwarded-- to Forwarded headers and set to outbound request.

See Also:

rfc7239

setDefactoForwardedHeaders

public void setDefactoForwardedHeaders()

Set X-Forwarded-- headers to outbound request.