Blackberry JAVA DEVELOPMENT ENVIRONMENT User Manual

BlackBerry Java Development Environment

Version: 4.7.0

Fundamentals Guide

SWDT499912-499912-1212115921-001

Contents

1 Understanding BlackBerry and programming for BlackBerry devices............................................................................... 5

Design principles for BlackBerry devices..................................................................................................................................... 5

Release cycles and versions........................................................................................................................................................... 6

BlackBerry Java Development Environment................................................................................................................................ 6

Java ME and Java APIs for BlackBerry.......................................................................................................................................... 7

Support for standard Java APIs............................................................................................................................................. 7

Support for Java API extensions........................................................................................................................................... 8

BlackBerry solutions....................................................................................................................................................................... 8

BlackBerry Enterprise Solution............................................................................................................................................. 9

BlackBerry Internet Service................................................................................................................................................... 9

BlackBerry MDS...................................................................................................................................................................... 9

2 BlackBerry Java Application design.......................................................................................................................................... 10

Standalone applications................................................................................................................................................................. 10

Applications with desktop synchronization................................................................................................................................. 10

Applications with wireless access, wireless synchronization, or wireless alerting.................................................................. 10

MIDlet applications........................................................................................................................................................................ 10

CLDC applications.......................................................................................................................................................................... 11

API control and code signing........................................................................................................................................................ 12

Object modeling.............................................................................................................................................................................. 12

Multithreading................................................................................................................................................................................. 12

Best practice: Using multithreading.................................................................................................................................... 12

Best practices for writing an efficient BlackBerry Java Application......................................................................................... 13

Best practice: Writing efficient code.................................................................................................................................... 13

Best practice: Using objects judiciously.............................................................................................................................. 18

Best practice: Reducing the size of compiled code............................................................................................................ 18

Multilanguage support................................................................................................................................................................... 20

Best practice: Storing text strings in resource files............................................................................................................ 20

Multimedia support......................................................................................................................................................................... 21

Audio support.......................................................................................................................................................................... 21

Imaging support..................................................................................................................................................................... 21

Video support.......................................................................................................................................................................... 21

3 UI and navigation design........................................................................................................................................................... 22

BlackBerry device user input and navigation.............................................................................................................................. 22

Trackwheel versus Trackball.................................................................................................................................................. 22

Creating a UI that is consistent with standard BlackBerry UIs................................................................................................. 23

4 Memory management................................................................................................................................................................. 24

Managing memory.......................................................................................................................................................................... 24

BlackBerry device memory.................................................................................................................................................... 24

Key resources to reserve........................................................................................................................................................ 24

Best practice: Minimizing memory use................................................................................................................................ 25

Managing low memory availability............................................................................................................................................... 25

Identifying low memory availability on a BlackBerry device............................................................................................. 25

Conserving resources..................................................................................................................................................................... 25

Best practice: Using efficient data structure selection...................................................................................................... 25

Best practice: Consolidating objects into object groups................................................................................................... 26

Garbage collection on a BlackBerry device................................................................................................................................. 27

RAM garbage collection on a BlackBerry device................................................................................................................ 27

Full garbage collection on a BlackBerry device.................................................................................................................. 27

Idle garbage collection on a BlackBerry device.................................................................................................................. 27

5 Data management....................................................................................................................................................................... 28

Support for APIs to store data to persistent memory................................................................................................................. 28

Persistent Store APIs.............................................................................................................................................................. 28

MIDP Record management system APIs............................................................................................................................. 28

File Connections APIs............................................................................................................................................................ 28

Storage on removable media......................................................................................................................................................... 29

Accessing data on the microSD media card....................................................................................................................... 29

Backing up and synchronizing data.............................................................................................................................................. 29

6 Wireless data transport............................................................................................................................................................... 31

Wireless gateways........................................................................................................................................................................... 31

Using the BlackBerry Enterprise Server as an network gateway...................................................................................... 31

Using the wireless service provider's Internet gateway.................................................................................................... 31

Alternative data transport options................................................................................................................................................ 32

Using email to transport data............................................................................................................................................... 32

