Packages in the Mobile Client Business Object API

The Mobile Client Business Object (MCBO) API consists of the following Java classes:

• com.sun.mep.client.api.BusinessObject, which defines your data model and the serialized form used to store the data on the client device

• com.sun.mep.client.api.BusinessObjectStorage, which manages the storage and retrieval of BusinessObject instances on the client device

• com.sun.mep.client.api.DefaultSecurityManager, which provides a basic implementation of com.sun.mep.client.api.SecurityManager

• com.sun.mep.client.api.SecurityManager, which manages all of the client-side security features

• com.sun.mep.client.api.SyncManager, which controls synchronization with the MEP Gateway Engine

• com.sun.mep.client.api.SyncResults, which provides coarse-grained statistics after synchronizations

• com.sun.mep.client.api.SMSMessageHandler, which is a callback handler for SMS push notification messages sent from the Gateway Engine

• com.sun.mep.client.api.SyncType, which enumerates the six synchronization types

• com.sun.mep.client.api.EncodingType, which enumerates two encoding types

• com.sun.mep.client.api.SyncException, which provides exception-handling methods

• com.sun.mep.client.api.SMSMessageHandler, a callback handler for SMS push messages sent from the Gateway Engine

• com.sun.mep.client.api.SMSInstructionType, which enumerates SMS push instruction types

See Chapter 4, Classes and Methods in the Mobile Client Business Object API Package for summaries of the classes, fields, and methods in these packages. The API documentation is also included in the MEP client bundle. In the directory where you unzipped the client bundle (see the Sun Java System Mobile Enterprise Platform 1.0 Installation Guide for details), it is in the directory sjsmep-client-1_0_02-fcs/doc/mcbo/api.

The MCBO API packages provide a simple interface on top of a set of more complex packages, the com.synchronica APIs. At times an application may find it useful to call some of these APIs.

This chapter uses the Secure MusicDB sample application provided with MEP to demonstrate how to use the MCBO API. The client in this application communicates with an Enterprise Connector deployed in the Gateway Engine, which in turn communicates with a database using the Java Database Connectivity (JDBC) API.

The source code for the Secure MusicDB sample application is included in the MEP client bundle. In the directory where you unzipped the client bundle, it is in the subdirectory sjsmep-client-1_0_02-fcs/samples/mcbo/secure-musicdb/.

Use of security features in a MEP application is recommended, but it is not required. If you implement security, you can provide your own implementation of com.sun.mep.client.api.SecurityManager to replace com.sun.mep.client.api.DefaultSecurityManager.