org.safs.android.messenger

Class MessageUtil

java.lang.Object

org.safs.sockets.Message

org.safs.android.messenger.MessageUtil

public class MessageUtil
extends Message

Since:

FEB 04, 2012 (Carl Nagle) Initial version
APR 25, 2013 (LeiWang) Add some methods to assist handling message of big size.

Author:

Carl Nagle, SAS Institute, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_MESSAGE key used to extract generic String message from Bundle.
static java.lang.String	BUNDLE_PROPERTIES key used to extract serialized Properties object from Bundle.
static java.lang.String	BUNDLE_SMALL_PARCEL_ID key used to extract from Bundle a String value, which is message's ID it is used when transferring a message by a few parcels
static java.lang.String	BUNDLE_SMALL_PARCEL_INDEX key used to extract from Bundle an int value, which is the index of parcels of a message it is used when transferring a message by a few parcels
static java.lang.String	BUNDLE_SMALL_PARCEL_TOTALNUMBER key used to extract from Bundle an int value, which indicates the total number of parcels of a whole message to be sent. it is used when transferring a message by a few parcels
static java.lang.String	BUNDLE_SMALL_RESENT_PARCEL key used to extract from Bundle an boolean value, which indicates if this parcel is sent again or not by 'message-sender'. it is used when transferring a message by a few parcels
static int	ID_ALL_PARCELS_ACKNOWLEDGMENT If the message's size is bigger than 262144 bytes, the message will be divided into small parcels.
static int	ID_ENGINE_DEBUG Client: local app is sending a debug message.
static int	ID_ENGINE_DISPATCHFILE Server: Notify local app a File is available for processing.
static int	ID_ENGINE_DISPATCHPROPS Server: Notify local app a serialized Properties Object is available for processing.
static int	ID_ENGINE_EXCEPTION Client: local app is sending an Exception message.
static int	ID_ENGINE_MESSAGE Client: local app is sending a generic Message.
static int	ID_ENGINE_READY Client: local app is Ready to receive commands.
static int	ID_ENGINE_RESULT Client: local app is returning simple processing results: (statuscode, statusinfo).
static int	ID_ENGINE_RESULTPROPS Client: local app is returning a serialized Properties object containing results.
static int	ID_ENGINE_RUNNING Client: local app is Running/Processing the File or Properties dispatched.
static int	ID_ENGINE_SHUTDOWN Server: a remote TCP client has requested a shutdown.
static int	ID_PARCEL_ACKNOWLEDGMENT If the message's size is bigger than 262144 bytes, the message will be divided into small parcels.
static int	ID_REGISTER_ENGINE Client: Register the local app client.
static int	ID_SERVER_CONNECTED Server: a remote TCP client has connected.
static int	ID_SERVER_DISCONNECTED Server: a remote TCP client has disconnected.
static int	ID_SERVER_SHUTDOWN Server: the service is shutting down abnormally and will not be available.
static int	ID_UNREGISTER_ENGINE Client: UnRegister the local app client.
static int	MAX_TRANSFER_BYTE_SIZE This field defines the max size can be transfered through Message Service in SAFS.
static java.lang.String	SERVICE_CONNECT_INTENT
static java.lang.String	SERVICE_SHUTDOWN_INTENT
static int	SMALL_TRANSFER_BYTE_SIZE This field defines the block's size to be transfered, if the whole message's size is bigger than 262144 it is used when transferring a message by a few parcels

Fields inherited from class org.safs.sockets.Message

KEY_ISREMOTERESULT, KEY_REMOTERESULTCODE, KEY_REMOTERESULTINFO, msg_connected, msg_debug, msg_dispatchfile, msg_dispatchprops, msg_exception, msg_message, msg_ready, msg_remoteshutdown, msg_result, msg_resultprops, msg_running, msg_sep, msg_shutdown, NULL_VALUE, shutdown_cause_controller, shutdown_cause_device, shutdown_cause_normal, shutdown_cause_service, STATUS_REMOTE_NOT_EXECUTED, STATUS_REMOTE_NOT_EXECUTED_STRING, STATUS_REMOTERESULT_FAIL, STATUS_REMOTERESULT_FAIL_STRING, STATUS_REMOTERESULT_OK, STATUS_REMOTERESULT_OK_STRING, STATUS_REMOTERESULT_UNKNOWN, STATUS_REMOTERESULT_UNKNOWN_STRING, STATUS_REMOTERESULT_WARN, STATUS_REMOTERESULT_WARN_STRING

