HttpCarbonMessage (WSO2 Transport HTTP Netty Component 6.3.24 API)

java.lang.Object
- org.wso2.transport.http.netty.message.HttpCarbonMessage

Direct Known Subclasses:

HttpCarbonRequest, HttpCarbonResponse
```
public class HttpCarbonMessage
extends Object
```
HTTP based representation for HttpCarbonMessage.

Field Summary

Fields
Modifier and Type Field and Description

protected io.netty.handler.codec.http.HttpMessage httpMessage

ListenerReqRespStateManager listenerReqRespStateManager

Fields
Modifier and Type	Field and Description
`protected io.netty.handler.codec.http.HttpMessage`	`httpMessage`
`ListenerReqRespStateManager`	`listenerReqRespStateManager`

Constructor Summary

Constructors
Constructor and Description
`HttpCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage)`
`HttpCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage, int maxWaitTime, Listener contentListener)`
`HttpCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage, Listener contentListener)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addHttpContent(io.netty.handler.codec.http.HttpContent httpContent)` Add http content to HttpCarbonMessage.
`void`	`addMessageBody(ByteBuffer msgBody)` Deprecated.
`HttpCarbonMessage`	`cloneCarbonMessageWithOutData()` Copy Message properties and transport headers.
`void`	`completeMessage()`
`long`	`countMessageLengthTill(long maxLength)` Count the message length till the given message length and returns.
`EntityCollector`	`getBlockingEntityCollector()`
`FullHttpMessageFuture`	`getFullHttpCarbonMessage()` Returns the `FullHttpMessageFuture` which notifies `FullHttpMessageListener` when the complete content of the `HttpCarbonMessage` is accumulated.
`long`	`getFullMessageLength()` Deprecated.
`String`	`getHeader(String key)` Return the value of the given header name.
`io.netty.handler.codec.http.HttpHeaders`	`getHeaders()` Returns the header map of the request.
`Http2MessageStateContext`	`getHttp2MessageStateContext()`
`io.netty.handler.codec.http.HttpContent`	`getHttpContent()` Get the available content of HttpCarbonMessage.
`MessageFuture`	`getHttpContentAsync()`
`String`	`getHttpMethod()`
`HttpResponseFuture`	`getHttpOutboundRespStatusFuture()` Returns the future responsible for notifying the response status.
`ServerConnectorFuture`	`getHttpResponseFuture()` Returns the future responsible for sending back the response.
`Integer`	`getHttpStatusCode()`
`String`	`getHttpVersion()`
`IOException`	`getIoException()`
`Listener`	`getListener()`
`io.netty.buffer.ByteBuf`	`getMessageBody()` Deprecated.
`io.netty.handler.codec.http.HttpRequest`	`getNettyHttpRequest()` Gives the underling netty request message.
`io.netty.handler.codec.http.HttpResponse`	`getNettyHttpResponse()` Gives the underling netty response message.
`HttpPipeliningFuture`	`getPipeliningFuture()`
`Map<String,Object>`	`getProperties()`
`Object`	`getProperty(String key)`
`String`	`getReasonPhrase()`
`String`	`getRequestUrl()`
`long`	`getSequenceId()`
`io.netty.channel.ChannelHandlerContext`	`getSourceContext()`
`io.netty.channel.ChannelHandlerContext`	`getTargetContext()`
`io.netty.handler.codec.http.HttpHeaders`	`getTrailerHeaders()` Returns the trailer header map of the message.
`boolean`	`is100ContinueExpected()` Can be used to detect if a request is expecting 100 continue.
`boolean`	`isEmpty()` Check if the payload empty.
`boolean`	`isKeepAlive()`
`boolean`	`isPassthrough()` The passthrough(when message body is not built) status of the message.
`boolean`	`isPipeliningEnabled()`
`boolean`	`isStreaming()`
`void`	`notifyContentFailure(Exception exception)` Notifies `FullHttpMessageListener` if the content accumulation fails.
`HttpResponseFuture`	`pushPromise(Http2PushPromise pushPromise)` Sends a push promise message back to the client.
`HttpResponseFuture`	`pushResponse(HttpCarbonMessage httpCarbonMessage, Http2PushPromise pushPromise)` Sends a push response message back to the client.
`void`	`removeHeader(String key)` Remove the header using header name.
`void`	`removeInboundContentListener()` Removes the content listener that is set for handling inbound throttling in case of HTTP/1.1.
`void`	`removeMessageFuture()`
`void`	`removeProperty(String key)`
`HttpResponseFuture`	`respond(HttpCarbonMessage httpCarbonMessage)`
`void`	`setHeader(String key, Object value)` Set the header value for the given name.
`void`	`setHeader(String key, String value)` Set the header value for the given name.
`void`	`setHeaders(io.netty.handler.codec.http.HttpHeaders httpHeaders)` Let you set a set of headers.
`void`	`setHttp2MessageStateContext(Http2MessageStateContext http2MessageStateContext)`
`void`	`setHttpMethod(String httpMethod)`
`void`	`setHttpStatusCode(Integer httpStatusCode)`
`void`	`setHttpVersion(String httpVersion)`
`void`	`setIoException(IOException ioException)`
`void`	`setKeepAlive(boolean keepAlive)`
`void`	`setLastHttpContentArrived()` Sets the lastHttpContentArrived flag true upon the last HTTP content arrival and notifies the `FullHttpMessageFuture` if available.
`void`	`setPassthrough(boolean passthrough)` This value is to be set when sending the message to the consumer without building/processing it in the application layer.
`void`	`setPipeliningEnabled(boolean pipeliningEnabled)`
`void`	`setPipeliningFuture(HttpPipeliningFuture pipeliningFuture)` Sets the pipelining future to the outbound response.
`void`	`setProperty(String key, Object value)`
`void`	`setRequestUrl(String requestUrl)`
`void`	`setSequenceId(long sequenceId)`
`void`	`setSourceContext(io.netty.channel.ChannelHandlerContext sourceContext)` Set the source context.
`void`	`setStreaming(boolean streaming)`
`void`	`setTargetContext(io.netty.channel.ChannelHandlerContext targetContext)`
`void`	`waitAndReleaseAllEntities()` Wait till the entire payload is received.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - httpMessage
```
protected io.netty.handler.codec.http.HttpMessage httpMessage
```
  - listenerReqRespStateManager
