org.wso2.transport.http.netty.contractimpl.common

Class Util

java.lang.Object

org.wso2.transport.http.netty.contractimpl.common.Util

public class Util
extends Object

Includes utility methods for creating http requests and responses and their related properties.

Method Summary

Modifier and Type	Method and Description
static void	addResponseWriteFailureListener(HttpResponseFuture outboundRespStatusFuture, io.netty.channel.ChannelFuture channelFuture, Http2OutboundRespListener http2OutboundRespListener) Adds a listener to notify the outbound response future if an error occurs while writing the response message.
static boolean	checkContentLengthAndTransferEncodingHeaderAllowance(HttpCarbonMessage httpOutboundRequest)
static void	checkForResponseWriteStatus(HttpCarbonMessage inboundRequestMsg, HttpResponseFuture outboundRespStatusFuture, io.netty.channel.ChannelFuture channelFuture) Checks for status of the response write operation.
static void	checkUnWritabilityAndNotify(io.netty.channel.ChannelHandlerContext context, BackPressureHandler backpressureHandler) Checks if channel is unWritable and notifies BackPressure observable.
static SSLEngine	configureHttpPipelineForSSL(io.netty.channel.socket.SocketChannel socketChannel, String host, int port, SSLConfig sslConfig) Configure outbound HTTP pipeline for SSL configuration.
static io.netty.handler.codec.http.HttpResponse	createFullHttpResponse(HttpCarbonMessage outboundResponseMsg, String inboundReqHttpVersion, String serverName, boolean keepAlive, io.netty.buffer.ByteBuf fullContent)
static HttpCarbonMessage	createHTTPCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage, io.netty.channel.ChannelHandlerContext ctx) Creates HTTP carbon message.
static io.netty.handler.codec.http.HttpRequest	createHttpRequest(HttpCarbonMessage outboundRequestMsg)
static io.netty.handler.codec.http.HttpRequest	createHttpRequestFromHttp2Headers(io.netty.handler.codec.http2.Http2Headers http2Headers, int streamId) Creates a HttpRequest using a Http2Headers received over a particular HTTP/2 stream.
static io.netty.handler.codec.http.HttpResponse	createHttpResponse(HttpCarbonMessage outboundResponseMsg, String inboundReqHttpVersion, String serverName, boolean keepAlive)
static HttpCarbonMessage	createInboundReqCarbonMsg(io.netty.handler.codec.http.HttpRequest httpRequestHeaders, io.netty.channel.ChannelHandlerContext ctx, SourceHandler sourceHandler) Create a HttpCarbonMessage using the netty inbound http request.
static HttpCarbonMessage	createInboundRespCarbonMsg(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpResponse httpResponseHeaders, HttpCarbonMessage outboundRequestMsg) Create a HttpCarbonMessage using the netty inbound response message.
static io.netty.handler.ssl.SslContext	createInsecureSslEngineForHttp2() Creates an insecure ssl engine for clients connecting over HTTP2
static String	createServerConnectorID(String host, int port) Create ID for server connector.
static BackPressureHandler	getBackPressureHandler(io.netty.channel.ChannelHandlerContext channelContext) Use this method to get the BackPressureHandler in the pipeline.
static Boolean	getBooleanProperty(Map<String,Object> properties, String key, boolean defaultVal) Get boolean type property value from a property map.
static io.netty.handler.codec.http.HttpResponseStatus	getHttpResponseStatus(HttpCarbonMessage msg)
static int	getIntProperty(Map<String,Object> properties, String key, int defaultVal) Get integer type property value from a property map.
static Long	getLongProperty(Map<String,Object> properties, String key, long defaultVal) Get long type property value from a property map.
static String	getStringProperty(Map<String,Object> properties, String key, String defaultVal) Get string type property value from a property map.
static void	handleIncompleteMsgOnReset(Http2Reset http2Reset, int streamId, HttpCarbonMessage message)
static void	handleOutboundConnectionHeader(SenderConfiguration senderConfiguration, HttpCarbonMessage httpOutboundRequest)
static boolean	is100ContinueRequest(HttpCarbonMessage inboundRequestMsg) Check whether a particular request is expecting continue.
static boolean	isKeepAlive(KeepAliveConfig keepAliveConfig, HttpCarbonMessage outboundRequestMsg) Check whether a connection should alive or not.
static boolean	isKeepAliveConnection(KeepAliveConfig keepAliveConfig, String requestConnectionHeader, String httpVersion) Decide whether the connection should be kept open.
static boolean	isLastHttpContent(io.netty.handler.codec.http.HttpContent httpContent) Check if a given content is last httpContent.
static boolean	isVersionCompatibleForChunking(String httpVersion) Returns the status of chunking compatibility with http version.
static void	resetChannelAttributes(io.netty.channel.ChannelHandlerContext ctx) Reset channel attributes.
static void	safelyRemoveHandlers(io.netty.channel.ChannelPipeline pipeline, String... handlerNames) Removes handlers from the pipeline if they are present.
static ScheduledFuture<?>	schedule(io.netty.channel.ChannelHandlerContext ctx, Runnable task, long delay)
static void	sendAndCloseNoEntityBodyResp(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http.HttpResponseStatus status, io.netty.handler.codec.http.HttpVersion httpVersion, String serverName) Send back no entity body response and close the connection.
static void	setBackPressureListener(HttpCarbonMessage outboundMessage, BackPressureHandler backpressureHandler, io.netty.channel.ChannelHandlerContext ctx) Sets the backPressure listener the to the Observable of the handler.
static void	setCorrelationIdForLogging(io.netty.channel.ChannelPipeline pipeline, io.netty.channel.ChannelInboundHandlerAdapter srcHandler)
static void	setForwardedExtension(ForwardedExtensionConfig forwardedConfig, String localAddress, HttpCarbonMessage httpOutboundRequest)
static void	setHostNameVerfication(SSLEngine sslEngine) Disable host name verification if it is set to false by the user.
static void	setMutualSslStatus(io.netty.channel.ChannelHandlerContext ctx, SSLEngine sslEngine)
static void	setSslHandshakeTimeOut(SSLConfig sslConfig, io.netty.handler.ssl.SslHandler sslHandler)
static void	setupChunkedRequest(HttpCarbonMessage httpOutboundRequest)
static void	setupContentLengthRequest(HttpCarbonMessage httpOutboundRequest, long contentLength)
static boolean	shouldEnforceChunkingforHttpOneZero(ChunkConfig chunkConfig, String httpVersion) Returns whether to enforce chunking on HTTP 1.0 requests.
static String	substituteVariables(String value) Replace system property holders in the property values.
static long	ticksInNanos()