Constructor Summary

Constructors

Constructor and Description
MessageUtil()

Method Summary

Modifier and Type	Method and Description
static android.os.Bundle	addParcelableResentParcelFromSmallParcel(android.os.Parcelable parcelable, boolean isResent)
static android.os.Parcelable	assembleParcelMessage(android.os.Parcelable one, android.os.Parcelable another) Concatenate two Parcelable Bundles containing String to form one Parcelable. The String message is stored via Bundle.putCharArray using BUNDLE_MESSAGE as the key for the item.
static android.os.Parcelable	assembleParcelProps(android.os.Parcelable one, android.os.Parcelable another) Concatenate two Parcelable Bundles containing char[] to form one Parcelable. The char[] message is stored via Bundle.putCharArray using BUNDLE_PROPERTIES as the key for the item.
static java.lang.String	getParcelableIDFromSmallParcel(android.os.Parcelable parcelable) Extract a String received from the test package engine.
static int	getParcelableIndexFromSmallParcel(android.os.Parcelable parcelable) Extract a int received from the test package engine.
static java.lang.String	getParcelableMessage(android.os.Parcelable parcelable) Extract the String message received from the test package engine.
static char[]	getParcelableProps(android.os.Parcelable parcelable) Extract a char[] received from the test package engine.
static boolean	getParcelableResentParcelFromSmallParcel(android.os.Parcelable parcelable)
static int	getParcelableTotalNumberFromSmallParcel(android.os.Parcelable parcelable) Extract an int received from the test package engine.
static boolean	isSmallParcelOfWholeMessage(android.os.Bundle dataBundle) Test is the bundle contains the information of small parcel of a whole message.
static android.os.Bundle	setBundleOfSmallParcel(java.lang.String ID, int index, int totalNumber) Create a Parcelable Bundle containing 3 parameters: String, int, int for transport from the test package engine. It will be used by Message.setData(Bundle) for sending a part of whole message from engine. The String message is stored via Bundle.putCharArray using BUNDLE_SMALL_PARCEL_ID as the key for the item. The int message is stored via Bundle.putCharArray using BUNDLE_SMALL_PARCEL_INDEX as the key for the item. The int message is stored via Bundle.putCharArray using BUNDLE_SMALL_PARCEL_TOTALNUMBER as the key for the item.
static android.os.Parcelable	setParcelableMessage(java.lang.String message) Create a Parcelable Bundle containing a String message for transport to the test package engine.
static android.os.Parcelable	setParcelableProps(char[] bytes) Create a Parcelable Bundle containing a char[] for transport to the test package engine.

Methods inherited from class org.safs.sockets.Message

getStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

ID_SERVER_SHUTDOWN

public static final int ID_SERVER_SHUTDOWN

Server: the service is shutting down abnormally and will not be available.

See Also:

Constant Field Values

ID_REGISTER_ENGINE

public static final int ID_REGISTER_ENGINE

Client: Register the local app client.

See Also:

Constant Field Values

ID_UNREGISTER_ENGINE

public static final int ID_UNREGISTER_ENGINE

Client: UnRegister the local app client.

See Also:

Constant Field Values

ID_ENGINE_READY

public static final int ID_ENGINE_READY

Client: local app is Ready to receive commands.

See Also:

Constant Field Values

ID_ENGINE_DISPATCHFILE

public static final int ID_ENGINE_DISPATCHFILE

Server: Notify local app a File is available for processing.

See Also:

Constant Field Values

ID_ENGINE_DISPATCHPROPS