Using SMS to transport data................................................................................................................................................ 32

Using PIN messaging to transport data.............................................................................................................................. 32

7 BlackBerry application integration........................................................................................................................................... 33

Adding custom menu items........................................................................................................................................................... 33

Integrating with BlackBerry Device Software applications....................................................................................................... 33

Accessing email and organizer data............................................................................................................................................. 33

Using BlackBerry Messenger with a BlackBerry Application.................................................................................................... 33

Using listeners to respond to application changes.................................................................................................................... 34

8 Security considerations.............................................................................................................................................................. 35

Data encryption and the BlackBerry Application........................................................................................................................ 35

Data encryption in transport................................................................................................................................................. 35

Data encryption on the BlackBerry device.......................................................................................................................... 35

Access to memory........................................................................................................................................................................... 35

Authentication................................................................................................................................................................................. 36

BlackBerry device authentication and IT policy.................................................................................................................. 36

Application authentication.................................................................................................................................................... 36

Server-side authentication.................................................................................................................................................... 36

Controlled APIs and code signing................................................................................................................................................. 36

BlackBerry APIs with controlled access........................................................................................................................................ 37

IT policy support.............................................................................................................................................................................. 38

Application control.......................................................................................................................................................................... 38

File encryption on microSD cards................................................................................................................................................. 38

Encryption of data on a microSD media card..................................................................................................................... 38

Using the microSD media card with more than one BlackBerry device.......................................................................... 39

IT policies and the microSD media card.............................................................................................................................. 39

9 Test a BlackBerry Java Application........................................................................................................................................... 40

Obfuscating a BlackBerry Java Application................................................................................................................................. 40

Preverifying a BlackBerry Java Application.................................................................................................................................. 40

Testing applications on a BlackBerry Smartphone Simulator................................................................................................... 40

Testing applications on a BlackBerry device............................................................................................................................... 41

BlackBerry simulators..................................................................................................................................................................... 41

BlackBerry Smartphone Simulator....................................................................................................................................... 41

BlackBerry MDS Simulator.................................................................................................................................................... 41

BlackBerry Email Simulator................................................................................................................................................... 42

10 Making applications available................................................................................................................................................... 43

Application distribution through a computer connection.......................................................................................................... 43

Distribute an application from a computer......................................................................................................................... 43

Distribute an application from a web page......................................................................................................................... 43

Distribute an application for testing.................................................................................................................................... 43

Application distribution over the wireless network..................................................................................................................... 43

Wireless pull (user-initiated)................................................................................................................................................. 44

Wireless push (server-initiated)............................................................................................................................................ 44

11 Glossary......................................................................................................................................................................................... 45

12 Legal notice.................................................................................................................................................................................. 48

Fundamentals Guide

Understanding BlackBerry and programming for BlackBerry devices

Understanding BlackBerry and programming for

BlackBerry devices

BlackBerry® devices provide a Java® ME wireless environment that supports client/server applications. Application developers can create a BlackBerry® Java Application that has sophisticated UIs for data entry and searching, and that supports multithreading, internationalization, network communication, and local data storage. Applications can communicate with networks using standard TCP and HTTP connections, regardless of the underlying wireless network.

Application developers can also create a BlackBerry Java Application that integrates tightly with core BlackBerry device applications, such as the message list, organizer applications, phone, and browser, for an essentially seamless user experience.

Design principles for BlackBerry devices

Applications designed for BlackBerry® devices should provide a balance between the best possible user experience and a long battery life. When you design your BlackBerry device application, consider the differences between mobile devices and computers. Mobile devices

• have a smaller screen size that can display a limited number of characters

• have slower processor speeds

• use wireless networks that have a longer latency period than standard LANs

• have less available memory

• have shorter battery life

• display one screen at a time

Mobile device users use applications on their mobile device differently than they would use applications on a computer. On mobile devices, users expect to find information quickly. For example, a CRM system can provide a massive amount of information, but users only require a small amount of that information at one time. The BlackBerry device UI is designed so that users can perform tasks easily and access information quickly.

