Response (Micro Gateway - Java Interceptor 3.2.2 API)

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

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

Constructor Summary

Constructors
Constructor and Description

Response()

Response(org.ballerinalang.jvm.values.ObjectValue responseObj)

Constructors
Constructor and Description
`Response()`
`Response(org.ballerinalang.jvm.values.ObjectValue responseObj)`

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 response.
`byte[]`	`getBinaryPayload()` Gets the response payload as a `byte[]`.
`Entity[]`	`getBodyParts()` Extracts body parts from the response.
`ByteChannel`	`getByteChannel()` Gets the response payload as a `ByteChannel` except in the case of multiparts.
`String`	`getContentType()` Gets the type of the payload of the response (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 response.
`org.json.JSONObject`	`getJsonPayload()` Extracts `json` payload from the response.
`org.ballerinalang.jvm.values.ObjectValue`	`getNativeRequestObject()` Returns the java native object of the ballerina level http:Response object.
`String`	`getResolvedRequestedURI()` Get the ultimate request URI that was made to receive the response when redirect is on.
`long`	`getResponseCode()` Get the http status code of the response.
`protected org.ballerinalang.jvm.values.ObjectValue`	`getResponseObjectValue()`
`String`	`getTextPayload()` Extracts `text` payload from the response.
`org.ballerinalang.jvm.values.api.BXML`	`getXmlPayload()` Extracts `xml` payload from the response.
`boolean`	`hasHeader(String headerName)` Checks whether the requested header key exists in the header map.
`void`	`removeAllHeaders()` Removes all the headers from the response.
`void`	`removeHeader(String headerName)` Removes the specified header from the response.
`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 response.
`void`	`setEntity(Entity entity)`
`void`	`setHeader(String headerName, String headerValue)` Sets the specified header to the response.
`void`	`setJsonPayload(org.json.JSONArray jsonArrayPayload)` Sets a json array as the payload.
`void`	`setJsonPayload(org.json.JSONObject jsonPayload)` Sets a json as the payload.
`void`	`setResponseCode(long statusCode)` Set the http status code for the response.
`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
  - Response
```
public Response(org.ballerinalang.jvm.values.ObjectValue responseObj)
```
  - Response
```
public Response()
```
- Method Detail
  - getResponseCode
```
public long getResponseCode()
```
    Get the http status code of the response. For ex: 200.
    
    Returns:
    
    Returns http status code as a long value.
  - setResponseCode
```
public void setResponseCode(long statusCode)
```
    Set the http status code for the response. For ex: 200.
    
    Parameters:
    
    statusCode - The status code to be set for the http response.
  - getResolvedRequestedURI
```
public String getResolvedRequestedURI()
```
    Get the ultimate request URI that was made to receive the response when redirect is on.
    
    Returns:
    
    the requested URI
  - 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.
  - addHeader
```
public void addHeader(String headerName,
                      String headerValue)
```
    Adds the specified header to the response. Existing header values are not replaced.
    
    Parameters:
    
    headerName - The header name.
    
    headerValue - The header value.
  - 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 response. 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.
  - removeHeader
```
public void removeHeader(String headerName)
```
    Removes the specified header from the response.
    
    Parameters:
    
    headerName - The header name.
  - removeAllHeaders
```
public void removeAllHeaders()
```
    Removes all the headers from the response.
  - getHeaderNames
```
public String[] getHeaderNames()
```
    Gets all the names of the headers of the request.
    
    Returns:
    
    An array of all the header names.
  - setContentType
```
public void setContentType(String contentType)
```
    Sets the `content-type` header to the response.
    
    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 response (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 response. 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 response.
    
    Throws:
    
    InterceptorException - If error while getting json payload.
  - getJsonArrayPayload
```
public org.json.JSONArray getJsonArrayPayload()
                                       throws InterceptorException
```
    Extracts `json array` payload from the response. 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 response.
    
    Throws:
    
    InterceptorException - If error while getting json array payload.
  - getXmlPayload
```
public org.ballerinalang.jvm.values.api.BXML getXmlPayload()
                                                    throws InterceptorException
```
    Extracts `xml` payload from the response. If the content type is not XML, an exception will be thrown.
    
    Returns:
    
    BXML The `xml` payload of the response.
    
    Throws:
    
    InterceptorException - If error while getting xml payload.
  - getTextPayload
```
public String getTextPayload()
                      throws InterceptorException
```
    Extracts `text` payload from the response. If the content type is not text, an exception will be thrown.
    
    Returns:
    
    The `text` payload of the response.
    
    Throws:
    
    InterceptorException - If error while getting text payload.
  - getByteChannel
```
public ByteChannel getByteChannel()
                           throws InterceptorException
```
    Gets the response 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 response 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 response. 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 reponse.
  - 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.
  - setJsonPayload
```
public void setJsonPayload(org.json.JSONObject jsonPayload)
```
    Sets a json as the payload.
    
    Parameters:
    
    jsonPayload - JSONObject The json payload.
  - setJsonPayload
```
public void setJsonPayload(org.json.JSONArray jsonArrayPayload)
```
    Sets a json array as the payload.
    
    Parameters:
    
    jsonArrayPayload - JSONArray The json payload.
  - setXmlPayload
```
public void setXmlPayload(org.ballerinalang.jvm.values.api.BXML xmlPayload)
```
    Sets a xml as the payload.
    
    Parameters:
    
    xmlPayload - The xml BXML 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:Response object.
    
    Returns:
    
    Native ballerina object ObjectValue representing the response.
  - setEntity
```
public void setEntity(Entity entity)
```
  - getResponseObjectValue
```
protected org.ballerinalang.jvm.values.ObjectValue getResponseObjectValue()
```
  - getEntityWithoutBody
```
public Entity getEntityWithoutBody()
```
  - getEntity
```
public Entity getEntity()
```

Class Response

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Response

Response

Method Detail

getResponseCode

setResponseCode

getResolvedRequestedURI

hasHeader

getHeader

addHeader

getHeaders

setHeader

removeHeader

removeAllHeaders

getHeaderNames

setContentType

getContentType

getJsonPayload

getJsonArrayPayload

getXmlPayload

getTextPayload

getByteChannel

getBinaryPayload

getBodyParts

setTextPayload

setBinaryPayload

setJsonPayload

setJsonPayload

setXmlPayload

setBodyParts

setByteChannel

getNativeRequestObject

setEntity

getResponseObjectValue

getEntityWithoutBody

getEntity