Request (Micro Gateway - Java Interceptor 3.2.2 API)

java.lang.Object
- org.wso2.micro.gateway.interceptor.Request

```
public class Request
extends Object
```
Representation of ballerina http:Request object. Provide methods to do CRUD operations on the request object when writing gateway interceptors.

Constructor Summary

Constructors
Constructor and Description

Request(org.ballerinalang.jvm.values.ObjectValue requestObj)

Constructors
Constructor and Description
`Request(org.ballerinalang.jvm.values.ObjectValue requestObj)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHeader(String headerName, String headerValue)` Adds the specified header to the request.
`boolean`	`expects100Continue()` Checks whether the client expects a `100-continue` response.
`byte[]`	`getBinaryPayload()` Gets the request payload as a `byte[]`.
`Entity[]`	`getBodyParts()` Extracts body parts from the request.
`ByteChannel`	`getByteChannel()` Gets the request payload as a `ByteChannel` except in the case of multiparts.
`String`	`getContentType()` Gets the type of the payload of the request (i.e: the `content-type` header value).
`Entity`	`getEntity()`
`Entity`	`getEntityWithoutBody()`
`String`	`getHeader(String headerName)` Returns the value of the specified header.
`String[]`	`getHeaderNames()` Gets all the names of the headers of the request.
`String[]`	`getHeaders(String headerName)` Gets all the header values to which the specified header key maps to.
`org.json.JSONArray`	`getJsonArrayPayload()` Extracts `json array` payload from the request.
`org.json.JSONObject`	`getJsonPayload()` Extracts `json` payload from the request.
`Map<String,String>`	`getMatrixParams(String path)` Gets the matrix parameters of the request.
`org.ballerinalang.jvm.values.ObjectValue`	`getNativeRequestObject()` Returns the java native object of the ballerina level http:Request object.
`String`	`getPathInfo()` Gets the additional path information available in the request.
`Map<String,String>`	`getPathParams()` Gets the path parameters of the request as a map.
`Map<String,String>`	`getQueryParams()` Gets the query parameters of the request as a map.
`String`	`getQueryParamValue(String key)` Gets the query param value associated with the given key.
`String[]`	`getQueryParamValues(String key)` Gets all the query param values associated with the given key.
`String`	`getRequestHttpMethod()` Gets the requested resource http method.
`String`	`getRequestHttpVersion()` Gets the http version used for the request.
`String`	`getRequestPath()` Gets the requested resource path.
`String`	`getTextPayload()` Extracts `text` payload from the request.
`String`	`getUserAgent()` Gets the request user agent details.
`org.ballerinalang.jvm.values.api.BXML`	`getXmlPayload()` Extracts `xml` payload from the request.
`boolean`	`hasHeader(String headerName)` Checks whether the requested header key exists in the header map.
`void`	`removeAllHeaders()` Removes all the headers from the request.
`void`	`removeHeader(String headerName)` Removes the specified header from the request.
`void`	`setBinaryPayload(byte[] binaryPayload)` Sets a byte[] content as the payload.
`void`	`setBodyParts(Entity[] bodyParts, String contentType)` Set multiparts as the payload.
`void`	`setByteChannel(org.ballerinalang.stdlib.io.channels.base.Channel byteChannel, String contentType)` Set byte channel as the payload.
`void`	`setContentType(String contentType)` Sets the `content-type` header to the request.
`void`	`setEntity(Entity entity)`
`void`	`setHeader(String headerName, String headerValue)` Sets the specified header to the request.
`void`	`setJsonPayload(org.json.JSONArray jsonArrayPayload)` Sets a json array `JSONArray` as the payload to the request.
`void`	`setJsonPayload(org.json.JSONObject jsonPayload)` Sets a json `JSONObject` as the payload to the request.
`void`	`setTextPayload(String textPayload)` Sets a string text content as the payload.
`void`	`setXmlPayload(org.ballerinalang.jvm.values.api.BXML xmlPayload)` Sets a xml as the payload.

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

- Constructor Detail
  - Request
```
public Request(org.ballerinalang.jvm.values.ObjectValue requestObj)
```
- Method Detail
  - getRequestPath
```
public String getRequestPath()
```
    Gets the requested resource path.
    
    Returns:
    
    Resource path value as a string
  - getRequestHttpMethod
```
public String getRequestHttpMethod()
```
    Gets the requested resource http method.
    
    Returns:
    
    Resource http method as a string. For ex: POST
  - getRequestHttpVersion
```
public String getRequestHttpVersion()
```
    Gets the http version used for the request.
    
    Returns:
    
    Http version used for the request. For ex: 1.1 or 2.0
  - getPathInfo
