Skip to main content

ME Framework Build Instructions

This page describes how to build the ME Framework. Remember, in order to contribute code to the project you must have a contributor role. See Mobile & Embedded Community Governance for information about the different community roles.

Table of Contents

Dependencies
Set Properties
Start the Build

Dependencies

The ME Framework build requires the technologies listed in the following table.

Technology Where to Get It Notes
Ant version 1.6.5 or later http://ant.apache.org/
JDK version 5 or later http://java.sun.com/javase/index.jsp
JT harness version 3.2 or later https://jtharness.java.net
Version 1.1 or later of the following reference implementations:
  • Foundation Profile
  • Personal Profile
  • Personal Basis Profile
http://java.sun.com/products/foundation
http://java.sun.com/products/personalprofile
http://java.sun.com/products/personalbasis
Oracle Java Wireless Toolkit version 2.2 or later http://java.sun.com/products/sjwtoolkit/ Oracle Java Wireless Toolkit 2.2 is available on Microsoft Windows XP or Linux-x86 (not officially supported). ME Framework only uses the preverifier and class files for compilation. These can be replaced with a different preverification tool or class files. The ME Framework build itself does not have direct dependencies on the operating system. It has been verified on Solaris-sparc and should work on other operating systems that meet the above requirements.
JavaHelp software version 2.0_01 or later http://java.sun.com/products/javahelp/ JavaHelp software version 2.0_02 may be used, with the following minor limitation. On systems that have two separate displays (typically on X11 systems), the help viewer may default to the first screen, which may not be the screen on which you are running the harness. For example, if the harness is on screen :0.1, the help viewer appears on screen :0.0.
Java Communication API http://java.sun.com/products/javacomm/

Designated Exception Modules

The following table lists a binary plug-in required for ME Framework APIs. This binary plug-in is covered by the Oracle Binary Code License Agreement. See the Licensing section of the download page for more detailed information.

Binary Plug-In License
Java Communications 3.0 API (javax.com) Oracle Binary Code License Agreement

-->

Set Properties

Set the following properties in the framework_directory/build/local.properties file to reflect your build environment.

Property Description
FCS_JCTTOOLS Location of the JT harness binary
WIRELESS_TOOLKIT Location of Oracle Java Wireless Toolkit binary
JAVAHELP_JAR The path to the JavaHelp software jhall.jar library
PBP_HOME Location of PBP 1.1 specification classes
PP_HOME Location of PP 1.1 specification classes
FP_HOME Location of CDC/FP 1.1 specification classes
COMM_JAR The path to the Java Communication API JAR file

The following properties are optional and are not required for the build. They are used if you specify them.

Property Description
checkstyle.jar Location of the Checkstyle JAR file. If you specify this property, Checkstyle is run on the sources.
J2SE_API_OFFLINE Location of the Java SE API Javadoc documentation. If you specify this property, the files in that are used in the ME Framework API Javadoc documentation.

Start the Build

The following steps describe how to build the ME Framework binary.

  1. Set the JAVA_HOME environment variable to point to JDK 5 (or later)
  2. Execute the ant command from the framework_directory/build directory. The build places the ME Framework binary in the framework_directory-build directory.
Note: To see a step-by-step example of how to set up the ME Framework build on Linux, take a look at this forum post.
 
 
Close
loading
Please Confirm
Close