public static final int ID_ENGINE_DISPATCHPROPS

Server: Notify local app a serialized Properties Object is available for processing.

See Also:

Constant Field Values

ID_ENGINE_RUNNING

public static final int ID_ENGINE_RUNNING

Client: local app is Running/Processing the File or Properties dispatched.

See Also:

Constant Field Values

ID_ENGINE_RESULT

public static final int ID_ENGINE_RESULT

Client: local app is returning simple processing results: (statuscode, statusinfo).

See Also:

Constant Field Values

ID_ENGINE_RESULTPROPS

public static final int ID_ENGINE_RESULTPROPS

Client: local app is returning a serialized Properties object containing results.

See Also:

Constant Field Values

ID_ENGINE_MESSAGE

public static final int ID_ENGINE_MESSAGE

Client: local app is sending a generic Message. Server: remote TCP client is sending a generic Message.

See Also:

Constant Field Values

ID_ENGINE_DEBUG

public static final int ID_ENGINE_DEBUG

Client: local app is sending a debug message. Server: send local app a server debug message.

See Also:

Constant Field Values

ID_ENGINE_EXCEPTION

public static final int ID_ENGINE_EXCEPTION

Client: local app is sending an Exception message.

See Also:

Constant Field Values

ID_SERVER_CONNECTED

public static final int ID_SERVER_CONNECTED

Server: a remote TCP client has connected.

See Also:

Constant Field Values

ID_SERVER_DISCONNECTED

public static final int ID_SERVER_DISCONNECTED

Server: a remote TCP client has disconnected.

See Also:

Constant Field Values

ID_ENGINE_SHUTDOWN

public static final int ID_ENGINE_SHUTDOWN

Server: a remote TCP client has requested a shutdown. Client: the local appl has shutdown and should be sent no more messages.

See Also:

Constant Field Values

ID_ALL_PARCELS_ACKNOWLEDGMENT

public static final int ID_ALL_PARCELS_ACKNOWLEDGMENT

If the message's size is bigger than 262144 bytes,
the message will be divided into small parcels. To make sure all parcels will
arrive at the 'message-receiver', we need this acknowledgment.
Used by 'message-receiver' to send acknowledgment for all parcels arrived

See Also:

Constant Field Values

ID_PARCEL_ACKNOWLEDGMENT

public static final int ID_PARCEL_ACKNOWLEDGMENT

If the message's size is bigger than 262144 bytes,
the message will be divided into small parcels. To make sure all parcels will
arrive at the 'message-receiver', we need this acknowledgment.
Used by 'message-receiver' to send acknowledgment for one parcel arrived

See Also:

Constant Field Values

BUNDLE_MESSAGE

public static final java.lang.String BUNDLE_MESSAGE

key used to extract generic String message from Bundle.

See Also:

Constant Field Values

BUNDLE_PROPERTIES

public static final java.lang.String BUNDLE_PROPERTIES

key used to extract serialized Properties object from Bundle.

See Also:

Constant Field Values

SERVICE_CONNECT_INTENT

public static final java.lang.String SERVICE_CONNECT_INTENT

See Also:

Constant Field Values

SERVICE_SHUTDOWN_INTENT

public static final java.lang.String SERVICE_SHUTDOWN_INTENT

See Also:

Constant Field Values

MAX_TRANSFER_BYTE_SIZE

public static final int MAX_TRANSFER_BYTE_SIZE

This field defines the max size can be transfered through Message Service in SAFS.

Android Message: The Binder transaction buffer has a limited fixed size, currently 1Mb, which is shared by all transactions in progress for the process. Consequently TransactionTooLargeException can be thrown when there are many transactions in progress even when most of the individual transactions are of moderate size.

So the real max size of data can be transfered is always smaller than that 1Mb. Here we just give 0.25Mb as the max size to be permitted to transfer. But this also may cause TransactionTooLargeException if a lot of transactions is in progress. In future, we may adjust this value dynamically?

it is used to decide if a message should be transferred by a few parcels