When you design applications for BlackBerry devices, try to be as consistent as possible with other BlackBerry device applications. Consider the following guidelines:

• Use or extend existing UI components where possible so that your application can inherit the default behavior of the component.

• Follow the standard navigation model as closely as possible so that users can make full use of the keyboard and trackball.

• Make all actions available from the menu. Verify that the actions available in the menu are relevant to users' current context.

When you design your application, also consider the following guidelines:

• Stay focused on users' immediate task. Simplify data selection and presentation to display only the information that users need at any one moment.

Fundamentals Guide

• Display information in a way that makes effective use of the small screen.

Before you design your application, consider using the core applications on the BlackBerry device or the BlackBerry Smartphone Simulator to learn more about the navigation model and best practices for designing your application's UI.

Release cycles and versions

All BlackBerry® devices include a specific version of the BlackBerry® Device Software and the BlackBerry® Java® Virtual Machine. To determine the version of the BlackBerry Device Software for a BlackBerry device, in the device Options, click About. You can upgrade the BlackBerry Device Software. For example, you can upgrade a BlackBerry device with BlackBerry Device Software version 4.0 to BlackBerry Device Software version 4.1.

With each major release of the BlackBerry Device Software and the BlackBerry JVM, Research In Motion includes the corresponding Java APIs and version of the BlackBerry® Java® Development Environment. The version of the BlackBerry Device Software determines the version of the BlackBerry® Integrated Development Environment that you can use to develop applications. For example, RIM released BlackBerry Device Software version 4.0 and BlackBerry JDE version 4.0 at the same time. BlackBerry JDE version 4.0 includes support for the APIs that were introduced in BlackBerry Device Software version 4.0 and BlackBerry JVM version 4.0. Applications that you create using BlackBerry JDE Version 4.0 only work on BlackBerry devices running BlackBerry Device Software version 4.0 or later.

You can use the following criteria to decide which version of the BlackBerry JDE to use to develop an application:

• If the application does not need to use specific BlackBerry device hardware features or newly released API extensions, use BlackBerry JDE version 4.0 to develop the application.

• If the application is designed to run only on the BlackBerry® Pearl™ 8100 smartphone, use BlackBerry JDE version 4.2 or later.

BlackBerry Java Development Environment

The BlackBerry® Java® Development Environmentis a fully integrated development and simulation environment for building a BlackBerry® Java Application for BlackBerry devices. With the BlackBerry JDE, developers can build applications using the Java® ME programming language and the extended Java APIs for BlackBerry.

The BlackBerry Java Development Environment includes the following development tools:

• BlackBerry® Integrated Development Environment

• BlackBerry Smartphone Simulator

• Java ME APIs and BlackBerry APIs

• sample applications

The BlackBerry IDE includes a full suite of editing and debugging tools that are optimized for the development of a BlackBerry Java Application. TheBlackBerry Smartphone Simulator provides a complete Windows® type environment, and is designed to simulate UIs and user interaction, network connections, email services, and wireless data synchronization.

Fundamentals Guide

The BlackBerry Java Development Environment Component Package includes the following development tools for development within third-party IDEs such as NetBeans™ or Eclipse™:

• RAPC: You can use this command prompt compiler to compile .java and .jar files into .cod files that you can run in the BlackBerry Smartphone Simulator or on a BlackBerry device.

• JavaLoader: You can use this tool to add or update an application on a BlackBerry device for testing, and to view information about application .cod files.

• BlackBerry® Signature Tool: You can use this tool to send code signature requests to the BlackBerry® Signing Authority Tool.

• Preverify Tool: You can use this tool to partially verify your classes before you load your application onto a BlackBerry device.

• JDWP: You can use this tool to debug applications using third-party integrated development environments.

Java ME and Java APIs for BlackBerry

Java® ME is an industry standard platform that defines common sets of Java APIs for different types of wireless and embedded devices. A Java ME application on a BlackBerry® device runs in the BlackBerry® Java® Virtual Machine, which provides all of the runtime services to the applications and performs functions such as typical memory allocations, security checks, and garbage collection.

