org.ballerinalang.mime.util

Class EntityBodyHandler

java.lang.Object

org.ballerinalang.mime.util.EntityBodyHandler

public class EntityBodyHandler
extends Object

Entity body related operations are included here.

Since:

0.963.0

Constructor Summary

Constructors

Constructor and Description
EntityBodyHandler()

Method Summary

Modifier and Type	Method and Description
static void	addMessageDataSource(BStruct entityStruct, MessageDataSource messageDataSource) Associate a given message data source with a given entity.
static boolean	checkEntityBodyAvailability(BStruct entityStruct) Check whether the entity body is present.
static BlobDataSource	constructBlobDataSource(BStruct entityStruct) Construct BlobDataSource from the underneath byte channel which is associated with the entity struct.
static BJSON	constructJsonDataSource(BStruct entityStruct) Construct JsonDataSource from the underneath byte channel which is associated with the entity struct.
static StringDataSource	constructStringDataSource(BStruct entityStruct) Construct StringDataSource from the underneath byte channel which is associated with the entity struct.
static BXML	constructXmlDataSource(BStruct entityStruct) Construct XMl data source from the underneath byte channel which is associated with the entity struct.
static BStruct	createNewEntity(Context context, BStruct httpMessageStruct) Set new entity to in/out request/response struct.
static void	decodeEntityBody(Context context, BStruct entityStruct, Channel byteChannel) Decode a given entity body to get a set of child parts and set them to parent entity's multipart data field.
static BRefValueArray	getBodyPartArray(BStruct entityStruct) Extract body parts from a given entity.
static Channel	getByteChannel(BStruct entityStruct)
static TempFileIOChannel	getByteChannelForTempFile(String temporaryFilePath) Given a temp file location, create a byte channel.
static EntityWrapper	getEntityWrapper(String textPayload) Get a byte channel for a given text data.
static MessageDataSource	getMessageDataSource(BStruct entityStruct) Get the message data source associated with a given entity.
static void	populateBodyContent(BStruct bodyPart, org.jvnet.mimepull.MIMEPart mimePart) Populate ballerina body parts with actual body content.
static void	setDiscreteMediaTypeBodyContent(BStruct entityStruct, InputStream inputStream, int numberOfBytesRead) Handle discrete media type content.
static void	writeByteChannelToOutputStream(BStruct entityStruct, OutputStream messageOutputStream) Write byte channel stream directly into outputstream without converting it to a data source.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityBodyHandler

public EntityBodyHandler()

Method Detail

createNewEntity

public static BStruct createNewEntity(Context context,
                                      BStruct httpMessageStruct)

Set new entity to in/out request/response struct.

Parameters:

context - ballerina context.

httpMessageStruct - request/response struct.

setDiscreteMediaTypeBodyContent

public static void setDiscreteMediaTypeBodyContent(BStruct entityStruct,
                                                   InputStream inputStream,
                                                   int numberOfBytesRead)

Handle discrete media type content. This method populates ballerina entity with a byte channel from a given inputstream. If the payload size exceeds 2MB limit, write the stream to a temp file and get a reference to a file channel. After that delete the temp file. If the size does not exceed, then wrap the inputstream with an EntityBodyChannel.

Parameters:

entityStruct - Represent an 'Entity'

inputStream - Represent input stream coming from the request/response

numberOfBytesRead - Number of bytes read

getEntityWrapper

public static EntityWrapper getEntityWrapper(String textPayload)

Get a byte channel for a given text data.

Parameters:

textPayload - Text data that needs to be wrapped in a byte channel

Returns:

EntityBodyChannel which represent the given text

getByteChannelForTempFile

public static TempFileIOChannel getByteChannelForTempFile(String temporaryFilePath)

Given a temp file location, create a byte channel.

Parameters:

temporaryFilePath - Temporary file path

Returns:

ByteChannel which represent the file channel

getMessageDataSource

public static MessageDataSource getMessageDataSource(BStruct entityStruct)

Get the message data source associated with a given entity.

Parameters:

entityStruct - Represent a ballerina entity

Returns:

MessageDataSource which represent the entity body in memory

addMessageDataSource

public static void addMessageDataSource(BStruct entityStruct,
                                        MessageDataSource messageDataSource)

Associate a given message data source with a given entity.

Parameters:

entityStruct - Represent the ballerina entity

messageDataSource - which represent the entity body in memory

constructBlobDataSource

public static BlobDataSource constructBlobDataSource(BStruct entityStruct)
                                              throws IOException

Construct BlobDataSource from the underneath byte channel which is associated with the entity struct.

Parameters:

entityStruct - Represent an entity struct

Returns:

BlobDataSource Data source for binary data which is kept in memory

Throws:

IOException - In case an error occurred while creating blob data source

constructJsonDataSource

public static BJSON constructJsonDataSource(BStruct entityStruct)

Construct JsonDataSource from the underneath byte channel which is associated with the entity struct.

Parameters:

entityStruct - Represent an entity struct

Returns:

BJSON data source which is kept in memory

constructXmlDataSource

public static BXML constructXmlDataSource(BStruct entityStruct)

Construct XMl data source from the underneath byte channel which is associated with the entity struct.

Parameters:

entityStruct - Represent an entity struct

Returns:

BXML data source which is kept in memory

constructStringDataSource

public static StringDataSource constructStringDataSource(BStruct entityStruct)

Construct StringDataSource from the underneath byte channel which is associated with the entity struct.

Parameters:

entityStruct - Represent an entity struct

Returns:

StringDataSource which represent the entity body which is kept in memory

checkEntityBodyAvailability

public static boolean checkEntityBodyAvailability(BStruct entityStruct)

Check whether the entity body is present. Entity body can either be a byte channel, fully constructed message data source or a set of body parts.

Parameters:

entityStruct - Represent an 'Entity'

Returns:

a boolean indicating entity body availability

populateBodyContent

public static void populateBodyContent(BStruct bodyPart,
                                       org.jvnet.mimepull.MIMEPart mimePart)

Populate ballerina body parts with actual body content. Based on the memory threshhold body part's inputstream can either come from memory or from a temp file maintained by mimepull library.

Parameters:

bodyPart - Represent ballerina body part

mimePart - Represent decoded mime part

writeByteChannelToOutputStream

public static void writeByteChannelToOutputStream(BStruct entityStruct,
                                                  OutputStream messageOutputStream)
                                           throws IOException

Write byte channel stream directly into outputstream without converting it to a data source.

Parameters:

entityStruct - Represent a ballerina entity

messageOutputStream - Represent the outputstream that the message should be written to

Throws:

IOException - When an error occurs while writing inputstream to outputstream

decodeEntityBody

public static void decodeEntityBody(Context context,
                                    BStruct entityStruct,
                                    Channel byteChannel)

Decode a given entity body to get a set of child parts and set them to parent entity's multipart data field.

Parameters:

context - Represent the ballerina context

entityStruct - Parent entity that the nested parts reside

byteChannel - Represent ballerina specific byte channel

getBodyPartArray

public static BRefValueArray getBodyPartArray(BStruct entityStruct)

Extract body parts from a given entity.

Parameters:

entityStruct - Represent a ballerina entity

Returns:

An array of body parts

getByteChannel

public static Channel getByteChannel(BStruct entityStruct)