```
public ListenerReqRespStateManager listenerReqRespStateManager
```
- Constructor Detail
  - HttpCarbonMessage
```
public HttpCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage,
                         Listener contentListener)
```
  - HttpCarbonMessage
```
public HttpCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage,
                         int maxWaitTime,
                         Listener contentListener)
```
  - HttpCarbonMessage
```
public HttpCarbonMessage(io.netty.handler.codec.http.HttpMessage httpMessage)
```
- Method Detail
  - addHttpContent
```
public void addHttpContent(io.netty.handler.codec.http.HttpContent httpContent)
```
    Add http content to HttpCarbonMessage.
    
    Parameters:
    
    httpContent - chunks of the payload.
  - getHttpContent
```
public io.netty.handler.codec.http.HttpContent getHttpContent()
```
    Get the available content of HttpCarbonMessage.
    
    Returns:
    
    HttpContent.
  - getHttpContentAsync
```
public MessageFuture getHttpContentAsync()
```
  - getMessageBody
```
@Deprecated
public io.netty.buffer.ByteBuf getMessageBody()
```
    Deprecated.
    
    Returns:
    
    the message body.
  - isEmpty
```
public boolean isEmpty()
```
    Check if the payload empty.
    
    Returns:
    
    true or false.
  - countMessageLengthTill
```
public long countMessageLengthTill(long maxLength)
                            throws IllegalStateException
```
    Count the message length till the given message length and returns. If the message length is shorter than the given length it returns with the available message size. This method is blocking function. Hence, use with care.
    
    Parameters:
    
    maxLength - is the maximum length to count
    
    Returns:
    
    counted length
    
    Throws:
    
    IllegalStateException - if illegal state occurs in the absence of content
  - getFullMessageLength
```
@Deprecated
public long getFullMessageLength()
```
    Deprecated.
    
    Return the length of entire payload. This is a blocking method.
    
    Returns:
    
    the length.
  - addMessageBody
```
@Deprecated
public void addMessageBody(ByteBuffer msgBody)
```
    Deprecated.
    
    Parameters:
    
    msgBody - the message body.
  - completeMessage
```
public void completeMessage()
```
  - getHeaders
```
public io.netty.handler.codec.http.HttpHeaders getHeaders()
```
    Returns the header map of the request.
    
    Returns:
    
    all headers.
  - getHeader
```
public String getHeader(String key)
```
    Return the value of the given header name.
    
    Parameters:
    
    key - name of the header.
    
    Returns:
    
    value of the header.
  - setHeader
```
public void setHeader(String key,
                      String value)
```
    Set the header value for the given name.
    
    Parameters:
    
    key - header name.
    
    value - header value.
  - setHeader
```
public void setHeader(String key,
                      Object value)
```
    Set the header value for the given name.
    
    Parameters:
    
    key - header name.
    
    value - header value as object.
  - setHeaders
```
public void setHeaders(io.netty.handler.codec.http.HttpHeaders httpHeaders)
```
    Let you set a set of headers.
    
    Parameters:
    
    httpHeaders - set of headers that needs to be set.
  - removeHeader