```
public String getPathInfo()
```
    Gets the additional path information available in the request.
    
    Returns:
    
    Extra path information as a string
  - getUserAgent
```
public String getUserAgent()
```
    Gets the request user agent details.
    
    Returns:
    
    User agent header details as the string.
  - getPathParams
```
public Map<String,String> getPathParams()
```
    Gets the path parameters of the request as a map.
    
    Returns:
    
    Map Map of path parameters. Map with size 0 is returned if path parameters does not present.
  - getQueryParams
```
public Map<String,String> getQueryParams()
```
    Gets the query parameters of the request as a map.
    
    Returns:
    
    Map map containing query parameters.
  - getQueryParamValue
```
public String getQueryParamValue(String key)
```
    Gets the query param value associated with the given key.
    
    Parameters:
    
    key - Represents the query param key.
    
    Returns:
    
    Returns the query param value associated with the given key as a string. If multiple param values are present, then the first value is returned. Null is returned if no key is found.
  - getQueryParamValues
```
public String[] getQueryParamValues(String key)
```
    Gets all the query param values associated with the given key.
    
    Parameters:
    
    key - Represents the query param key.
    
    Returns:
    
    Returns all the query param values associated with the given key as a `String[]`. Null is returned if no key is found.
  - getMatrixParams
```
public Map<String,String> getMatrixParams(String path)
```
    Gets the matrix parameters of the request.
    
    Parameters:
    
    path - Path to the location of matrix parameters.
    
    Returns:
    
    A map value object MapValue of matrix parameters which can be found for the given path.
  - hasHeader
```
public boolean hasHeader(String headerName)
```
    Checks whether the requested header key exists in the header map.
    
    Parameters:
    
    headerName - The header name.
    
    Returns:
    
    Returns true if the specified header key exists
  - getHeader
```
public String getHeader(String headerName)
```
    Returns the value of the specified header. If the specified header key maps to multiple values, the first of these values is returned.
    
    Parameters:
    
    headerName - The header name.
    
    Returns:
    
    The first header value for the specified header name. Null is returned if header does not present.
  - getHeaders
```
public String[] getHeaders(String headerName)
```
    Gets all the header values to which the specified header key maps to.
    
    Parameters:
    
    headerName - The header name.
    
    Returns:
    
    The header values the specified header key maps to. Null is returned if header does not present.
  - setHeader
```
public void setHeader(String headerName,
                      String headerValue)
```
    Sets the specified header to the request. If a mapping already exists for the specified header key, the existing header value is replaced with the specified header value.
    
    Parameters:
    
    headerName - The header name.
    
    headerValue - The header value.
  - addHeader
```
public void addHeader(String headerName,
                      String headerValue)
```
    Adds the specified header to the request. Existing header values are not replaced.
    
    Parameters:
    
    headerName - The header name.
    
    headerValue - The header value.
  - removeHeader
```
public void removeHeader(String headerName)
```
    Removes the specified header from the request.
    
    Parameters:
    
    headerName - The header name.
  - removeAllHeaders
```
public void removeAllHeaders()
```
    Removes all the headers from the request.
  - getHeaderNames
```
public String[] getHeaderNames()
```
    Gets all the names of the headers of the request.
    
    Returns:
    
    An array of all the header names.
  - expects100Continue
```
public boolean expects100Continue()
```
    Checks whether the client expects a `100-continue` response.
    
    Returns:
    
    Returns true if the client expects a `100-continue` response.
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the `content-type` header to the request.
    
    Parameters:
    
    contentType - Content type value to be set as the `content-type` header.
  - getContentType
```
public String getContentType()
```
    Gets the type of the payload of the request (i.e: the `content-type` header value).
    
    Returns:
    
    Returns the `content-type` header value as a string. If not present returns empty string
  - getJsonPayload
```
public org.json.JSONObject getJsonPayload()
                                   throws InterceptorException
```
    Extracts `json` payload from the request. If the content type is not JSON, an exception will be thrown.
    
    Returns:
    
    The `json` JSONObject payload of the request. Null if json body is not found in the request.
    
    Throws:
    
    InterceptorException - If error while getting json payload.
  - getJsonArrayPayload
```
public org.json.JSONArray getJsonArrayPayload()
                                       throws InterceptorException
```
    Extracts `json array` payload from the request. If the content type is not JSON, an exception will be thrown.
    
    Returns:
    
    The `json` JSONArray payload of the request. Null if json body is not found in the request.
    
    Throws:
    
    InterceptorException - If error while getting json payload.
  - getXmlPayload