See Also:

Constant Field Values

SMALL_TRANSFER_BYTE_SIZE

public static final int SMALL_TRANSFER_BYTE_SIZE

This field defines the block's size to be transfered, if the whole message's size
is bigger than 262144
it is used when transferring a message by a few parcels

See Also:

Constant Field Values

BUNDLE_SMALL_PARCEL_ID

public static final java.lang.String BUNDLE_SMALL_PARCEL_ID

key used to extract from Bundle a String value, which is message's ID
it is used when transferring a message by a few parcels

See Also:

Constant Field Values

BUNDLE_SMALL_PARCEL_INDEX

public static final java.lang.String BUNDLE_SMALL_PARCEL_INDEX

key used to extract from Bundle an int value, which is the index of parcels of a message
it is used when transferring a message by a few parcels

See Also:

Constant Field Values

BUNDLE_SMALL_PARCEL_TOTALNUMBER

public static final java.lang.String BUNDLE_SMALL_PARCEL_TOTALNUMBER

key used to extract from Bundle an int value, which indicates the total number of
parcels of a whole message to be sent.
it is used when transferring a message by a few parcels

See Also:

Constant Field Values

BUNDLE_SMALL_RESENT_PARCEL

public static final java.lang.String BUNDLE_SMALL_RESENT_PARCEL

key used to extract from Bundle an boolean value, which indicates if this parcel
is sent again or not by 'message-sender'.
it is used when transferring a message by a few parcels

See Also:

Constant Field Values

Constructor Detail

MessageUtil

public MessageUtil()

Method Detail

setParcelableMessage

public static android.os.Parcelable setParcelableMessage(java.lang.String message)

Create a Parcelable Bundle containing a String message for transport to the test package engine. The String message is stored via Bundle.putString using BUNDLE_MESSAGE as the key for the item.

Parameters:

message - to send across processes.

Returns:

Parcelable Bundle

See Also:

BaseBundle.putString(String, String), BaseBundle.getString(String)

setParcelableProps

public static android.os.Parcelable setParcelableProps(char[] bytes)

Create a Parcelable Bundle containing a char[] for transport to the test package engine. The char[] message is stored via Bundle.putCharArray using BUNDLE_PROPERTIES as the key for the item. The original intent here is to store Java Properties in the Bundle that were serialized via the Java Properties.store method.
NOTE: This has not yet been tested!

Parameters:

char[] - (Properties) to send across processes.

Returns:

Parcelable Bundle

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String)

setBundleOfSmallParcel

public static android.os.Bundle setBundleOfSmallParcel(java.lang.String ID,
                                                       int index,
                                                       int totalNumber)

Create a Parcelable Bundle containing 3 parameters: String, int, int for transport from the test package engine.
It will be used by Message.setData(Bundle) for sending a part of whole message from engine.
The String message is stored via Bundle.putCharArray using BUNDLE_SMALL_PARCEL_ID as the key for the item.
The int message is stored via Bundle.putCharArray using BUNDLE_SMALL_PARCEL_INDEX as the key for the item.
The int message is stored via Bundle.putCharArray using BUNDLE_SMALL_PARCEL_TOTALNUMBER as the key for the item.

Parameters:

ID - String, the message's ID.

index - int, the index of this parcel of the whole message.

totalNumber - int, indicate the total number of parcels will be sent for a whole message..

Returns:

Parcelable Bundle

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String), getParcelableIDFromSmallParcel(Parcelable), getParcelableIndexFromSmallParcel(Parcelable), getParcelableTotalNumberFromSmallParcel(Parcelable), isSmallParcelOfWholeMessage(Bundle)

addParcelableResentParcelFromSmallParcel

public static android.os.Bundle addParcelableResentParcelFromSmallParcel(android.os.Parcelable parcelable,
                                                                         boolean isResent)

isSmallParcelOfWholeMessage

public static boolean isSmallParcelOfWholeMessage(android.os.Bundle dataBundle)

Test is the bundle contains the information of small parcel of a whole message.