```
public void removeHeader(String key)
```
    Remove the header using header name.
    
    Parameters:
    
    key - header name.
  - getTrailerHeaders
```
public io.netty.handler.codec.http.HttpHeaders getTrailerHeaders()
```
    Returns the trailer header map of the message. Dev should use this API to set/get trailer headers rather dealing with LastHttpContent.
    
    Returns:
    
    all trailer headers.
  - getProperty
```
public Object getProperty(String key)
```
  - removeMessageFuture
```
public void removeMessageFuture()
```
  - getProperties
```
public Map<String,Object> getProperties()
```
  - setProperty
```
public void setProperty(String key,
                        Object value)
```
  - removeProperty
```
public void removeProperty(String key)
```
  - getHttpVersion
```
public String getHttpVersion()
```
  - setHttpVersion
```
public void setHttpVersion(String httpVersion)
```
  - getHttpMethod
```
public String getHttpMethod()
```
  - setHttpMethod
```
public void setHttpMethod(String httpMethod)
```
  - getRequestUrl
```
public String getRequestUrl()
```
  - setRequestUrl
```
public void setRequestUrl(String requestUrl)
```
  - getHttpStatusCode
```
public Integer getHttpStatusCode()
```
  - setHttpStatusCode
```
public void setHttpStatusCode(Integer httpStatusCode)
```
  - getReasonPhrase
```
public String getReasonPhrase()
```
  - getHttpResponseFuture
```
public ServerConnectorFuture getHttpResponseFuture()
```
    Returns the future responsible for sending back the response.
    
    Returns:
    
    httpOutboundRespFuture.
  - getHttpOutboundRespStatusFuture
```
public HttpResponseFuture getHttpOutboundRespStatusFuture()
```
    Returns the future responsible for notifying the response status.
    
    Returns:
    
    httpOutboundRespStatusFuture.
  - respond
```
public HttpResponseFuture respond(HttpCarbonMessage httpCarbonMessage)
                           throws ServerConnectorException
```
    Throws:
    
    ServerConnectorException
  - pushResponse
```
public HttpResponseFuture pushResponse(HttpCarbonMessage httpCarbonMessage,
                                       Http2PushPromise pushPromise)
                                throws ServerConnectorException
```
    Sends a push response message back to the client.
    
    Parameters:
    
    httpCarbonMessage - the push response message
    
    pushPromise - the push promise associated with the push response message
    
    Returns:
    
    HttpResponseFuture which gives the status of the operation
    
    Throws:
    
    ServerConnectorException - if there is an error occurs while doing the operation
  - pushPromise
```
public HttpResponseFuture pushPromise(Http2PushPromise pushPromise)
                               throws ServerConnectorException
```
    Sends a push promise message back to the client.
    
    Parameters:
    
    pushPromise - the push promise message
    
    Returns:
    
    HttpResponseFuture which gives the status of the operation
    
    Throws:
    
    ServerConnectorException - if there is an error occurs while doing the operation
  - cloneCarbonMessageWithOutData
```
public HttpCarbonMessage cloneCarbonMessageWithOutData()
```
    Copy Message properties and transport headers.
    
    Returns:
    
    HttpCarbonMessage.
  - waitAndReleaseAllEntities
```
public void waitAndReleaseAllEntities()
```
    Wait till the entire payload is received. This is important to avoid data corruption. Before a set a new set of payload, we need remove the existing ones.
  - getBlockingEntityCollector
```
public EntityCollector getBlockingEntityCollector()
```
  - getNettyHttpRequest
```
public io.netty.handler.codec.http.HttpRequest getNettyHttpRequest()
```
    Gives the underling netty request message.
    
    Returns:
    
    netty request message
  - getNettyHttpResponse
```
public io.netty.handler.codec.http.HttpResponse getNettyHttpResponse()
```
    Gives the underling netty response message.
    
    Returns:
    
    netty response message
  - getIoException
```
public IOException getIoException()
```
  - setIoException
```
public void setIoException(IOException ioException)
```
  - getHttp2MessageStateContext
```
public Http2MessageStateContext getHttp2MessageStateContext()
```
  - setHttp2MessageStateContext
```
public void setHttp2MessageStateContext(Http2MessageStateContext http2MessageStateContext)
```
  - getSequenceId
```
public long getSequenceId()
```
  - setSequenceId
```
public void setSequenceId(long sequenceId)
```
  - getSourceContext
```
public io.netty.channel.ChannelHandlerContext getSourceContext()
```
  - setSourceContext
```
public void setSourceContext(io.netty.channel.ChannelHandlerContext sourceContext)
```
    Set the source context. This is needed only for pipelining and HTTP/1.1 throttling.
    
    Parameters:
    
    sourceContext - represent the source context
  - isKeepAlive
