Attribute (= default value)

Type

Description

uniqueID

UniqueID

A 16-byte identity value assigned to this installable component, typically at build time.

componentName

String

The name of the component; typically this is installJarName where installJarName is the name of the installable Jar file without the ".jar" extension.

version

String

An integer representing the component version number. The larger the number, the greater the version. Typically this is represented by the build number.

description

String

A simple text description of the component. This is typically used by a user trying to introspect a component.

executable

boolean

True if this is an executable component, false if not.

executableString

String

This is the string version of the main class for Java components. For non-Java components, this is the command to execute.

platform

String

For Java components, this is the target JVM for this program to run on (as described by java -version). For non-Java components, this is the platform/OS description.

SharedContainerHint = false

boolean

This is a hint as to whether this process should be run in a shared container. This initial value of the field is used by the install service to determine the resolved value.

restartHint = false

boolean

This field is a hint as to whether this component should be restarted if it fails. This initial value of the field is used by the install service to determine the resolved value.

bootProcessHint = false

boolean

This field is a hint as to whether this component should be started at boot time. This initial value of the field is used by the install service to determine the resolved value.

runImmediatelyHint = false

boolean

This field is a hint as to whether this component should be started immediately upon installation. The initial value of the field is used by the install service to determine the resolved value.

mobile = false

boolean

True if this component can be moved between containers during execution, false if not.

classpath

URL[]

For an executable component, this is the classpath to use for execution. For a non-executable component, this classpath contributes to other components which depend on this component. URLs themselves can be absolute or can contain dependencies, which are expressed as substitutions: ${<COMPONENT_NAME>!classpath}. Executable components can only depend on non-executable components.

codebase

URL[]

For an executable component, this is the codebase to use for execution. For a non-executable component, this codebase contributes to other components which depend on this component. URLs themselves can be absolute or can contain dependencies, which are expressed as substitutions: ${<COMPONENT_NAME>!codebase}

properties

Properties

This contains the properties to be passed to the JVM.

commandLineParameters

String

This contains the command line parameters to be passed to the JVM.

serveHint = false

boolean

This variable describes whether the installable Jar file containing this component should be published on a web server.

policyDirectory

String

This variable describes where the policy directory is located relative to installJar root. This is only used by the installer to understand the internal format of the install jar.

sourceDirectory

String

This variable describes where the source directory is located relative to installJar root. This is only used by the installer to understand the internal format of the install jar.

dataDirectory

String

This variable describes where the data directory is located relative to installJar root. Typically this directory is used by applications to hold large repositories of data.

docsDirectory

String

This variable describes where the docs directory is located relative to installJar root.  Any data in this directory will be published on the web server to make this component self-describing (javadocs, descriptions, specifications, etc). This should contain an index.html file.

libDirectory

String

This variable describes where the lib directory is located relative to installJar root. This directory contains the component's executable jar files.

httpDirectory

String

This variable describes where the http directory is located relative to installJar root.  Any data in this directory will be published on the web server and on the codebase of the component.

binDirectory

String

This variable describes where the bin directory is located relative to installJar root.  This directory contains any scripts this component may use. (Scripts are not required for simple everyday components—the information needed to run them is sufficiently specified in their component descriptors).

iconFile

String

The path to the icon resource for this component, relative to the installJar root.

resolvableCodebase

String[]

This field contains the resolvable codebase. This field can use parameter substitution.  The Openwings Install service processes the contents of this array and places the result into the codebase array.

resolvableClasspath

String[]

This field contains the resolvable classpath. This field can use parameter substitution.  The Openwings Install service processes the contents of this array and places the result into the classpath array.

installState = UNINSTALLED

int

This field contains the installation state of the component. This state will be one of the following: AUTHENTICATED, INSTALLED, RESOLVED, or UNINSTALLED. It is not editable and is set programmatically by Install Service.