Development Kit User's Guide

This chapter describes creating and validating a Java Card technology-based application module with the Packager tool (Packager). See Chapter 3 to better understand the role and relationship between the Packager and the other Development Kit tools used in developing applications for the Java Card 3 platform.

This chapter contains the following sections:

• Packager Operation
• Running the Packager from the Command Line

---

Packager Operation

When creating an application module, the Packager takes a specified folder containing the files for the application module, validates the input files and creates the application module archive file. If a web application contains JAR files in the lib directory, the Packager creates a corresponding library module in the application module.

Each application module can have a descriptor as a part of the MANIFEST.MF file that specifies application module declarative items. In cases where an application module has a descriptor, the descriptor information must be validated and preserved.

Options

The following are options of the Packager:

• Modules can be passed to the Packager as paths to directories containing the corresponding structure.
• Manifest files with information contained in an input module folder are preserved without change.

Basic Packaging Sequence

The Packager creates an application module JAR file from input by performing the following actions:

1. Input files are extracted into a temp folder under a folder named either with the input file name or a name specified as a command line parameter.

2. Application module file types are checked and the application module type is determined.

3. A type entry is added to the application module.

4. The application module is placed under the temp folder.

If an optional keystore file is specified in the command line parameter, verified information from it is added to the resulting application module.

5. The entire contents are grouped together to create the final application module JAR file.

Use Cases

TABLE 7-1 provides a description of the possible Packager input files and corresponding output conditions.

Signing

The Packager can invoke the appropriate tools automatically to sign the application module JAR file. See create Subcommand. For information about creating a custom keystore that can be used to sign the application module JAR file, see Chapter 12.External signing tools can also be used to sign the modules if the user knows about those tools.

The Packager assumes that the keystore has everything needed in it and simply invokes the jarsigner to sign the module.

Use Cases

TABLE 7-2 provides a description of the possible Packager signing input and corresponding output conditions

---

Running the Packager from the Command Line

The command line interface for the Packager has the following syntax:

packager.bat subcommand [options] module-or-folder

The following is a list of the available subcommands for the Packager:

• create Subcommand
• validate Subcommand
• copyright Subcommand
• help Subcommand

create Subcommand

Creates the application module or library from a given module or folder.

create Subcommand Options

TABLE 7-3 identifies the create subcommand options and provides their descriptions.

--force Option Behavior

The --force option affects the following aspects of the Packager’s behavior:

• If the manifest file is missed in a passed application module, the Packager warns the user and tries to gather required information and other available information (such as mandatory attributes defined in the specification, names of passed modules, and web application private libraries).
• If the runtime descriptor of a passed application module(s) and/or an external runtime descriptor contains unsupported information for determined module type, this information is removed (with appropriate warnings).
• If mandatory information is missed in runtime descriptor files, the Packager tries to add it (with appropriate warnings).
• If specified destination directory does not exists, the Packager creates it.
• If the specified output JAR file exists, the Packager overwrites it.

create Subcommand Format

The following is an example of the create subcommand format:

packager.bat create --out file-name [--type file-type] [--exportpath path-of-export-files] [--packageaid package-AID-for-classic-lib] \
	[--sign --storepass keystore-password --passkey key-password 	--alias alias] [--compress] [--force] [--nowarn] module- file-or-folder

create Subcommand Examples

Two examples are provided, an example of the output option and an example of the signing option.

Output Option Example

The following is an example of the create subcommand with the output option:

packager.bat create -o mymodule.jar -t web -c c:\mymodulefolder

In this command line example, the Packager performs the following tasks:

1. Extracts the contents of mymodulefolder directory to a temporary folder under the subdirectory mymodulefolder .

2. Creates corresponding Web Application Module object and performs validation and canonicalization of all xml descriptors.

3. Creates a META-INF/MANIFEST.MF file with required information (such as application name).

4. Compresses the contents of the temporary folder to c:\temp\mymodule.jar .

Signing Option Example

The following is an example of the create subcommand with the output option:

packager.bat create -o mymodule.jar -t web --sign --keystore c:\mykeystore\c.keystore --storepass demo 	--keypass mykey --alias jckey  -c c:\mymodulefolder

in addition to those tasks described in the previous example, the Packager in this command line example signs the application using the keystore from c:\mykeystore\c.keystore by performing the following:

• Provides the password ( demo ) for the mykeystore keystore.
• Provides the password ( mykey ) for the private c.keystore key.
• Provides the name (jckey) required to retrieve the key from the keystore.

validate Subcommand

Validates an application module.

validate Subcommand Options

The validate subcommand has a single option, -t or --type , used to specify the type of application module or group to be validated. The type can be web , extended-applet , classic-applet , classic-lib , or extension-lib .

validate Subcommand Format

The following is an example of the validate subcommand format where type can be web , extended-applet , or classic-applet :

packager.bat validate [--type type] module-file-name (or module-directory-name)

validate Subcommand Example

The following is an example of the validate subcommand:

packager.bat validate -t web myapp.war

In this command line example, the Packager performs the following tasks:

1. Extracts the contents of myapp.war application module to a temporary folder.

2. Validates the contents of the descriptors.

3. Validates that the classes specified in the descriptors actually exist in the application module.

4. Cross validates the descriptors.

5. Displays results of validation.

copyright Subcommand

Displays the detailed copyright notice.

copyright Subcommand Options

There are no options for the copyright subcommand.

copyright Subcommand Format

The following is an example of the copyright subcommand format:

packager.bat copyright

copyright Subcommand Example

The following is an example of the copyright subcommand:

packager.bat copyright

help Subcommand

Prints information about using subcommands.

help Subcommand Options

While there are no options for the help subcommand, it does accept a topic attribute consisting of a specific subcommand name for which detailed information is displayed.

help Subcommand Format

The following is an example of the help subcommand format:

packager.bat help subcommand

help Subcommand Example

The following is an example of the help subcommand:

packager.bat help validate

Use Cases

TABLE 7-4 provides use cases for the command line arguments and describes the expected output for each.

Development Kit User's Guide

May 2009

Copyright © 2009 Sun Microsystems, Inc. All rights reserved.