```
public boolean isKeepAlive()
```
  - setKeepAlive
```
public void setKeepAlive(boolean keepAlive)
```
  - isPipeliningEnabled
```
public boolean isPipeliningEnabled()
```
  - isStreaming
```
public boolean isStreaming()
```
  - setStreaming
```
public void setStreaming(boolean streaming)
```
  - is100ContinueExpected
```
public boolean is100ContinueExpected()
```
    Can be used to detect if a request is expecting 100 continue.
    
    Returns:
    
    true if the request is expecting 100 continue
  - setPipeliningEnabled
```
public void setPipeliningEnabled(boolean pipeliningEnabled)
```
  - getPipeliningFuture
```
public HttpPipeliningFuture getPipeliningFuture()
```
  - setPipeliningFuture
```
public void setPipeliningFuture(HttpPipeliningFuture pipeliningFuture)
```
    Sets the pipelining future to the outbound response. This method's only usage is in ballerina side, hence it should not be removed.
    
    Parameters:
    
    pipeliningFuture - Represents pipelining future which is used for binding pipelining listener
  - removeInboundContentListener
```
public void removeInboundContentListener()
```
    Removes the content listener that is set for handling inbound throttling in case of HTTP/1.1. For HTTP/2, flow control cannot be disabled (https://tools.ietf.org/html/rfc7540#page-23). To prevent HTTP/2 streams from stalling, receiver must aggressively update the window size kept by the sender, hence listener should not be removed for HTTP/2.
  - isPassthrough
```
public boolean isPassthrough()
```
    The passthrough(when message body is not built) status of the message.
    
    Returns:
    
    true if it is a passthrough.
  - setPassthrough
```
public void setPassthrough(boolean passthrough)
```
    This value is to be set when sending the message to the consumer without building/processing it in the application layer.
    
    Parameters:
    
    passthrough - if the message is a passthrough.
  - setTargetContext
```
public void setTargetContext(io.netty.channel.ChannelHandlerContext targetContext)
```
    Parameters:
    
    targetContext - The target handler context.
  - getTargetContext
```
public io.netty.channel.ChannelHandlerContext getTargetContext()
```
    Returns:
    
    the target handler context for this message.
  - getFullHttpCarbonMessage
```
public FullHttpMessageFuture getFullHttpCarbonMessage()
```
    Returns the FullHttpMessageFuture which notifies FullHttpMessageListener when the complete content of the HttpCarbonMessage is accumulated. Should never remove content listener for HTTP/2.
    
    Returns:
    
    the default implementation of the FullHttpMessageFuture.
  - setLastHttpContentArrived
```
public void setLastHttpContentArrived()
```
    Sets the lastHttpContentArrived flag true upon the last HTTP content arrival and notifies the FullHttpMessageFuture if available.
  - notifyContentFailure
```
public void notifyContentFailure(Exception exception)
```
    Notifies FullHttpMessageListener if the content accumulation fails.
    
    Parameters:
    
    exception - of content accumulation
  - getListener
```
public Listener getListener()
```

Class HttpCarbonMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

httpMessage

listenerReqRespStateManager

Constructor Detail

HttpCarbonMessage

HttpCarbonMessage

HttpCarbonMessage

Method Detail

addHttpContent

getHttpContent

getHttpContentAsync

getMessageBody

isEmpty

countMessageLengthTill

getFullMessageLength

addMessageBody

completeMessage

getHeaders

getHeader

setHeader

setHeader

setHeaders

removeHeader

getTrailerHeaders

getProperty

removeMessageFuture

getProperties

setProperty

removeProperty

getHttpVersion

setHttpVersion

getHttpMethod

setHttpMethod

getRequestUrl

setRequestUrl

getHttpStatusCode

setHttpStatusCode

getReasonPhrase

getHttpResponseFuture

getHttpOutboundRespStatusFuture

respond

pushResponse

pushPromise

cloneCarbonMessageWithOutData

waitAndReleaseAllEntities

getBlockingEntityCollector

getNettyHttpRequest

getNettyHttpResponse

getIoException

setIoException

getHttp2MessageStateContext

setHttp2MessageStateContext

getSequenceId

setSequenceId

getSourceContext

setSourceContext

isKeepAlive

setKeepAlive

isPipeliningEnabled

isStreaming

setStreaming

is100ContinueExpected

setPipeliningEnabled

getPipeliningFuture

setPipeliningFuture

removeInboundContentListener

isPassthrough

setPassthrough

setTargetContext

getTargetContext

getFullHttpCarbonMessage

setLastHttpContentArrived

notifyContentFailure

getListener