Parameters:

dataBundle, - Bundle, get from the data property of a Message object.

Returns:

boolean, true, if the dataBundle contains the information of small parcel.

See Also:

setBundleOfSmallParcel(String, int, int), getParcelableIDFromSmallParcel(Parcelable), getParcelableIndexFromSmallParcel(Parcelable), getParcelableTotalNumberFromSmallParcel(Parcelable)

getParcelableMessage

public static java.lang.String getParcelableMessage(android.os.Parcelable parcelable)

Extract the String message received from the test package engine. The String message is retrieved via Bundle.getString using BUNDLE_MESSAGE as the key for the item.

Parameters:

Parcelable - Bundle received from the TCP Messenger Service.

Returns:

String message, if present

See Also:

BaseBundle.putString(String, String), BaseBundle.getString(String)

getParcelableProps

public static char[] getParcelableProps(android.os.Parcelable parcelable)

Extract a char[] received from the test package engine. The char[] message is extracted via Bundle.getCharArray using BUNDLE_PROPERTIES as the key for the item. The original intent here is to retrieve Java Properties stored as a char[] suitable for deserialization via the Java Properties.load method.
NOTE: This has not yet been tested!

Parameters:

Parcelable - Bundle received from the test package engine

Returns:

char[] suitable for Java Properties.load

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String)

getParcelableIDFromSmallParcel

public static java.lang.String getParcelableIDFromSmallParcel(android.os.Parcelable parcelable)

Extract a String received from the test package engine. The String message is extracted via Bundle.getCharArray using BUNDLE_SMALL_PARCEL_ID as the key for the item.

Parameters:

Parcelable - Bundle received from the test package engine

Returns:

String represents the ID of a message, generated at the engine side.

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String), setBundleOfSmallParcel(String, int, int)

getParcelableIndexFromSmallParcel

public static int getParcelableIndexFromSmallParcel(android.os.Parcelable parcelable)

Extract a int received from the test package engine. The int message is extracted via Bundle.getCharArray using BUNDLE_SMALL_PARCEL_INDEX as the key for the item.

Parameters:

Parcelable - Bundle received from the test package engine

Returns:

int represents the index of a parcel of a whole message, generated at the engine side.

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String), setBundleOfSmallParcel(String, int, int)

getParcelableTotalNumberFromSmallParcel

public static int getParcelableTotalNumberFromSmallParcel(android.os.Parcelable parcelable)

Extract an int received from the test package engine. The int message is extracted via Bundle.getCharArray using BUNDLE_SMALL_PARCEL_TOTALNUMBER as the key for the item.

Parameters:

Parcelable - Bundle received from the test package engine

Returns:

int the total number of parcels to be sent for one message, generated at the engine side.

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String), setBundleOfSmallParcel(String, int, int)

getParcelableResentParcelFromSmallParcel

public static boolean getParcelableResentParcelFromSmallParcel(android.os.Parcelable parcelable)

assembleParcelMessage

public static android.os.Parcelable assembleParcelMessage(android.os.Parcelable one,
                                                          android.os.Parcelable another)

Concatenate two Parcelable Bundles containing String to form one Parcelable.
The String message is stored via Bundle.putCharArray using BUNDLE_MESSAGE as the key for the item.

Parameters:

one - Parcelable Bundle, containing String message

another - Parcelable Bundle, containing String message

Returns:

Parcelable Bundle, including Parcelable one and another.

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String)

assembleParcelProps

public static android.os.Parcelable assembleParcelProps(android.os.Parcelable one,
                                                        android.os.Parcelable another)

Concatenate two Parcelable Bundles containing char[] to form one Parcelable.
The char[] message is stored via Bundle.putCharArray using BUNDLE_PROPERTIES as the key for the item.

Parameters:

one - Parcelable Bundle, containing char[] message

another - Parcelable Bundle, containing char[] message

Returns:

Parcelable Bundle, including Parcelable one and another.

See Also:

Bundle.putCharArray(String, char[]), Bundle.getCharArray(String)