×

JAD and JAR manifest attributes

The MIDlet attributes must be the same in both the JAR manifest and the application descriptor (JAD file), if the application is meant to be published on Nokia Store. Otherwise, the application will not work after it is signed by Nokia.

The following JAD and JAR manifest attributes are specified for Series 40 devices.

Table 1. Nokia-proprietary manifest attributes for Series 40

Attribute name

Since Series 40 Edition

Domain

Description

Value

Nokia-MIDlet-Close-Gprs-Context

Series 40 5th Edition Feature Pack 1

All

If set totrue, after all HTTP connections are closed, there is a time-out of 10 seconds before shutting down GPRS context . By default there is no time out, which means the GPRS context will be kept till the MIDlet exits.

Example:

Nokia-MIDlet-Close-Gprs-Context: true

Nokia-MIDlet-Name-<locale>

Series 40 3rd Edition

All

Localised MIDlet suite name.

For more information, see MIDlet name localisation.

Example:

Nokia-MIDlet-Name-en: Bounce

Nokia-MIDlet-Name-n-<locale>

Series 40 3rd Edition

All

Localised MIDlet name for MIDlets in the suite.

For more information, see MIDlet name localisation.

Example:

Nokia-MIDlet-1-en: Bounce

Nokia-MIDlet-national-digit-display

Series 40 5th Edition

All

Used to enable national rather than Latin digit display.

Example:

Nokia-MIDlet-national-digit-display: true

Nokia-MIDlet-Save-Location

Series 40 5th Edition Feature Pack 1

All

Used to determine download folder (currently only supports the root (predefjava) folder).

Example:

Nokia-MIDlet-Save-Location: Root

Nokia-Service

Series 40 5th Edition Feature Pack 1

All

Used to indicate an upload service. Upload services are downloaded with different UI to other MIDlets.

true or false

Example:

Nokia-Service: true

Nokia-MIDlet-Splash-Screen-Image

Java Runtime 1.0.0 for Series 40

All

Defines the custom start-up screen ("splash screen") used by the MIDlet. This attribute can also be used to disable ("suppress") the start-up screen for the MIDlet.

Examples:

Nokia-MIDlet-Splash-Screen-Image: splash_300x300.png

Nokia-MIDlet-Splash-Screen-Image: suppress

Nokia-UI-Enhancement

Series 40 3rd Edition

All

Specifies the following:

  • Theme (skin) behavior on a normal mode Canvas (not full screen) component. The background image is shown if the attribute value isCanvasHasBackground. If the attribute is not defined, by default the background is white (corresponds to Display.getColor(COLOR_BACKGROUND)). If the MIDlet does not render all the pixels of a given clip region in the paint method, the theme background is shown.

  • Receiving Media keys while the MIDlet is running.

Note:

The attribute value is a comma-separated list, so several values can be specified.

Examples:

Nokia-UI-Enhancement: CanvasHasBackground

Nokia-UI-Enhancement: MusicKeysSupported

Nokia-Update

Series 40 3rd Edition

All

Version update URL, used when doing Update Check. If no URL then Update Check is disabled.

Example:

Nokia-Update: http://myserver.com/Bounce.jad

progressive_download

Series 40 3rd Edition Feature Pack 2

All

Set to enabled to enable JSR-135 progressive playback.

Example:

progressive_download: enabled

Nokia-MIDlet-App-Orientation

Java Runtime 2.0.0 for Series 40

All

Specifies the orientation mode supported by the MIDlet. The platform uses this value to set the MIDlet UI orientation at launch time. If the MIDlet includes a splash screen, the splash screen orientation follows the JAD attribute value.

The JAD attribute is not mandatory, and if it is not defined, the MIDlet is assumed to support the default display orientation only, which may vary between devices.

If the JAD attribute is not defined, the setAppOrientation method of the Orientation API cannot be used. However, methods for determining the MIDlet UI and device display orientations and for registering an OrientationListener can be used regardless of the JAD attribute.

For more information about the Orientation API, see section Orientation API and the Orientation API reference.

