org.ballerinalang.mime.util

Class MimeUtil

java.lang.Object

org.ballerinalang.mime.util.MimeUtil

public class MimeUtil
extends Object

Mime utility functions are included in here.

Since:

0.96

Constructor Summary

Constructors

Constructor and Description
MimeUtil()

Method Summary

Modifier and Type	Method and Description
static StringBuilder	convertDispositionObjectToString(StringBuilder dispositionBuilder, BStruct contentDispositionStruct)
static BStruct	createEntityError(Context context, String msg) Get entity error as a ballerina struct.
static BStruct	extractEntity(BStruct httpMessageStruct)
static String	getBaseType(BStruct entity) Given a ballerina entity, get the content-type as a base type.
static String	getContentDisposition(BStruct entity) Given a ballerina entity, build the content-disposition header value from 'ContentDisposition' object.
static String	getContentTypeWithParameters(BStruct entity) Given a ballerina entity, get the content-type with parameters included.
static String	getNewMultipartDelimiter() Get a new multipart boundary delimiter.
static BStruct	getParserError(Context context, String errMsg) Get parser error as a ballerina struct.
static String	includeQuotes(String textValue) Surround the given value with quotes.
static boolean	isNotNullAndEmpty(String textValue) Check whether the given string is not null and empty.
static BStruct	parseMediaType(BStruct mediaType, String contentType) Parse 'MediaType' struct with the given Content-Type.
static void	populateContentDispositionObject(BStruct contentDisposition, String contentDispositionHeaderWithParams)
static void	setContentDisposition(BStruct contentDisposition, BStruct bodyPart, String contentDispositionHeaderWithParams) Populate ContentDisposition struct and set it to body part.
static void	setContentLength(BStruct entityStruct, int length) Populate given 'Entity' with it's body size.
static void	setContentType(BStruct mediaType, BStruct entityStruct, String contentType) Construct 'MediaType' struct with the given Content-Type and set it into the given 'Entity'.
static void	setMediaTypeToEntity(Context context, BStruct entityStruct, String contentType)
static void	writeInputToOutputStream(InputStream inputStream, OutputStream outputStream) Write a given inputstream to a given outputstream.

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeUtil

public MimeUtil()

Method Detail

getBaseType

public static String getBaseType(BStruct entity)

Given a ballerina entity, get the content-type as a base type.

Parameters:

entity - Represent an 'Entity'

Returns:

content-type in 'primarytype/subtype' format

getContentTypeWithParameters

public static String getContentTypeWithParameters(BStruct entity)

Given a ballerina entity, get the content-type with parameters included.

Parameters:

entity - Represent an 'Entity'

Returns:

content-type in 'primarytype/subtype; key=value;' format

setContentType

public static void setContentType(BStruct mediaType,
                                  BStruct entityStruct,
                                  String contentType)

Construct 'MediaType' struct with the given Content-Type and set it into the given 'Entity'.

Parameters:

mediaType - Represent 'MediaType' struct

entityStruct - Represent 'Entity' struct

contentType - Content-Type value in string

parseMediaType

public static BStruct parseMediaType(BStruct mediaType,
                                     String contentType)

Parse 'MediaType' struct with the given Content-Type.

Parameters:

mediaType - Represent 'MediaType' struct

contentType - Content-Type value in string

Returns:

'MediaType' struct populated with values

setMediaTypeToEntity

public static void setMediaTypeToEntity(Context context,
                                        BStruct entityStruct,
                                        String contentType)

setContentDisposition

public static void setContentDisposition(BStruct contentDisposition,
                                         BStruct bodyPart,
                                         String contentDispositionHeaderWithParams)

Populate ContentDisposition struct and set it to body part.

Parameters:

contentDisposition - Represent the ContentDisposition struct that needs to be filled

bodyPart - Represent a body part

contentDispositionHeaderWithParams - Represent Content-Disposition header value with parameters

populateContentDispositionObject

public static void populateContentDispositionObject(BStruct contentDisposition,
                                                    String contentDispositionHeaderWithParams)

getContentDisposition

public static String getContentDisposition(BStruct entity)

Given a ballerina entity, build the content-disposition header value from 'ContentDisposition' object.

Parameters:

entity - Represent an 'Entity'

Returns:

content-type in 'primarytype/subtype; key=value;' format

convertDispositionObjectToString

public static StringBuilder convertDispositionObjectToString(StringBuilder dispositionBuilder,
                                                             BStruct contentDispositionStruct)

setContentLength

public static void setContentLength(BStruct entityStruct,
                                    int length)

Populate given 'Entity' with it's body size.

Parameters:

entityStruct - Represent 'Entity'

length - Size of the entity body

extractEntity

public static BStruct extractEntity(BStruct httpMessageStruct)

writeInputToOutputStream

public static void writeInputToOutputStream(InputStream inputStream,
                                            OutputStream outputStream)
                                     throws IOException

Write a given inputstream to a given outputstream.

Parameters:

outputStream - Represent the outputstream that the inputstream should be written to

inputStream - Represent the inputstream that that needs to be written to outputstream

Throws:

IOException - When an error occurs while writing inputstream to outputstream

isNotNullAndEmpty

public static boolean isNotNullAndEmpty(String textValue)

Check whether the given string is not null and empty.

Parameters:

textValue - Represent a text value

Returns:

a boolean indicating the status of nullability and emptiness

includeQuotes

public static String includeQuotes(String textValue)

Surround the given value with quotes.

Parameters:

textValue - Represent a text value

Returns:

a String surrounded by quotes

getNewMultipartDelimiter

public static String getNewMultipartDelimiter()

Get a new multipart boundary delimiter.

Returns:

a boundary string

createEntityError

public static BStruct createEntityError(Context context,
                                        String msg)

Get entity error as a ballerina struct.

Parameters:

context - Represent ballerina context

msg - Error message in string form

Returns:

Ballerina struct with entity error

getParserError

public static BStruct getParserError(Context context,
                                     String errMsg)

Get parser error as a ballerina struct.

Parameters:

context - Represent ballerina context

errMsg - Error message in string form

Returns:

Ballerina struct with parse error