2 Setting Up the Development Environment

This chapter provides information on setting up and configuring the MAF environment for application development and deployment.

This chapter includes the following sections:

2.1 Introduction to the MAF Development Environment

After you install JDeveloper and the MAF extension, as described in Installing Mobile Application Framework with JDeveloper , configure the development environment for the platforms to which you want your MAF application deployed. Configure form factors if you want to test or deploy applications on a particular mobile device. Install and configure third-party tools if you want to package and deploy your MAF application on supported platforms.

For the complete list of supported versions of development and runtime tools, see Certification Information in Oracle Mobile Application Framework Documentation on Oracle Technology Network at: http://www.oracle.com/technetwork/developer-tools/maf/documentation/index.html

2.2 Configuring the Development Environment for Target Platforms

To package and deploy applications to the platforms supported by MAF, JDeveloper needs the name of the platform and the names of the directories containing platform-specific tools and data. For convenience, MAF populates JDeveloper Preferences with these settings. Each platform-specific page hosts the preferences for the platform SDK (Android, iOS, or Windows), collecting information such as the path that MAF needs to compile and deploy Android, iOS, or Windows projects. Depending on several factors related to application signing, you may need to edit some of the fields.

To configure your environment for target platforms:

  1. In JDeveloper, click Tools > Preferences to open Preferences.
  2. In the Preferences dialog, click Mobile Application Framework , and then click the platform you want to configure (Android, iOS, or Windows) to open a page that contains the path and configuration parameters for the supported platforms. Figure 2-1 , for example, shows the page where you configure the platform preferences for Android platform.

    • For the Android platform, specify the following:

      • The Android SDK location on your computer

      • The local directory of your target Android platform

      • The Android build tools location on your computer

      • Information on the signing credentials

      Figure 2-1 Configuring Platform Preferences for Android

      This image is described in the surrounding text.

    • For the iOS platform, specify the following:

      • Location of the iTunes media files, including the mobile applications that are synchronized to the iOS-powered device

      • The iOS-powered device signing information (See "Setting the Device Signing Options" in Developing Mobile Applications with Oracle Mobile Application Framework.)

  3. For the Windows platform, specify the following:
    1. In Windows SDK Location, specify the path to the location of MSBuild version 14.0.
    2. Select Debug or Release, and specify the certificate location and password for the selected mode.

    Note:

    The Hash Algorithm is currently not used.

2.3 Configuring the Development Environment for Form Factors

A form factor is a specific device configuration. Each form factor is identified by a name that you specify for it and contains information on the specified resolution denoted by pixel width and pixel height.

Since form factors defined in preferences are used in the MAF AMX page Preview tab (see the "Using the Preview" section in Developing Mobile Applications with Oracle Mobile Application Framework), you may choose to perform this configuration if you are planning to include a MAF AMX application feature as part of your MAF application and you do not want to accept the default settings. During development, you can select or switch between various form factors to see how a MAF AMX page is rendered. You can also see multiple form factors applied to the same page using the split screen view.

For more information, see the "About the maf-config.xml File" section in Developing Mobile Applications with Oracle Mobile Application Framework.

Before you begin:

Download and install JDeveloper and the MAF extension, as described in Installing Mobile Application Framework with JDeveloper .

To configure the form factors:

  1. Open Preferences by selecting Tools > Preferences from the main menu in JDeveloper.
  2. In the Preferences dialog that Figure 2-2 shows, select Mobile Application Framework from the tree on the left.

    Figure 2-2 Defining Form Factors

    This image is described in the surrounding text

    The Mobile Application Framework page is populated with available form factors and the default is set to Android Low.

    This preference page allows you to create and manage a set of named form factors that combine a screen resolution size and platform.

  3. To create a new form factor, click the green plus sign (New), and then set the following:

    • Name: a meaningful string that is used to identify the form factor.

    • Platform: the platform of the mobile device.

    • Model: the type of the mobile device.

    • Default Orientation: the default device orientation used in the MAF AMX page Preview tab. It might be Portrait or Landscape. Select this setting from the drop-down list of values. The default value is Portrait and it is prepopulated during creation of the new form factor.

    • Width: width, in pixels. This value must be a positive integer, and its input is validated.

    • Height: height, in pixels. This value must be a positive integer, and its input is validated.

    • Scale Factor: the display scale factor. This value must be either one of 1.0, 2.0, or 3.0.

    Note:

    If you do not set the name and resolution for your form, MAF will display an error message.

  4. If you need to revert to default settings, click More Actions > Restore Defaults.
  5. Click OK to finalize your settings.

