Entity (Micro Gateway - Java Interceptor 3.2.2 API)

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

```
public class Entity
extends Object
```
Represents the headers and body of a message. This can be used to represent both the entity of a top level message and an entity(body part) inside of a multipart entity.

Constructor Summary

Constructors
Constructor and Description

Entity()

Entity(org.ballerinalang.jvm.values.ObjectValue entity)

Constructors
Constructor and Description
`Entity()`
`Entity(org.ballerinalang.jvm.values.ObjectValue entity)`

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 entity.
`Entity[]`	`getBodyParts()` Given an entity, gets its body parts.
`byte[]`	`getByteArray()` Gets the entity payload as a `byte[]`.
`ByteChannel`	`getByteChannel()` Given an entity, gets the entity body as a byte channel.
`org.ballerinalang.jvm.values.ObjectValue`	`getEntityObj()` Returns the java native object of the ballerina level mime:Entity object.
`String`	`getHeader(String headerName)` Returns the value of the specified header.
`String[]`	`getHeaderNames()` Gets all the names of the headers of the entity.
`String[]`	`getHeaders(String headerName)` Gets all the header values to which the specified header key maps to.
`org.json.JSONObject`	`getJson()` Extracts `json` payload from the entity.
`org.json.JSONArray`	`getJsonArray()` Extracts `json array` payload from the entity.
`String`	`getText()` Extracts `text` payload from the entity.
`org.ballerinalang.jvm.values.api.BXML`	`getXml()` Extracts `xml` payload from the entity.
`boolean`	`hasHeader(String headerName)` Checks whether the requested header key exists in the header map.
`void`	`removeAllHeaders()` Removes all the headers from the entity.
`void`	`removeHeader(String headerName)` Removes the specified header from the entity.
`void`	`setBinary(byte[] binaryPayload)` Sets a byte[] content to the entity.
`void`	`setBodyParts(Entity[] bodyParts, String contentType)` Set multiparts as the payload.
`void`	`setByteChannel(org.ballerinalang.stdlib.io.channels.base.Channel channel, String contentType)` Sets a `ByteChannel` to the entity.
`void`	`setHeader(String headerName, String headerValue)` Sets the specified header to the entity.
`void`	`setJson(org.json.JSONArray jsonArrayPayload)` Sets a json array`JSONArray` as the payload to the entity.
`void`	`setJson(org.json.JSONObject jsonPayload)` Sets a json `JSONObject` as the payload to the entity.
`void`	`setText(String textPayload)` Sets a string text content to the entity.
`void`	`setXml(org.ballerinalang.jvm.values.api.BXML xmlPayload)` Sets a xml to the entity.

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

- Constructor Detail
  - Entity
```
public Entity(org.ballerinalang.jvm.values.ObjectValue entity)
```
  - Entity
```
public Entity()
```
- Method Detail
  - 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 entity. 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 entity. 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 entity.
    
    Parameters:
    
    headerName - The header name.
  - removeAllHeaders
```
public void removeAllHeaders()
```
    Removes all the headers from the entity.
  - getHeaderNames
```
public String[] getHeaderNames()
```
    Gets all the names of the headers of the entity. If headers are not present returns an empty array.
    
    Returns:
    
    An array of all the header names.
  - getJson
```
public org.json.JSONObject getJson()
                            throws InterceptorException
```
    Extracts `json` payload from the entity. If the content type is not JSON, an exception will be thrown.
    
    Returns:
    
    The `json` payload of the request.
    
    Throws:
    
    InterceptorException - If error while getting json payload.
  - getJsonArray
```
public org.json.JSONArray getJsonArray()
                                throws InterceptorException
```
    Extracts `json array` payload from the entity. If the content type is not JSON, an exception will be thrown.
    
    Returns:
    
    The `json array` payload of the request.
    
    Throws:
    
    InterceptorException - If error while getting json payload.
  - getXml
```
public org.ballerinalang.jvm.values.api.BXML getXml()
                                             throws InterceptorException
```
    Extracts `xml` payload from the entity. 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.
  - getText
```
public String getText()
               throws InterceptorException
```
    Extracts `text` payload from the entity. 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
```
    Given an entity, gets the entity body as a byte channel.
    
    Returns:
    
    ByteChannel A byte channel from which the message payload can be read.
    
    Throws:
    
    InterceptorException - If error while getting byte channel of the entity.
  - getByteArray
```
public byte[] getByteArray()
                    throws InterceptorException
```
    Gets the entity payload as a `byte[]`.
    
    Returns:
    
    The byte[] representation of the message payload
    
    Throws:
    
    InterceptorException - If error while getting byte array of the entity.
  - getBodyParts
```
public Entity[] getBodyParts()
                      throws InterceptorException
```
    Given an entity, gets its body parts. If the entity body is not a set of body parts an exception will be thrown.
    
    Returns:
    
    An array of body partsEntity[] extracted from the entity body
    
    Throws:
    
    InterceptorException - If error while getting byte array of the entity.
  - setJson
```
public void setJson(org.json.JSONObject jsonPayload)
```
    Sets a json JSONObject as the payload to the entity.
    
    Parameters:
    
    jsonPayload - JSONObject The json payload.
  - setJson
```
public void setJson(org.json.JSONArray jsonArrayPayload)
```
    Sets a json arrayJSONArray as the payload to the entity.
    
    Parameters:
    
    jsonArrayPayload - JSONArray The json payload.
  - setXml
```
public void setXml(org.ballerinalang.jvm.values.api.BXML xmlPayload)
```
    Sets a xml to the entity.
    
    Parameters:
    
    xmlPayload - The xml BXML payload.
  - setText
```
public void setText(String textPayload)
```
    Sets a string text content to the entity.
    
    Parameters:
    
    textPayload - The text payload.
  - setBinary
```
public void setBinary(byte[] binaryPayload)
```
    Sets a byte[] content to the entity.
    
    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 channel,
                           String contentType)
```
    Sets a `ByteChannel` to the entity.
    
    Parameters:
    
    channel - - A `ByteChannel` Channel through which the message payload can be read
    
    contentType - The content type of the top level message. Set this to override the default `content-type` header value which is 'application/octet-stream'
  - getEntityObj
```
public org.ballerinalang.jvm.values.ObjectValue getEntityObj()
```
    Returns the java native object of the ballerina level mime:Entity object.
    
    Returns:
    
    Native ballerina object ObjectValue representing the entity.

Class Entity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Entity

Entity

Method Detail

hasHeader

getHeader

getHeaders

setHeader

addHeader

removeHeader

removeAllHeaders

getHeaderNames

getJson

getJsonArray

getXml

getText

getByteChannel

getByteArray

getBodyParts

setJson

setJson

setXml

setText

setBinary

setBodyParts

setByteChannel

getEntityObj