```
public org.ballerinalang.jvm.values.api.BXML getXmlPayload()
                                                    throws InterceptorException
```
    Extracts `xml` payload from the request. If the content type is not XML, an exception will be thrown.
    
    Returns:
    
    BXML The `xml` payload of the request.
    
    Throws:
    
    InterceptorException - If error while getting xml payload.
  - getTextPayload
```
public String getTextPayload()
                      throws InterceptorException
```
    Extracts `text` payload from the request. If the content type is not text, an exception will be thrown.
    
    Returns:
    
    The `text` payload of the request.
    
    Throws:
    
    InterceptorException - If error while getting text payload.
  - getByteChannel
```
public ByteChannel getByteChannel()
                           throws InterceptorException
```
    Gets the request payload as a `ByteChannel` except in the case of multiparts. To retrieve multiparts, use `Request.getBodyParts()`.
    
    Returns:
    
    ByteChannel A byte channel from which the message payload can be read.
    
    Throws:
    
    InterceptorException - If error while getting byte channel of the request.
  - getBinaryPayload
```
public byte[] getBinaryPayload()
                        throws InterceptorException
```
    Gets the request payload as a `byte[]`.
    
    Returns:
    
    The byte[] representation of the message payload
    
    Throws:
    
    InterceptorException - If error while getting byte array of the request.
  - getBodyParts
```
public Entity[] getBodyParts()
                      throws InterceptorException
```
    Extracts body parts from the request. If the content type is not a composite media type, an exception is thrown.
    
    Returns:
    
    Returns the body parts as an array of entities.
    
    Throws:
    
    InterceptorException - if there were any errors constructing the body parts from the request.
  - setJsonPayload
```
public void setJsonPayload(org.json.JSONObject jsonPayload)
```
    Sets a json JSONObject as the payload to the request.
    
    Parameters:
    
    jsonPayload - JSONObject The json payload.
  - setJsonPayload
```
public void setJsonPayload(org.json.JSONArray jsonArrayPayload)
```
    Sets a json array JSONArray as the payload to the request.
    
    Parameters:
    
    jsonArrayPayload - JSONArray The json array payload.
  - setXmlPayload
```
public void setXmlPayload(org.ballerinalang.jvm.values.api.BXML xmlPayload)
```
    Sets a xml as the payload.
    
    Parameters:
    
    xmlPayload - The xml BXML payload.
  - setTextPayload
```
public void setTextPayload(String textPayload)
```
    Sets a string text content as the payload.
    
    Parameters:
    
    textPayload - The text payload.
  - setBinaryPayload
```
public void setBinaryPayload(byte[] binaryPayload)
```
    Sets a byte[] content as the payload.
    
    Parameters:
    
    binaryPayload - The byte[] payload.
  - setBodyParts
```
public void setBodyParts(Entity[] bodyParts,
                         String contentType)
```
    Set multiparts as the payload.
    
    Parameters:
    
    bodyParts - The entities which make up the message body
    
    contentType - The content type of the top level message. Set this to override the default `content-type` header value which is 'multipart/form-data'
  - setByteChannel
```
public void setByteChannel(org.ballerinalang.stdlib.io.channels.base.Channel byteChannel,
                           String contentType)
```
    Set byte channel as the payload.
    
    Parameters:
    
    byteChannel - Channel Channel object which contains the payload data.
    
    contentType - The content type of the top level message. Set this to override the default `content-type` header value which is 'application/octet-stream'
  - getNativeRequestObject
```
public org.ballerinalang.jvm.values.ObjectValue getNativeRequestObject()
```
    Returns the java native object of the ballerina level http:Request object.
    
    Returns:
    
    Native ballerina object ObjectValue representing the request.
  - setEntity
```
public void setEntity(Entity entity)
```
  - getEntityWithoutBody
```
public Entity getEntityWithoutBody()
```
  - getEntity
```
public Entity getEntity()
```

Class Request

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Request

Method Detail

getRequestPath

getRequestHttpMethod

getRequestHttpVersion

getPathInfo

getUserAgent

getPathParams

getQueryParams

getQueryParamValue

getQueryParamValues

getMatrixParams

hasHeader

getHeader

getHeaders

setHeader

addHeader

removeHeader

removeAllHeaders

getHeaderNames

expects100Continue

setContentType

getContentType

getJsonPayload

getJsonArrayPayload

getXmlPayload

getTextPayload

getByteChannel

getBinaryPayload

getBodyParts

setJsonPayload

setJsonPayload

setXmlPayload

setTextPayload

setBinaryPayload

setBodyParts

setByteChannel

getNativeRequestObject

setEntity

getEntityWithoutBody

getEntity