2.4 Setting Up Development Tools for the iOS Platform

In addition to general-purpose tools listed in Introduction to Installing the MAF Extension with JDeveloper, you might want to set up an iPhone or iPad when getting ready for development of a MAF application for the iOS platform (see How to Set Up an iPhone or iPad).

Since iPhone and iPad simulators are included in the iOS SDK installation, which, in turn, is included in Xcode installation, you do not need to separately install them. For more information, see How to Set Up an iPhone or iPad Simulator.

2.4.1 How to Install Xcode and iOS SDK

You download Xcode from http://developer.apple.com/xcode/. This download includes the iOS SDK.

After installing Xcode, you have to run it at least once and complete the Apple licensing and setup dialogs. If these steps are not performed, any build and deploy cycle from JDeveloper to Xcode or device simulator will fail with a "Return code 69" error.

Note:

Since older versions of Xcode and iOS SDK are not available from the Mac App Store, in order to download them you must obtain an Apple ID from http://appleid.apple.com, and then register this Apple ID with the Apple Developer Program to gain access to the Apple developer site at http://developer.apple.com.

2.4.2 How to Set Up an iPhone or iPad

In your MAF application development and deployment, you can use either the iPhone, iPad, or their simulators (see How to Set Up an iPhone or iPad Simulator). If you are planning to use an actual iPhone or iPad, which is preferable for testing (see the "Testing MAF Applications" section in Developing Mobile Applications with Oracle Mobile Application Framework), you need to connect it to your computer to establish a link between the two devices.

To deploy to an iOS-powered device, you need to have an iOS-powered device with a valid license, certificates, and distribution profiles. For more information, see the "Deploying Mobile Applications" chapter in Developing Mobile Applications with Oracle Mobile Application Framework.

Note:

Since Apple's licensing terms and conditions may change, ensure that you understand them, comply with them, and stay up to date with any changes.

2.4.3 How to Set Up an iPhone or iPad Simulator

In your MAF application development and deployment, you can use either the iOS-powered device itself (see How to Set Up an iPhone or iPad) or its simulator. Deploying to a simulator is usually much faster than deploying to a device, and it also means that you do not have to sign the application first.

A simulator can be invoked automatically, without any additional setup.

Note:

Before attempting to deploy your application from JDeveloper to a device simulator, you must first run the simulator.

If you are planning to use web services in your application and you are behind a corporate firewall, you might need to configure the external network access. You do so by modifying the network settings in the System Preferences on your development computer. For more information, see the "Configuring the Browser Proxy Information" section in Developing Mobile Applications with Oracle Mobile Application Framework.

2.5 Setting Up Development Tools for the Android Platform

In addition to the general-purpose tools listed in Introduction to Installing the MAF Extension with JDeveloper, you might want to set up an Android-powered device when getting ready for development of a MAF application for the Android platform (see How to Set Up an Android-Powered Device).

Since emulators are included in the Android SDK installation, you do not need to separately install them. However, you cannot use an emulator until you create its configuration (see How to Set Up an Android Emulator).

To develop for the Android platform, you can use any operating system that is supported by both JDeveloper and Android.

For more information, see the "Developer Tools" section of the Android Developers website at http://developer.android.com/tools/index.html.

2.5.1 How to Install the Android SDK

Android SDK includes development tools that you need to build applications for Android-powered devices. Since the Android SDK is modular, it allows you to download components separately depending on your target Android platform and your application requirements.

When choosing the platform, keep in mind that MAF supports Android 4.0.3 or later.

Before you begin:

Ensure that your environment meets the operating system, JDK version, and hardware requirements listed in the "Get the Android SDK" section of the Android Developers website at http://developer.android.com/sdk/index.html.

Note:

Ant and Linux requirements are not applicable to the MAF development environment; Eclipse might be applicable depending on your IDE of choice.

To install the Android SDK:

  1. Download the Android SDK starter package from http://developer.android.com/sdk/index.html.
  2. Complete the installation by following the instructions provided in the "Setting Up an Existing IDE" section of the Android Developers website at http://developer.android.com/sdk/installing.html.

    Note:

    If you are not planning to use Eclipse, skip step 3 in the Android SDK installation instructions.