Methods inherited from class java.lang.Object

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

Method Detail

createHttpResponse

public static io.netty.handler.codec.http.HttpResponse createHttpResponse(HttpCarbonMessage outboundResponseMsg,
                                                                          String inboundReqHttpVersion,
                                                                          String serverName,
                                                                          boolean keepAlive)

createFullHttpResponse

public static io.netty.handler.codec.http.HttpResponse createFullHttpResponse(HttpCarbonMessage outboundResponseMsg,
                                                                              String inboundReqHttpVersion,
                                                                              String serverName,
                                                                              boolean keepAlive,
                                                                              io.netty.buffer.ByteBuf fullContent)

getHttpResponseStatus

public static io.netty.handler.codec.http.HttpResponseStatus getHttpResponseStatus(HttpCarbonMessage msg)

createHttpRequest

public static io.netty.handler.codec.http.HttpRequest createHttpRequest(HttpCarbonMessage outboundRequestMsg)

setupChunkedRequest

public static void setupChunkedRequest(HttpCarbonMessage httpOutboundRequest)

createHttpRequestFromHttp2Headers

public static io.netty.handler.codec.http.HttpRequest createHttpRequestFromHttp2Headers(io.netty.handler.codec.http2.Http2Headers http2Headers,
                                                                                        int streamId)
                                                                                 throws io.netty.handler.codec.http2.Http2Exception

Creates a HttpRequest using a Http2Headers received over a particular HTTP/2 stream.

Parameters:

http2Headers - the Http2Headers received over a HTTP/2 stream

streamId - the stream id

Returns:

the HttpRequest formed using the HttpHeaders

Throws:

io.netty.handler.codec.http2.Http2Exception - if an error occurs while converting headers from HTTP/2 to HTTP

setupContentLengthRequest

public static void setupContentLengthRequest(HttpCarbonMessage httpOutboundRequest,
                                             long contentLength)

checkContentLengthAndTransferEncodingHeaderAllowance

public static boolean checkContentLengthAndTransferEncodingHeaderAllowance(HttpCarbonMessage httpOutboundRequest)

isVersionCompatibleForChunking

public static boolean isVersionCompatibleForChunking(String httpVersion)

Returns the status of chunking compatibility with http version.

Parameters:

httpVersion - http version string.

Returns:

boolean value of status.

shouldEnforceChunkingforHttpOneZero

public static boolean shouldEnforceChunkingforHttpOneZero(ChunkConfig chunkConfig,
                                                          String httpVersion)

Returns whether to enforce chunking on HTTP 1.0 requests.

Parameters:

chunkConfig - Chunking configuration.

httpVersion - http version string.

Returns:

true if chunking should be enforced else false.

configureHttpPipelineForSSL

public static SSLEngine configureHttpPipelineForSSL(io.netty.channel.socket.SocketChannel socketChannel,
                                                    String host,
                                                    int port,
                                                    SSLConfig sslConfig)
                                             throws SSLException

