ParameterBundleStorageView

public interface ParameterBundleStorageView extends BundleStorageView

saker.nest.bundle.storage.ParameterBundleStorageView

saker.nest.bundle.storage.BundleStorageView

BundleStorageView subinterface that provides access to bundles specified by the configuration parameters.

The parameter bundle storage requires the user to specify one or more bundles to provide access to them through the storage view. The specified bundles will be copied to an implementation dependent internal storage location from where they are loaded into the storage view.

After a parameter storage view has been instantiated, the bundles specified by the parameters may be freely modified without affecting the loaded bundles.

See PARAMETER_NEST_REPOSITORY_BUNDLES for the way of specifying the bundles.

This interface is not to be implemented by clients.

NestBundleStorageConfiguration.getParameterStorages()

Fields

public static final String	DEFAULT_STORAGE_NAME = "params" The default name of a parameter bundle storage if omitted by the user in the configuration.
public static final String	PARAMETER_NEST_REPOSITORY_BUNDLES = "bundles" Parameter specifying the bundles that should be provided by the storage view.

Inherited methods
From: BundleStorageView getBundle, getBundleInformation, getStorage, getStorageViewKey, loadExternalArchives, lookupBundleIdentifiers, lookupBundleVersions

public static final String DEFAULT_STORAGE_NAME = "params"

The default name of a parameter bundle storage if omitted by the user in the configuration.

public static final String PARAMETER_NEST_REPOSITORY_BUNDLES = "bundles"

Parameter specifying the bundles that should be provided by the storage view.

The parameter must be prefixed by the repository identifier and storage name in the following format:

 <repo-id>.<storage-name>.<param>

The parameter value is a semicolon (;) separated list of bundle paths or wildcards. The bundle paths may be resolved either against the local file system, or against the path configuration of the build.

If a path is prefixed by double forward slashes (//), then the remaining part of the path will be interpreted against the local file system. Local file system paths must be absolute.

Extra semicolons in the parameter value are ignored.

E.g.

 lib/*.jar;///usr/lib/my-jar.jar;wd:/lib/build-lib.jar

The above configuration will result in using the following bundles:

lib/*.jar: All the bundles in the lib subdirectory of the working directory that has the .jar extension.
///usr/lib/my-jar.jar: Will use the /usr/lib/my-jar.jar from the local file system.
wd:/lib/build-lib.jar: Locates the bundle with the build execution path of wd:/lib/build-lib.jar. (Based on the path configuration.)

If the storage is not used in conjunction with a build execution then the path configuration depends on the environment that sets up the repository.

Note: Using the // prefix to specify local paths may not work when using build clusters.