2.5.2 How to Set Up an Android-Powered Device

In your MAF application development and deployment, you can use either the Android device itself, which is preferable for testing (see the "Testing MAF Applications" section in Developing Mobile Applications with Oracle Mobile Application Framework), or an emulator (see How to Set Up an Android Emulator.).

For information on how to set up the Android-powered device, follow the instructions from the "Using Hardware Devices" section of the Android Developers website at http://developer.android.com/tools/device.html.

Note:

You might experience issues when using USB connectivity for the device-based debugging. For more information, see the "Testing and Debugging MAF Applications" chapter in Developing Mobile Applications with Oracle Mobile Application Framework.

Your target Android-powered device might not be listed in the USB device driver's.inf file, resulting in the failure to install the Android Debug Bridge (ADB). You can eliminate this issue as follows:

  1. Find the correct values for your device.
  2. Update the [Google.NXx86] and [Google.NTamd64] sections of the android_winusb.inf file.

For more information, see the "Google USB Driver" section of the Android Developers website at http://developer.android.com/sdk/win-usb.html.

2.5.3 How to Set Up an Android Emulator

In your MAF application development and deployment, you can use either the Android device itself (see How to Set Up an Android-Powered Device) or its emulator. Deploying to an emulator is usually much faster than deploying to a device, and it also means that you do not have to sign the application first.