Configure outbound HTTP pipeline for SSL configuration.

Parameters:

socketChannel - Socket channel of outbound connection

sslConfig - SSLConfig

host - host of the connection

port - port of the connection

Returns:

the SSLEngine which enables secure communication

Throws:

SSLException - if any error occurs in the SSL connection

createInsecureSslEngineForHttp2

public static io.netty.handler.ssl.SslContext createInsecureSslEngineForHttp2()
                                                                       throws SSLException

Creates an insecure ssl engine for clients connecting over HTTP2

Returns:

insecure ssl context

Throws:

SSLException - if any error occurs in the SSL connection

getIntProperty

public static int getIntProperty(Map<String,Object> properties,
                                 String key,
                                 int defaultVal)

Get integer type property value from a property map.

If properties is null or property value is null, default value is returned

Parameters:

properties - map of properties

key - property name

defaultVal - default value of the property

Returns:

integer value of the property,

getStringProperty

public static String getStringProperty(Map<String,Object> properties,
                                       String key,
                                       String defaultVal)

Get string type property value from a property map.

If properties is null or property value is null, default value is returned

Parameters:

properties - map of properties

key - property name

defaultVal - default value of the property

Returns:

integer value of the property,

getBooleanProperty

public static Boolean getBooleanProperty(Map<String,Object> properties,
                                         String key,
                                         boolean defaultVal)

Get boolean type property value from a property map.

If properties is null or property value is null, default value is returned

Parameters:

properties - map of properties

key - property name

defaultVal - default value of the property

Returns:

integer value of the property,

getLongProperty

public static Long getLongProperty(Map<String,Object> properties,
                                   String key,
                                   long defaultVal)

Get long type property value from a property map.

If properties is null or property value is null, default value is returned

Parameters:

properties - map of properties

key - property name

defaultVal - default value of the property

Returns:

integer value of the property,

substituteVariables

public static String substituteVariables(String value)

Replace system property holders in the property values. e.g. Replace ${carbon.home} with value of the carbon.home system property.

Parameters:

value - string value to substitute

Returns:

String substituted string

createServerConnectorID

public static String createServerConnectorID(String host,
                                             int port)

Create ID for server connector.

Parameters:

host - host of the channel.

port - port of the channel.

Returns:

constructed ID for server connector.

resetChannelAttributes

public static void resetChannelAttributes(io.netty.channel.ChannelHandlerContext ctx)

Reset channel attributes.

Parameters:

ctx - Channel handler context

isLastHttpContent

public static boolean isLastHttpContent(io.netty.handler.codec.http.HttpContent httpContent)

Check if a given content is last httpContent.

Parameters:

httpContent - new content.

Returns:

true or false.

sendAndCloseNoEntityBodyResp

public static void sendAndCloseNoEntityBodyResp(io.netty.channel.ChannelHandlerContext ctx,
                                                io.netty.handler.codec.http.HttpResponseStatus status,
                                                io.netty.handler.codec.http.HttpVersion httpVersion,
                                                String serverName)

Send back no entity body response and close the connection. This function is mostly used when we send back error messages.

Parameters:

ctx - connection

status - response status

httpVersion - of the response

serverName - server name

checkForResponseWriteStatus

public static void checkForResponseWriteStatus(HttpCarbonMessage inboundRequestMsg,
                                               HttpResponseFuture outboundRespStatusFuture,
                                               io.netty.channel.ChannelFuture channelFuture)

Checks for status of the response write operation.

Parameters:

inboundRequestMsg - request message received from the client

outboundRespStatusFuture - the future of outbound response write operation

channelFuture - the channel future related to response write operation

addResponseWriteFailureListener

public static void addResponseWriteFailureListener(HttpResponseFuture outboundRespStatusFuture,
                                                   io.netty.channel.ChannelFuture channelFuture,
                                                   Http2OutboundRespListener http2OutboundRespListener)

Adds a listener to notify the outbound response future if an error occurs while writing the response message.

Parameters:

outboundRespStatusFuture - the future of outbound response write operation

channelFuture - the channel future related to response write operation

http2OutboundRespListener - the http/2 outbound response listener

createHTTPCarbonMessage

public static HttpCarbonMessage createHTTPCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage,
                                                        io.netty.channel.ChannelHandlerContext ctx)

Creates HTTP carbon message.

Parameters:

httpMessage - HTTP message

ctx - Channel handler context

Returns:

HttpCarbonMessage

safelyRemoveHandlers

public static void safelyRemoveHandlers(io.netty.channel.ChannelPipeline pipeline,
                                        String... handlerNames)

Removes handlers from the pipeline if they are present.

Parameters:

pipeline - the channel pipeline

handlerNames - names of the handlers to be removed