The Java ME MIDP standard addresses the API and BlackBerry JVM needs of a constrained wireless device with a user interface. The BlackBerry device supports the Java ME MIDP standard as defined in JSR 118. The Java MEMIDP standard provides a core set of Java APIs that any BlackBerry device can support, regardless of its underlying operating system. Developers can often build one Java application using the MIDP standard APIs and run that application on many different types of devices.

Support for standard Java APIs

The BlackBerry® device and the BlackBerry® Java® Development Environment support the Java® ME MIDP standard, which provides a core set of Java APIs that you can use to develop wireless device applications. The BlackBerry device and the BlackBerry® Java® Development Environment also support the following JSRs:

• JSR 30: Connected Limited Device Configuration Version 1.0

(supported on devices with BlackBerry® Device Software version 4.0 or earlier)

• JSR 37: Mobile Information Device Profile Version 1.0

(supported on devices with BlackBerry Device Software Version 4.0 or earlier)

• JSR 75: Portable Optional Packages for the J2ME Platform (PDAP) support for the PIM APIs only and the File Connection API for Java ME (supported on devices with BlackBerry Device Software version 4.2 or later)

• JSR 82: Java APIs for Bluetooth®

• JSR 118: Mobile Information Device Profile Version 2.0

• JSR 120: Wireless Messaging API (WMA) Version 1.1

• JSR 135: Mobile Media APIs (MM API) Version 1.1

Fundamentals Guide

• JSR 139: Connected Limited Device Configuration Version 1.1

• JSR 172: J2ME Web Services

• JSR 177: Security and Trust Services API for J2ME (SATSA)

• JSR 179: Location API for Java ME

• JSR 185: Java Technology for the Wireless Industry (JTWI)

• JSR 205: Wireless Messaging API 2.0

• JSR 211: Content Handler API

• JSR 226: Scalable 2D Vector Graphics API for Java ME

• JSR 238: Mobile Internationalization API

BlackBerry solutions

Support for Java API extensions

BlackBerry® devices support the following Java® APIs that are not part of the standard JSR definitions and that can provide greater features and functionality over what is available in the standard MIDP API libraries.

API Description

User Interface APIs You can use these APIs to create screens, menu items, and all the components of

the user interface. Persistent Data Storage APIs You can use these APIs to store custom data locally within your application. Networking and I/O APIs You can use these APIs to establish network connections and read or write data to

a server-side application. Event Listeners You can use the Event Listeners to respond to BlackBerry device user or system-

initiated events on a BlackBerry device. Application Integration APIs You can use these APIs to integrate with the existing BlackBerry email, phone,

calendar, contacts, browser, camera, media player, and task list applications. Additional Utilities You can use these additional APIs for data encryption and compression, XML

parsing, Bluetooth® connectivity, location-based services, and so on.

BlackBerry solutions

BlackBerry® device users might use either the BlackBerry® Enterprise Server or the BlackBerry® Internet Service, or they can use both on the same device. Understanding the differences between theBlackBerry Enterprise Server and the BlackBerry Internet Service, and which types of users you plan to support, is important, as it might impact which modes of transport you use and how you manage data synchronization.

Fundamentals Guide

BlackBerry solutions

BlackBerry Enterprise Solution

The BlackBerry® Enterprise Server is part of the BlackBerry® Enterprise Solution. The BlackBerry Enterprise Server exists behind the corporate firewall and provides a wireless gateway for BlackBerry device users in an organization to access corporate email and organizer data. The BlackBerry Enterprise Server also provides the following key features:

• data encryption and compression

• BlackBerry device management and monitoring utilities

• simplified application provisioning

• authenticated gateway for intranet access from a BlackBerry® Java Application

BlackBerry Internet Service

BlackBerry® device users who are not associated with a BlackBerry® Enterprise Server can use the BlackBerry® Internet Service. The BlackBerry Internet Service is an email and Internet service for BlackBerry devices that is designed to provide users with automatic delivery of email messages, wireless access to email attachments, and access to Internet content.

The BlackBerry Internet Service includes support for direct HTTP and TCP/IP connectivity to the Internet from a third-party BlackBerry® Java Application.

