oracle.lite.provider

Interface MessageData

public interface MessageData

This interface provides the declaration for Client Device Message. Data received from the client device will be represented by this interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTransaction() Begin a transaction on the Mobile Server's repository.
byte[]	getBytes() Return the data as a byte array.
java.lang.String	getEncoding() Return the character encoding scheme specified by the client device.
java.io.InputStream	getInputStream() Return the data as an InputStream object
java.lang.String	getMetaData() Return the meta-data (if any) associated with the request.
java.lang.String	getName() Retrieve the 'name' of the message.
int	getSize() Return the size of the client data in bytes.
java.sql.Timestamp	getTime() Retrieve the data timestamp - or the time at which data is created by the client device.
java.lang.String	toString() Convert data to a string using the encoding scheme specified by the client device.

Method Detail

beginTransaction

void beginTransaction()

Begin a transaction on the Mobile Server's repository. Message handler must call this method before persisting any information in the repository. Mobile Server will end the transaction when all the messages are processed.

getBytes

byte[] getBytes()

Return the data as a byte array. Caller must not copy data into the returned buffer.

getEncoding

java.lang.String getEncoding()

Return the character encoding scheme specified by the client device.

getInputStream

java.io.InputStream getInputStream()

Return the data as an InputStream object

Returns:

java.io.InputStream object

getMetaData

java.lang.String getMetaData()

Return the meta-data (if any) associated with the request.

getName

java.lang.String getName()

Retrieve the 'name' of the message. Usually all the messages sent by the client devices will have a 'name' or a 'tag' associated with the message.

getSize

int getSize()

Return the size of the client data in bytes.

getTime

java.sql.Timestamp getTime()

Retrieve the data timestamp - or the time at which data is created by the client device.

Returns:

java.sql.Timestamp

toString

java.lang.String toString()

Convert data to a string using the encoding scheme specified by the client device.

Overrides:

toString in class java.lang.Object