For information on how to create an emulator configuration called Android Virtual Device (AVD), follow the instructions from the "Managing Virtual Devices" section of the Android Developers website at http://developer.android.com/tools/devices/index.html. When creating an AVD through the Create New Android Virtual Device dialog (see "Managing AVDs with AVD Manager" at http://developer.android.com/tools/devices/managing-avds.html), review all the settings to ensure that configuration matches what you are planning to emulate. In particular, you should verify the following:

  • The Target field should define the desired Android platform level for proper emulation.

  • The CPU/ABI field should reflect the ARM or Intel Atom system image (see Configuring AVD for Intel HAXM).

  • The SD card field should be defined based on whether the application uploads files or files install themselves to the SD card.

  • Default settings for the Hardware field (see the "Hardware Options" table at http://developer.android.com/tools/devices/managing-avds.html#hardwareopts) should be acceptable for a typical MAF application. For additional hardware capabilities you may want to use in your application, such as cameras or geolocation services, create new properties.

You need to create an AVD for each Android platform on which you are planning to test your application.

For information on how to use the emulator, see the "Using the Android Emulator" section in the Android Developers website at http://developer.android.com/tools/devices/emulator.html.

2.5.3.1 Configuring the Android Emulator

After the basic Android emulator setup is complete, you may choose to perform the following configurations:

2.5.3.1.1 Saving the Emulator State

You can reduce the emulator's load time by saving the emulator state or reusing the saved state. To do so, you manipulate the avd files or folders that are located in the C:\Users\username\.android\avd directory (on a Windows computer). Each avd folder contains several files, such as userdata.img, userdata.qemu.img, and cache.img. You can copy the cache.img file to another emulator's avd folder to use that state with another emulator.

Alternatively, you can use the command line to run relevant commands, such as, for example, -snapshot-list, -no-snapstorage, and so on. You can access these commands through emulator -help command.

Caution:

When using this utility, keep in mind that in the process of loading, all contents of the system, including the user data and SD card images, will be overwritten with the contents they held when the snapshot was made. Unless saved in a different snapshot, any changes will be lost.

2.5.3.1.2 Creating, Saving, and Reusing the SD Card

The "SD Card Emulation" section of the Android Developers website at http://developer.android.com/tools/devices/emulator.html#sdcard lists reasons for creating, saving, and reusing the SD card. You can perform these operations by executing the following commands:

  • To create an SD card:

    C:\android sdk directory\tools>mksdcard -l SD500M 500M C:\Android\sd500m.img

  • To list existing AVDs:

    C:\android sdk directory\tools>android list avd

    This produces a listing similar to the following:

    Name:    AndroidEmulator1
Device:  Nexus S (Google)
Path:    C:\Users\username\.android\avd\AndroidEmulator1.avd
Target:  Android 4.2.2 (API level 17)
Tag/ABI: default/x86
Skin:    480x800
------------
Name:    AndroidEmulator2
Device:  Nexus S (Google)
Path:    C:\Users\username\.android\avd\AndroidEmulator2.avd
Target:  Android 4.2.2 (API level 17)
Tag/ABI: default/armeabi-v7a
Skin:    480x800
Sdcard:  500M

  • To start the AndroidEmulator2 with the SD card that has just been created:

    C:\Android\android sdk directory\tools>emulator -avd AndroidEmulator2 -sdcard C:\Android\sd500m.img

  • To list the running Android emulator instances:

    C:\Android\android sdk directory\platform-tools>adb devices

  • To copy a test image to the SD card (this requires the emulator to restart):

    C:\Android\sdk\platform-tools>adb push test.png sdcard/Pictures
85 KB/s (1494 bytes in 0.017s)

For more information, see the Android Tools Help at http://developer.android.com/tools/help/index.html.

2.5.3.1.3 Configuring the Network

From the Android emulator, you can access your host computer through the 10.0.2.2 IP. To connect to the emulator from the host computer, you have to execute the adb command from a command line on your development computer or from a script to set up the port forwarding.

To forward socket connections, execute

adb forward local remote

using the following forward specifications:

  • tcp:port

  • localabstract:unix domain socket name

  • localreserved:unix domain socket name

  • localfilesystem:unix domain socket name

  • dev:character device name

  • jdwp:process pid (remote only)

For example, an arbitrary client can request connection to a server running on the emulator at port 55000 as follows:

adb -e forward tcp:8555 tcp:55000

In this example, from the host computer, the client would connect to localhost:8555 and communicate through that socket.

For more information, see the "Android Debug Bridge" section in the Android Developers website at http://developer.android.com/tools/help/adb.html.

2.5.3.1.4 Configuring the Network Proxy

If your development computer is behind a corporate firewall, you might need to configure a proxy by using one of the following techniques:

  1. Execute this command to start the emulator and initiate its connection with the browser:

    emulator -avd myavd -http-proxy myproxy

  2. Start the emulator and then use its Settings utility as follows:

    1. Select Wireless & Networks

    2. Select Mobile Networks > Access Point Names

    3. Select the appropriate internet option

    4. Set the proxy, port, username, and password using the Edit access point list

2.5.3.2 Speeding Up the Android Emulator

The Intel Hardware Accelerated Execution Manager (Intel HAXM) is designed to accelerate the Android-powered device emulator by making use of Intel drivers.

The Intel HAXM is available for computers running Microsoft Windows, Mac OS X, and a separate kernel-based virtual machine option (KRM) for Linux. See http://software.intel.com/en-us/android/articles/intel-hardware-accelerated-execution-manager to access installation guides and detailed descriptions of system requirements for each operating system.

Regardless of which operating system your development computer is running on, it must have the following:

  • Version 17 or later of the Android SDK installed (see How to Install the Android SDK).

    Note:

    Currently, the recommended version for MAF development is 21.

  • Intel processor with support for Intel VT-x, EM64T and Execute Disable (XD) Bit functionality at the BIOS level.

  • At least 1 GB of available RAM.

To download the Intel HAXM, either use the Android SDK Manager (see Speeding Up the Android Emulator on Intel Architecture) or use the following Intel locations:

To install the Intel HAXM, follow the steps described in the "Speeding Up the Android Emulator on Intel Architecture" article available at http://software.intel.com/en-us/android/articles/speeding-up-the-android-emulator-on-intel-architecture. It is particularly important to configure AVD (see Configuring AVD for Intel HAXM).

If your development computer is running either Microsoft Windows 8.n or later, or Mac OS X 10.9.n or later, you have to apply a Hotfix provided by Intel before using the emulator with the Intel HAXM.

Note:

If you do not apply the Hotfix, your computer will freeze and you will lose your work.

To download the Hotfix, use the following locations:

For more information, see the following:

2.5.3.2.1 Configuring AVD for Intel HAXM

When enabling the Intel HAXM, ensure that you download the Intel system image for the Android API level using the Android SDK Manager (see Figure 2-3). The following steps described in Speeding Up the Android Emulator on Intel Architecture guide you through the configuration process:

  • After you have installed the Android SDK, open the SDK Manager and then find the Intel HAXM in the extras section.

  • Select Intel x86 Emulator Accelerator (HAXM) and click Install packages.

    Once you have installed the package, the status changes to Installed, which is not accurate: the SDK only copies the Intel HAXM executable on your computer; you have to manually install the executable.

    Figure 2-3 Downloading Intel System Image in Android SDK Manager

    This image is described in the surrounding text

  • To install the Intel HAXM executable, depending on your development platform search your hard drive for one of the following:

    • On Windows, search for IntelHaxm.exe

    • On Mac OS X, search for IntelHaxm.dmg

    If you accepted default settings, the executable should be located at C:\Program Files\Android\android-sdk\extras\Intel\Hardware_Accelerated_Execution_Manager\IntelHaxm.exe on Windows.

The Intel HAXM only functions in combination with one of the Intel Atom processor x86 system images, which are available for Android 2.3.3 (API 10), 4.0.3 (API 15), 4.1.2 (API 16), 4.2.2 (API 17), 4.4 (API 19), 4.4W (API 20), 5.0 (API 21). These system images can be installed exactly like the ARM-based images through the Android SDK Manager.

Figure 2-4 Installing Intel Atom System Image

This image is described in the surrounding text

To complete the process, use the AVD Manager to create a new virtual device that has hardware-accelerated emulation by selecting Intel Atom (x86) as the CPU/ABI, (see Figure 2-5).

Note:

This option appears in the list only if you have the Intel x86 system image installed.

Figure 2-5 Creating Accelerated AVD

This image is described in the surrounding text

2.6 Setting Up Development Tools for the Universal Windows Platform

Describes how to set up the development machine so that MAF applications can be developed and deployed to the Universal Windows Platform (UWP).

To set up your development machine so that you can develop and deploy a MAF application to UWP:

After completing these setup tasks, a MAF application can be deployed to UWP. For information on deployment, see Deploying a MAF Application to the Universal Windows Platform in Developing Mobile Applications with Oracle Mobile Application Framework.

2.6.1 Installing Visual Studio

  1. Download and install an edition of Visual Studio 2015 available at: https://www.visualstudio.com/products/vs-2015-product-editions. The Visual Studio download includes the Windows 10 SDK.
  2. During the Visual Studio 2015 installation, make sure that you select Universal Windows App Development Tools and Windows 10 SDK, as shown in Figure 2-6.

    Figure 2-6 Installing Visual Studio

    The surrounding text describes the image.

For the following information, see Windows Software Development Kit (SDK) for Windows 10 at

https://dev.windows.com/en-us/downloads/windows-10-sdk

  • What's in the kit

  • New APIs

  • New and updated tools

  • System requirements

  • Instructions to install and uninstall

  • Known issues

2.6.2 Creating a PFX File for MAF Applications

Provides the steps to create a Personal Information Exchange (PFX) file that is needed to sign Universal Windows Platform (UWP) based MAF applications.

MAF applications based on UWP must be digitally signed before deployment. A PFX file is required to sign an application. A PFX file contains a public x509 certificate file (.cer) and a private key file (.pvk file).

To create a PFX file:
  1. Open a Command Prompt window as Administrator.
  2. Navigate to the location: C:\Program Files (x86)\Windows Kits\10\bin\x64
  3. Run the following command, with variables you want, to create a Windows proprietary private key file (.pvk) and a X.509 certificate file (.cer): 
    makecert.exe -sv c:\somedir\MyKey.pvk -n "CN=Your Name,OU=MAF,O=Oracle,C=US" -r -h 0 -eku "1.3.6.1.5.5.7.3.3,1.3.6.1.4.1.311.10.3.13" c:\somedir\MyKey.cer

    • The "-eku" (Enhanced Key Usage) flag value must not have spaces between the two comma delimited values. The 1.3.6.1.5.5.7.3.3 OID indicates that the certificate is valid for code signing. The 1.3.6.1.4.1.311.10.3.13 indicates that the certificate respects lifetime signing.

    • The "-r" flag creates a self-signed root certificate. This simplifies management of your test certificate.

    • The "-h 0" flag marks the basic constraint for the certificate as an end-entity. This constraint prevents the certificate from being used as a Certification Authority (CA) that can issue other certificates.

  4. In the Create Private Key Password window, enter a password and confirm it.
  5. In the Enter Private Key Password window that opens, enter the password that was created.

    Verify whether a .pvk and .cer file were created at the specified locations.

  6. Run the following command to convert the certificate and the private key files into a PFX file that can be used by Visual Studio. 
    pvk2pfx.exe -pvk c:\somedir\MyKey.pvk -spc c:\someDir\MyKey.cer -pfx c:\someDir\MyPFX.pfx -pi welcome -po welcome

    • -pi : Specify this flag or value if you entered a password for the pvk file that you created. If the pvk file is password protected, and you do not specify the flag, pvk2pfx.exe will prompt you for the password.

    • -po : Specify this flag or value if you want to password-protect the .pfx file being created.

    Verify whether a PFX file was created.

2.6.3 Installing a PFX File on Windows 10

Copy a Personal Information Exchange (PFX) file to a certificate store.

An operating system keeps certificates in an area called a certificate store. A Software Publisher Certificate (SPC), with its private and public keys, is used for application signing. SPC is stored in a Personal Information Exchange (.pfx) file. Files have to be copied to a certificate store. Install a Personal Information Exchange (PFX) file either on a local machine or a current user store.

Install the PFX file in the following Certificate Stores on the Windows 10 computer :

  • Current User with Personal Store

  • Current User with Trusted Store

  • Local Machine with Trusted Store

Note:

Use the steps in the task for each of the certificate store combinations in the list.
To install a PFX file in a certificate store:
  1. Locate and double-click the .pfx file to open the file in the Certificate Import Wizard.
  2. Select either Current User or Local Machine as the Store Location, and then click Next.
    Selection of the Local Machine store opens the Windows User Access Control dialog. Click Yes for Do you want to allow this app to make changes to your PC?
  3. Verify the name in the File name field, and then click Next.
  4. Enter a password, if required.
  5. Select Included all extended properties, and then click Next.
  6. In Select Certificate Store, select the store that is paired with the store location you selected, and then click OK.
  7. Click Next and complete the wizard.

2.6.4 Enabling Developer Mode on Windows 10

Enable Developer Mode to develop MAF applications on Windows 10.

If you want to develop and deploy MAF applications to the UWP you must enable Developer Mode on the Windows 10 computer that you use. Developer Mode is required for the following reasons:

  • Side-load, or install and run applications, from unofficial sources.

  • Run an application in debug mode.

To enable Developer Mode:
  1. Press the Windows key, search for Settings, and select Settings - Modern application from the displayed results.
  2. Select Update & Security > For developers > Developer mode.

    Note:

    If you create an application in Visual Studio, the system prompts you with a dialog to enable Developer Mode.

2.7 Testing the Environment Setup

You can test your environment setup as follows:

  1. In JDeveloper, open the HelloWorld sample application by selecting the HelloWorld.jws file (see the "Mobile Application Framework Sample Applications" appendix in Developing Mobile Applications with Oracle Mobile Application Framework).
  2. Select Application > Deploy from the main menu.

    For more information, see the "Deploying Mobile Applications" chapter in Developing Mobile Applications with Oracle Mobile Application Framework.

  3. From the drop-down menu, select the deployment profile for the platform to which you wish to deploy the application.
  4. Since using an iOS-powered device simulator or Android-powered device emulator to test the environment setup is preferable because it does not require signing of the application, you should select one of the following deployment actions using the Deploy dialog:

    • For iOS, select Deploy application to simulator, as Figure 2-7 shows.

      Figure 2-7 Selecting Deployment Action for iOS

      This image is described in the surrounding text

    • For Android, select Deploy application to emulator, as Figure 2-8 shows. Ensure that the emulator is running before you start the deployment.

      Figure 2-8 Selecting Deployment Action for Android

      This image is described in the surrounding text

    • For the Windows platform, use the following steps:

      1. Click Application > Deploy > Windows1.

      2. In Deployment Action, select the deployment action to deploy the mobile application to a local Windows machine.

  5. Click Next on the Deploy dialog to verify the Summary page, and then click Finish.

For more information on deployment, see the "Deploying Mobile Applications" chapter in Developing Mobile Applications with Oracle Mobile Application Framework

After a successful deployment (which might take a few minutes), the device to which you had deployed the application displays the launch screen of the HelloWorld application, and then displays the default application feature.