org.mule.module.apikit

Class CharsetUtils

java.lang.Object

org.mule.module.apikit.CharsetUtils

public class CharsetUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
CharsetUtils()

Method Summary

Modifier and Type	Method and Description
static String	detectEncodingOrDefault(byte[] bytes) Given an array of bytes tries to detect the text encoding of them unless apikit.disableEncodingGuessing is set to true.
static String	getEncoding(org.mule.api.MuleMessage message, byte[] bytes, org.slf4j.Logger logger) Tries to figure out the encoding of the request in the following order - checks if the content-type header includes the charset - detects the payload encoding using BOM, or tries to auto-detect it - return the mule message encoding
static String	getHeaderCharset(org.mule.api.MuleMessage message, org.slf4j.Logger logger) Returns the charset specified by the content-type header or null if not specified
static String	getXmlEncoding(org.mule.api.MuleEvent muleEvent, byte[] payload, Document document, org.slf4j.Logger logger) Tries to figure out the encoding of an xml request in the following order - checks if the document has a content-type declaration - detects the payload encoding using BOM, or tries to auto-detect it - return the mule message encoding
static byte[]	trimBom(byte[] content) Removes BOM from byte array if present

Methods inherited from class java.lang.Object

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

Constructor Detail

CharsetUtils

public CharsetUtils()

Method Detail

getEncoding

public static String getEncoding(org.mule.api.MuleMessage message,
                                 byte[] bytes,
                                 org.slf4j.Logger logger)

Tries to figure out the encoding of the request in the following order - checks if the content-type header includes the charset - detects the payload encoding using BOM, or tries to auto-detect it - return the mule message encoding

Parameters:

message - mule message

bytes - payload byte array

logger - where to log

Returns:

payload encoding

getXmlEncoding

public static String getXmlEncoding(org.mule.api.MuleEvent muleEvent,
                                    byte[] payload,
                                    Document document,
                                    org.slf4j.Logger logger)

Tries to figure out the encoding of an xml request in the following order - checks if the document has a content-type declaration - detects the payload encoding using BOM, or tries to auto-detect it - return the mule message encoding

Parameters:

muleEvent - mule event

payload - xml payload as byte array

document - xml parsed document

logger - where to log

Returns:

xml payload encoding

getHeaderCharset

public static String getHeaderCharset(org.mule.api.MuleMessage message,
                                      org.slf4j.Logger logger)

Returns the charset specified by the content-type header or null if not specified

Parameters:

message - mule message

Returns:

header charset

trimBom

public static byte[] trimBom(byte[] content)

Removes BOM from byte array if present

Parameters:

content - byte array

Returns:

BOM-less byte array

detectEncodingOrDefault

public static String detectEncodingOrDefault(byte[] bytes)

Given an array of bytes tries to detect the text encoding of them unless apikit.disableEncodingGuessing is set to true.

If apikit.disableEncodingGuessing is set to true then the encoding name of Charset.defaultCharset() is returned.

Parameters:

bytes - The array of bytes to examine

Returns:

The name of the detected encoding