createInboundReqCarbonMsg

public static HttpCarbonMessage createInboundReqCarbonMsg(io.netty.handler.codec.http.HttpRequest httpRequestHeaders,
                                                          io.netty.channel.ChannelHandlerContext ctx,
                                                          SourceHandler sourceHandler)

Create a HttpCarbonMessage using the netty inbound http request.

Parameters:

httpRequestHeaders - of inbound request

ctx - of the inbound request

sourceHandler - instance which handled the particular request

Returns:

HttpCarbon message

createInboundRespCarbonMsg

public static HttpCarbonMessage createInboundRespCarbonMsg(io.netty.channel.ChannelHandlerContext ctx,
                                                           io.netty.handler.codec.http.HttpResponse httpResponseHeaders,
                                                           HttpCarbonMessage outboundRequestMsg)

Create a HttpCarbonMessage using the netty inbound response message.

Parameters:

ctx - of the inbound response message

httpResponseHeaders - of the inbound response message

outboundRequestMsg - is the correlated outbound request message

Returns:

HttpCarbon message

isKeepAlive

public static boolean isKeepAlive(KeepAliveConfig keepAliveConfig,
                                  HttpCarbonMessage outboundRequestMsg)
                           throws ConfigurationException

Check whether a connection should alive or not.

Parameters:

keepAliveConfig - of the connection

outboundRequestMsg - of this particular transaction

Returns:

true if the connection should be kept alive

Throws:

ConfigurationException - for invalid configurations

is100ContinueRequest

public static boolean is100ContinueRequest(HttpCarbonMessage inboundRequestMsg)

Check whether a particular request is expecting continue.

Parameters:

inboundRequestMsg - in question

Returns:

true if the request expects 100-continue response

isKeepAliveConnection

public static boolean isKeepAliveConnection(KeepAliveConfig keepAliveConfig,
                                            String requestConnectionHeader,
                                            String httpVersion)

Decide whether the connection should be kept open.

Parameters:

keepAliveConfig - Represents keepalive configuration

requestConnectionHeader - Connection header of the request

httpVersion - Represents HTTP version

Returns:

A boolean indicating whether to keep the connection open or not

setHostNameVerfication

public static void setHostNameVerfication(SSLEngine sslEngine)

Disable host name verification if it is set to false by the user.

Parameters:

sslEngine - ssl engine

getBackPressureHandler

public static BackPressureHandler getBackPressureHandler(io.netty.channel.ChannelHandlerContext channelContext)

Use this method to get the BackPressureHandler in the pipeline. This requires a ChannelHandlerContext of a handler in the pipeline.

Parameters:

channelContext - the channelContext which will be used to obtain the BackPressureHandler in the pipeline.

Returns:

The BackPressureHandler in the pipeline.

setBackPressureListener

public static void setBackPressureListener(HttpCarbonMessage outboundMessage,
                                           BackPressureHandler backpressureHandler,
                                           io.netty.channel.ChannelHandlerContext ctx)

Sets the backPressure listener the to the Observable of the handler.

Parameters:

outboundMessage - represents the outbound request or response

backpressureHandler - the handler that checks the writability

ctx - represents channel handler context

checkUnWritabilityAndNotify

public static void checkUnWritabilityAndNotify(io.netty.channel.ChannelHandlerContext context,
                                               BackPressureHandler backpressureHandler)

Checks if channel is unWritable and notifies BackPressure observable.

Parameters:

context - The context on which to check writablity.

backpressureHandler - The back pressure handler with the observable.

setSslHandshakeTimeOut

public static void setSslHandshakeTimeOut(SSLConfig sslConfig,
                                          io.netty.handler.ssl.SslHandler sslHandler)

ticksInNanos

public static long ticksInNanos()

schedule

public static ScheduledFuture<?> schedule(io.netty.channel.ChannelHandlerContext ctx,
                                          Runnable task,
                                          long delay)

setCorrelationIdForLogging

public static void setCorrelationIdForLogging(io.netty.channel.ChannelPipeline pipeline,
                                              io.netty.channel.ChannelInboundHandlerAdapter srcHandler)

handleOutboundConnectionHeader

public static void handleOutboundConnectionHeader(SenderConfiguration senderConfiguration,
                                                  HttpCarbonMessage httpOutboundRequest)

setForwardedExtension

public static void setForwardedExtension(ForwardedExtensionConfig forwardedConfig,
                                         String localAddress,
                                         HttpCarbonMessage httpOutboundRequest)

setMutualSslStatus

public static void setMutualSslStatus(io.netty.channel.ChannelHandlerContext ctx,
                                      SSLEngine sslEngine)

handleIncompleteMsgOnReset

public static void handleIncompleteMsgOnReset(Http2Reset http2Reset,
                                              int streamId,
                                              HttpCarbonMessage message)