[guide] <almsdef>

The <almsdef> component lets you define custom settings for an ALMS instance. You must always associate an ALMS configuration object must with an ALMS instance through an ALMS dependent catalog; by itself, a ALMS configuration has no useful function. The two most important ALMS dependent catalogs are artifactdef catalogs and reactiondef catalogs.

Parameters

Nested Element: <searchpath>^[0..1]

The <searchpath> element lets you define a custom antlib search strategy for the ALMS instance. This element is the local name for a standard ALMS search path definition; read the <alms-searchpath> guide for a full description.

Nested Element: <storagepolicy>^[0..1]

The <storagepolicy> element lets you define a custom storage policy for the ALMS instance. This element is the local name for a standard ALMS storage policy definition; read the <alms-storagepolicy> guide for a full description.

Nested Element: <postfilters>^[0..1]

The <postfilters> element lets you define custom post filtering for downloaded antlib packages. This element is the local name for a standard ALMS module filters definition; read the <alms-postfilters> guide for a full description.

Examples

The following snippet declares a standalone <almsdef> that any number of ALMS dependent catalogs can use. The postfilter arms/metastamp is a builtin filter that tells SAM to create a special info file in each downloaded antlib’s local directory. In turn, this file will be used by the downloaded-today up-to-date test to determine if SAM should re-download a fresh copy of the antlib package.

    <?xml version="1.0"?>
    <run-configuration>
        …
        <almsdef id="ARMs.alms">
            <storagepolicy
                scratchdir="${build.scratch.dir}"
                uploads="local-antlibs"
                uptodate="downloaded-today"/>
            <searchpath
                <dirset dir="${build.libs.dir}">
                    <include name="vendorABC-latest"/>
                    <include name="vendor123-stable"/>
                </dirset>
                <defaultsearchpath/>
            </searchpath>
            <postfilters>
                <module name="*">
                    <filter name="arms/metastamp"
                        haltiferror="yes"/>
                </module>
            </postfilters>
        </almsdef>
        …
    </run-configuration>

Related Topics

• The ALMSDef Java class implements <almsdef>.
• The <fixturedef> task lets you load an <almsdef> defined as part of an antlib.
• Both <add-artifactdefs> and <add-reactiondefs> use storage policies to configure their ALMS instances.