Tag/Attribute |
Description |
all-permissions
|
Indicates that the application needs full access to the local system and network. |
applet-desc
|
Describes how to startup a Java applet. Contains information about main class, parameters, size and more.
|
main-class=class
, required |
Describes the name of the main applet class without the .class extension. |
name=name
, required |
Describes the name of the applet. |
width=pixels
, required |
Describes the width of the applet in pixels. |
height=pixels
, required |
Describes the height of the applet in pixels. |
documentbase=url
, optional |
Describes the documentbase for the applet as a URL. |
application-desc
|
Describes how to startup a Java application. Contains information about the main class and arguments.
|
main-class=class
, optional |
Describes the main class of the app.
Note, that you can only leave out the main class attribute if the first jar in the jnlp file contains a manifest containing the main class.
|
argument
|
Describes the ordered set of arguments that will be passed into the main method of the application's main class. |
component-desc
|
Specifies a component extension.
|
description
|
Describes the application in a single line, in a paragraph or in a couple of words for a tooltip. |
kind=one-line|short|tooltip , optional |
Indicates the use of a description element.
i) one-line , for a one-line description,
ii) short , for a one paragraph description, and
iii) tooltip , for a tool-tip description.
Longer descriptions should be put on a separate web page and referred to using the
homepage element.
|
ext-download
|
Defines how parts of the extension are downloaded. |
ext-part=name
, required |
Describes the name of a part in the extension. |
download=lazy|eager , optional |
Describes if the resource may be downloaded lazily, that is, on demand.
default value is eager . |
part=name
, optional |
Describes the name of the part it belongs to. |
extension
|
Describes a component or installer extension that is required to run the app. |
href=url
, required |
Specifies the location of the extension. |
version=version
, optional |
Specifies the version of the extension. |
name=name
, optional |
Specifies the name of the extension. |
homepage
|
Contains a web address to the application's homepage. |
href=url
, required |
Specifies the URL for the homepage. Web Start's Application Manager uses href to point the user
to a web page where she can read more about the application.
|
icon
|
Describes an icon/image for the application. |
href=url
, required |
Contains a URL to a web location containing an image or an icon. Only JPEG and GIF graphic formats are supported. |
version=version
, optional |
Specifies the version of the image. |
width=pixels
, optional |
Describes the width of the icon in pixels. |
height=pixels
, optional |
Describes the height of the icon in pixels. |
kind=default|selected|disabled|rollover , optional |
Describes the use of the icon. Default value is default . |
depth=number
, optional |
Describes the color depth of the image in bits-per-pixel. Common values are 8, 16, or 24. |
size=bytes
, optional |
Specifies the size of the image in bytes. |
information
|
Contains various descriptive information about the application such as title, vendor and homepage.
|
locale=locale
, optional |
Specifies the locale for which this information section should be used.
Locales describe a specific geographic, political, or cultural region in the format below:
language [ _COUNTRY [ _VARIANT ]]
The language is specified using two-letter, lowercase ISO-639 language codes
and the optional country is specified using two-letter, uppercase ISO-3166 country codes.
The variant is currently used to support the Euro currency using EURO .
See Locale Codes for different predefined language-country-variant combinations.
|
installer-desc
|
Specifies an installer extension.
|
main-class=class
, optional |
Describes the main class for the installer/uninstaller. |
j2ee-application-client-permissions
|
Indicates that the application needs the set of permissions defined for J2EE client apps. |
j2se
|
Describes a supported JRE version that the application can run on. |
version=versions
, required |
Describes the versions of the JRE that the application runs on. Separate version ids with spaces. |
href=url
, optional |
Specifies the location where to download the JRE. |
initial-heap-size=bytes, kilos, megs
, optional |
Specifies the initial size of the object heap for the Java Virtual Machine.
You can use the modifiers m and k for megabytes and kilobytes, respectively.
For example, 128m will be the same as 134217728 (128*1024*1024).
Both lower case (m ) and upper case (M ) are supported.
|
max-heap-size=bytes, kilos, megs
, optional |
Specifies the preferred maximum size of the object heap for the Java Virtual Machine.
Use the modifiers m and k for megabytes and kilobytes, respectively.
|
jar
|
Describes a jar file. |
href=url
, required |
Specifies the location of the jar. |
version=version
, optional |
Describes the version of the jar. |
main=true|false , optional |
Indicates if the jar contains the main class. Default value is false .
Note, that the jar containing the main class must be the first jar listed in the resources section.
|
download=eager|lazy , optional |
Indicates if the jar must be downloaded before an application is launched (eager ), or not (lazy ).
Default value is eager .
|
size=bytes
, optional |
Specifies the size of a jar in bytes.
|
part=name
, optional |
Describes the name of the group the jar belongs to.
|
jnlp
|
The jnlp file's one and only root . |
spec=version
, optional |
Specifies what versions of the jnlp spec a jnlp file works with.
The default value is 1.0+. Thus, you can typically leave it out.
|
version=version
, optional |
Specifies the version of the application as well as the version of the jnlp file itself. |
codebase=url
, optional |
Specifies the codebase for the application. Codebase is also used as base URL
for all relative URLs in href attributes.
|
href=url
, optional |
Contains the location of the jnlp file as a URL.
If you leave out the href attribute, Web Start will disable the update check on your JNLP file,
and Web Start will not treat each new JNLP file as an application update - only updated jar files will.
Leaving out href
usually makes only sense if your jnlp file is created dynamically (that is, throug a cgi-script, for example) and if
your jnlp file's arguments or properties change from request to request (user to user).
Note, that Java Web Start needs href to list your app in the Web Start Application Manager.
|
nativelib
|
Describes a jar containing native libraries (e.g. .dll , .so ). |
href=url
, required |
Specifies the location of the jar containing native libraries. |
version=version
, optional |
Describes the version of the jar containing native libraries. |
download=eager|lazy , optional |
Indicates if native libraries must be downloaded before application is launched (eager ), or not (lazy ).
Default value is eager .
|
size=bytes
, optional |
Specifies the size of the jar containing native libraries. |
part=name
, optional |
Describes the name of the part the native libraries belong to. |
offline-allowed
|
Indicates if the application can be started offline (that is, without a connection to the originating server).
|
package
|
Defines a relationship between a Java package or class name and a part. |
name=name
, required |
Describes the name of a package or class. |
part=name
, required |
Describes the part that holds the specified package or class. |
recursive=true|false , optional |
Indicates if all subpackages of this package are also included. Default value is false . |
param
|
Describes a parameter to an applet. |
name=name
, required |
Describes the name of the parameter. |
value=value
, required |
Describes the value of the parameter. |
property
|
Describes a name/value pair that is available to the application as a system property. |
name=name
, required |
Describes the name of a system property. |
value=value
, required |
Describes the value of a system property. |
resources
|
Contains an ordered set of resources that make up an application.
|
os=os
, optional |
Specifies for which operating system resources section applies.
Values are valid as long as they match the values returned by the system properties os.name .
Values that only match the beginning of os.name are also valid
(e.g. if you specify Windows and the os.name is Windows 98, for example, everything works out fine).
See
os and arch Codes for os values for various operating systems.
Note, that a space that is part of the key must be preceded with a backslash (\ ). For example,
Windows\ 95 Window \98 specifies Windows 95 and Windows 98 .
|
arch=arch
, optional |
Specifies for what processor architecture resources section applies.
Values are valid as long as they match the values returned by the system properties os.arch .
See
os and arch Codes for arch values for various architectures.
|
locale=locale
, optional |
Specifies for which locales resources section applies.
Locales describe a specific geographic, political, or cultural region in the format below:
language [ _COUNTRY [ _VARIANT ]]
The language is specified using two-letter, lowercase ISO-639 language codes
and the optional country is specified using two-letter, uppercase ISO-3166 country codes.
The variant is currently used to support the Euro currency using EURO .
See Locale Codes for different predefined language-country-variant combinations.
|
security
|
Describes the application's security requirements.
|
title
|
Contains the application's name. |
vendor
|
Contains the vendor's name. |