Package io.bdeploy.api.product.v1

Class ApplicationDescriptorApi

java.lang.Object

io.bdeploy.api.product.v1.ApplicationDescriptorApi

public class ApplicationDescriptorApi
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_NAME	The name under which the ApplicationDescriptorApi can be found in a conforming application folder.
SortedSet<String>	runtimeDependencies	Additional dependencies of the application.
List<OsHelper.OperatingSystem>	supportedOperatingSystems	Operating systems which are supported by this app-info.yaml.

Constructor Summary

Constructors

Constructor	Description
ApplicationDescriptorApi()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FILE_NAME

public static final String FILE_NAME

The name under which the ApplicationDescriptorApi can be found in a conforming application folder.

See Also:

• Constant Field Values

supportedOperatingSystems

@JsonPropertyDescription("The supported operating systems this application can run on.")
public List<OsHelper.OperatingSystem> supportedOperatingSystems

Operating systems which are supported by this app-info.yaml.

The purpose of this information is solely verification of product configuration during creation of products which include platform specific applications.

runtimeDependencies

@JsonPropertyDescription("A set of dependencies which must be included in the product along with the application. These dependencies can be referenced from commands, parameters, etc. using variable expansion.")
public SortedSet<String> runtimeDependencies

Additional dependencies of the application.

Runtime dependencies are resolved at two points in time:

• When creating a product which includes this application. The product always includes applications for a specific operating system, thus this operating system is used to resolve dependencies.
• When creating an InstanceNodeManifest which includes this application for a specific (the node's) operating system, in which case the dependency is resolved against the actual OS.

The dependency must include a name and a tag. This name and tag are used to construct ScopedManifestKeys which are os specific, using the OS provided by the current context.

Constructor Details

ApplicationDescriptorApi

public ApplicationDescriptorApi()