Possible values:

  • Nokia-MIDlet-App-Orientation: portrait

    This value specifies that the MIDlet supports portrait mode only. When the MIDlet starts, its UI is displayed in portrait mode. The MIDlet cannot use the Orientation API to adjust its orientation when this value is used.

  • Nokia-MIDlet-App-Orientation: landscape

    This value specifies that the MIDlet supports landscape mode only. When the MIDlet starts, its UI is displayed in landscape mode. The MIDlet cannot use the Orientation API to adjust its orientation when this value is used.

  • Nokia-MIDlet-App-Orientation: manual

    This value specifies that the MIDlet supports both portrait and landscape modes. When the MIDlet starts, its UI orientation follows the display orientation of the device. The MIDlet can then adjust its orientation using the Orientation API.

Table 2. JAD and MANIFEST.MF attributes.

X = mandatory

X* = must be present in eitherMANIFEST.MF or JAD file.

O = optional

- = not supported

Parameter

JAD

Manifest

Description

MIDlet-Name

X

X

The name of the MIDlet suite packaged in the JAR file. This name is displayed to the user.

MIDlet-Version

X

X

The version number of the MIDlet suite packaged in the JAR file. Version numbering must have three digits in the format n.n.n. When an equal or later version of the same MIDlet is installing, the lower MIDlet version is replaced with the new one. The user gets the notification from AMS asking if he wants to reinstall.

MIDlet-Vendor

X

X

The name of the MIDlet suite provider. This attribute is presented to the user during installation.

MicroEdition-Profile

X*

X*

The version or versions of the MIDP specification that the MIDlets in this suite can work with.

MicroEdition-Configuration

X*

X*

The Java ME configuration (CLDC) required by the MIDlets in this suite.

MIDlet-n

X*

X*

Attributes that identify the MIDlet in the MIDlet suite. The value n is replaced by a numeric value starting from 1 to identify individual MIDlets. All MIDlets to be included in the MIDlet suite must be added this way.

MIDlet-Jar-URL

X

-

The URL of the JAR file that contains the MIDlet or MIDlet suite described by these attributes.

MIDlet-Jar-Size

X

-

The size of the MIDlet JAR file in bytes.

MIDlet-Description

O

O

A description of the MIDlet suite intended to be displayed to the user.

MIDlet-Icon

O

O

An icon that is used to represent the MIDlet suite in the mobile device's applications menu that contains all installed MIDlets.

For an example, see article Adding an icon to a MIDlet in the Nokia Developer Wiki.

MIDlet-Info-URL

O

O

The URL of a file that contains further information describing the MIDlet suite.

MIDlet-Data-Size

O

O

The minimum amount of persistent storage that this MIDlet suite requires.

MIDlet-Install-Notify

O

O

A URL used to report the success or failure of MIDlet installation performed from a remote server.

MIDlet-Delete-Notify

O

O

A URL used to report the success or failure of MIDlet uninstallation.

MIDlet-Delete-Confirm

O

O

Specifies the confirmation prompt shown by the Application Management Software (AMS) when the user selects to remove the MIDlet or MIDlet suite.

This attribute is supported from Java Runtime 2.1 onwards for all protection domains.

Example:

MIDlet-Delete-Confirm: Are you sure you want to delete this MIDlet?

MIDlet-Permissions

O

O

Requested permissions by the MIDlet. Multiple permissions can be specified and are separated by commas.

MIDlet-Permissions-Opt

O

O

Requested optional permissions

MIDlet-Jar-RSA-SHA1

O

-

Defines the JAR signature (for trusted MIDlets only).

MIDlet-Certificate-n-m

O

-

Defines the public key certificate (for trusted MIDlets only).

MIDlet-Push-n

O

O

Push static registration. For further information, see section Push applications.

MIDlet-specific attributes

O

O

MIDlet developers can provide limited configurability for MIDlets by including attributes that can be retrieved at runtime.

For example, you can create a custom JAD attribute and retrieve its value with the jar:GUID-0D0A1092-5037-4421-B466-B958CB777414.zip!/javax/microedition/midlet/MIDlet.html#getAppProperty(java.lang.String) method.


Last updated 9 October 2013

Back to top

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×