BlackBerry MDS

To allow a BlackBerry® Java Application access to resources behind the corporate firewall, the BlackBerry® Enterprise Server includes the BlackBerry® Mobile Data System. The BlackBerry MDS provides HTTP and TCP/IP proxies for a BlackBerry Java Application, which allow the BlackBerry device to communicate with application and web servers behind the corporate firewall without additional VPN software. Applications that send data using the BlackBerry Enterprise Server as a gateway can capitalize on the simplified enterprise connectivity, data encryption and compression, and wireless network-independence that the BlackBerry® Enterprise Solution offers. BlackBerry MDS also provides an open interface, allowing server-side applications behind the corporate firewall to push content to applications on BlackBerry devices.

Fundamentals Guide

BlackBerry Java Application design

Standalone applications

You can use the BlackBerry® APIs to build standalone applications, such as games and static reference guides that can run as offline applications. You can add the required resource data to an application before you compile it. BlackBerry device users can install the application over the wireless network or with the BlackBerry® Desktop Software. After an application is installed on the BlackBerry device, it does not need to connect to the wireless network or to a computer.

Applications with desktop synchronization

You can use the BlackBerry® APIs to build applications with desktop synchronization capabilities, such as reference guides and organizer applications. The user connects the BlackBerry device to a computer to manage and synchronize data that is located on the computer.

Research In Motion® does not provide HotSync® conduits or any other direct database synchronization module. You must build the synchronization code, and the BlackBerry device user must initiate the data synchronization process manually. After the application is installed on the BlackBerry device, the BlackBerry device user must synchronize information manually by connecting their BlackBerry device to the computer with a serial connection, a USB connection, or a Bluetooth® connection.

Applications with wireless access, wireless synchronization, or wireless alerting

You can use the BlackBerry® APIs to build applications that push content proactively over the wireless network to BlackBerry devices in environments that use the BlackBerry® Enterprise Server. A BlackBerry® Java Application for BlackBerry devices uses a wireless connection to the Internet or the corporate intranet to provide BlackBerry device users with access to remote data and applications. The BlackBerry® Java® Development Environment provides APIs you can use in applications to establish network connections to servers on the Internet or the corporate intranet.

MIDlet applications

The MIDlet application model is part of the MIDP specification. The main class of a MIDlet always extends the MIDlet class and it must use methods for startApp(), pauseApp(), and destroyApp().

Fundamentals Guide

Advantages Disadvantages

CLDC applications

• Applications are portable to other

devices that also support the MIDP specification.

• Applications can use only the user interface APIs that exist in the javax.microedition.lcdui library.

• The model assumes that all application processes terminate when the application closes.

• Applications cannot start automatically in the background when the device turns on.

CLDC applications

The CLDC application model is a specification of a framework for Java® ME. A CLDC application extends the UiApplication class and starts with a standard main() method.

Most of the sample applications that the BlackBerry® Java® Development Environmentincludes use the CLDC application model. All of the core BlackBerry applications (including message list, contacts list, calendar, and the browser) are built as CLDC applications.

Advantages Disadvantages

• BlackBerry User Interface APIs provide more functionality and flexibility than the standard

javax.microedition.lcdui

library.

• Applications can run active background threads after they have closed.

• Applications can start automatically in the background when the device turns on.

• Applications can use IPC APIs to exchange information with other applications.

• Developers can create reusable library modules that CLDC applications can import.

• Applications are not portable to other devices.

Fundamentals Guide

API control and code signing

When you develop a BlackBerry® Java Application for BlackBerry devices, you can use only the public Java APIs that are published and documented in the Javadoc™ documents in the BlackBerry® Java® Development Environment. The BlackBerry® Java® Virtual Machine on the BlackBerry device is designed to protect the underlying data and operating system, so applications cannot call undocumented or unsupported APIs or access data that is not explicitly exposed through the APIs. If you try to use Java APIs that are not publicly exposed, your application receives an error message at runtime.

Public APIs are either open or signed. Signed APIs expose the methods to access BlackBerry device user data or other information on the BlackBerry device that is considered sensitive. You can use signed APIs, but you must request and receive a set of code signing keys from Research In Motion. You must then digitally sign your application before you install it on a BlackBerry device. Code signing does not certify or approve an application; it allowsRIM to identify the author of an application that uses sensitive APIs, if the application is malicious.

To request a set of code signing keys, visit www.blackberry.com/developers/downloads/jde/api.shtml. You will receive your set of code signing keys in about 10 days.

Object modeling

Whether you use the MIDlet or the CLDC application model, you must use an object-oriented approach when you design your application for the BlackBerry® device. In an object-oriented approach, developers use objects to contain the code that is common to a specific process or function. For example, a developer might use separate objects to control networking activity, data storage, data processing and manipulation, and user interface interaction. When you design your application, start with a good object model.

Multithreading

The BlackBerry® operating system is a multithreaded operating system, which means that many applications and processes can run actively on the BlackBerry device at the same time. For example, applications can use background threads to manage processor-intensive tasks or network communications so that they do not affect the main thread. If an application creates background threads, and a BlackBerry device user closes the application, the background threads can remain active.

Best practice: Using multithreading

Make effective use of the multithreading capabilities of the BlackBerry® operating system. In particular, always create a new thread for network connections or other lengthy operations (more than one-tenth of a second). Use background threads for listeners or other processes that run in the background when the application starts.

Fundamentals Guide

Best practices for writing an efficient BlackBerry Java Application

Best practice: Writing efficient code

To allow a BlackBerry® Java® Application to use resources efficiently, consider the following guidelines:

• Use local variables.

• Use shorthand for evaluating Boolean conditions.

• Make classes final.

• Use int instead of long.

• Avoid garbage collection.

• Use static variables for Strings.

• Avoid the String(String) constructor.

• Write efficient loops.

• Optimize subexpressions.

• Optimize division operations.

• Avoid java.util.Enumeration.

• Perform casts using instanceof.

• Evaluate conditions using instanceof.

• Avoid using StringBuffer.append (StringBuffer).

• Avoid returning null.

• Avoid passing null into methods.

• Use caution when passing null into a constructor.

• Use long for unique identifiers.

• Exit applications correctly.

• Print the stack trace.

Using local variables

Use local variables whenever possible. Access to local variables is more efficient than access to class members.

Using shorthand for evaluating Boolean conditions

To evaluate a Boolean condition, use shorthand. The resulting compiled code is shorter.

Code sample

return( boolean_expression );

Fundamentals Guide

Best practices for writing an efficient BlackBerry Java Application

Making classes final

When you create code libraries, mark classes as final if you know that developers will never extend them. The presence of the final keyword allows the compiler to generate more efficient code.

By default, the BlackBerry® Java® Development Environment compiler marks any classes that you do not extend in an application .cod file as final.

Using int instead of long

In Java®, a long is a 64-bit integer. Because BlackBerry® devices use a 32-bit processor, operations can run two to four times faster if you use an int instead of a long.

Avoiding garbage collection

Avoid calling System.gc() to perform a garbage collection operation because it might take too much time on BlackBerry® devices with limited available memory. Let the BlackBerry® Java® Virtual Machine collect garbage.

Using static variables for Strings

When you define static fields (also called class fields) of type String, you can increase application speed by using static variables (not final) instead of constants (final). The opposite is true for primitive data types, such as int.

For example, you might create a String object as follows:

private static final String x ="example";

For this static constant (denoted by the final keyword), each time that you use the constant, a temporary String instance is created. The compiler eliminates "x" and replaces it with the string "example" in the bytecode, so that the BlackBerry® Java® Virtual Machine performs a hash table lookup each time that you reference "x" .

In contrast, for a static variable (no final keyword), the String is created once. The BlackBerry JVM performs the hash table lookup only when it initializes "x" , so access is faster.

private static String x = "example";

You can use public constants (that is, final fields), but you must mark variables as private.

Avoiding the String(String) constructor

In a BlackBerry® Java Application, each quoted string is an instance of the java.lang.String class. Create a String without using the java.lang.String(String) constructor.

+ 36 hidden pages