Serialized Form

Package org.apache.maven.buildcache.checksum

Exception org.apache.maven.buildcache.checksum.DependencyNotResolvedException

class DependencyNotResolvedException extends RuntimeException implements Serializable

Package org.apache.maven.buildcache.xml.build

Class org.apache.maven.buildcache.xml.build.Artifact

class Artifact extends Object implements Serializable

Serialized Fields

artifactId

String artifactId

Field artifactId.

classifier

String classifier

Field classifier.

fileHash

String fileHash

Field fileHash.

fileName

String fileName

Field fileName.

filePath

String filePath

Field filePath.

fileSize

long fileSize

Field fileSize.

groupId

String groupId

Field groupId.

scope

String scope

Field scope.

type

String type

Field type.

version

String version

Field version.

Class org.apache.maven.buildcache.xml.build.Build

class Build extends Object implements Serializable

Serialized Fields

_final

Boolean _final

Field _final.

artifact

Artifact artifact

Field artifact.

attachedArtifacts

List<Artifact> attachedArtifacts

Field attachedArtifacts.

buildServer

String buildServer

Field buildServer.

buildTime

Date buildTime

Field buildTime.

cacheImplementationVersion

String cacheImplementationVersion

Field cacheImplementationVersion.

executions

List<CompletedExecution> executions

Field executions.

goals

List<String> goals

Field goals.

hashFunction

String hashFunction

Field hashFunction.

modelEncoding

String modelEncoding

Field modelEncoding.

projectsInputInfo

ProjectsInputInfo projectsInputInfo

Field projectsInputInfo.

scm

Scm scm

Field scm.

Class org.apache.maven.buildcache.xml.build.CompletedExecution

class CompletedExecution extends Object implements Serializable

Serialized Fields

executionKey

String executionKey

Field executionKey.

mojoClassName

String mojoClassName

Field mojoClassName.

properties

List<PropertyValue> properties

Field properties.

Class org.apache.maven.buildcache.xml.build.DigestItem

class DigestItem extends Object implements Serializable

Serialized Fields

charset

String charset

Field charset.

content

String content

Field content.

eol

String eol

Field eol.

fileChecksum

String fileChecksum

Field fileChecksum.

hash

String hash

Field hash.

isText

String isText

Field isText.

type

String type

Field type.

value

String value

Field value.

Class org.apache.maven.buildcache.xml.build.ProjectsInputInfo

class ProjectsInputInfo extends Object implements Serializable

Serialized Fields

checksum

String checksum

Field checksum.

items

List<DigestItem> items

Field items.

Class org.apache.maven.buildcache.xml.build.PropertyValue

class PropertyValue extends Object implements Serializable

Serialized Fields

name

String name

Field name.

tracked

Boolean tracked

Field tracked.

value

String value

Field value.

Class org.apache.maven.buildcache.xml.build.Scm

class Scm extends Object implements Serializable

Serialized Fields

revision

String revision

Field revision.

sourceBranch

String sourceBranch

Field sourceBranch.

Package org.apache.maven.buildcache.xml.config

Class org.apache.maven.buildcache.xml.config.AttachedOutputs

class AttachedOutputs extends Object implements Serializable

Serialized Fields

dirNames

List<DirName> dirNames

Field dirNames.

preservePermissions

boolean preservePermissions

Preserve Unix file permissions when saving/restoring attached outputs. When enabled, permissions are stored in ZIP entry headers and become part of the cache key, ensuring cache invalidation when permissions change. This is similar to how Git includes file mode in tree hashes. Disabling this may improve portability across different systems but will not preserve executable bits.

Class org.apache.maven.buildcache.xml.config.CacheConfig

class CacheConfig extends Object implements Serializable

Serialized Fields

configuration

Configuration configuration

Configuration of main cache properties.

executionControl

ExecutionControl executionControl

Execution rules for plugins in cached mode. Defines which plugins should run always.

input

Input input

Configuration for source code input files participating in checksum calculation.

modelEncoding

String modelEncoding

Field modelEncoding.

output

Output output

Configuration for output artifacts, it's needed if you want to explicitly include/exclude something from caching.

Class org.apache.maven.buildcache.xml.config.Configuration

class Configuration extends Object implements Serializable

Serialized Fields

attachedOutputs

AttachedOutputs attachedOutputs

Field attachedOutputs.

debugs

List<String> debugs

Field debugs.

enabled

boolean enabled

Field enabled.

hashAlgorithm

String hashAlgorithm

One of XX, XXMM, METRO, METRO+MM, SHA-1, SHA-256, SHA-384, SHA-512.

local

Local local

Field local.

mandatoryClean

boolean mandatoryClean

Enable the cache storing ability only if a build went through the clean lifecycle.

multiModule

MultiModule multiModule

Specifies related to multi module projects configuration.

projectVersioning

ProjectVersioning projectVersioning

Specifies parameters to handle project version changes.

remote

Remote remote

Field remote.

validateXml

boolean validateXml

Validate cache config and builds metadata against xsd. TODO: not implemented .

Class org.apache.maven.buildcache.xml.config.CoordinatesBase

class CoordinatesBase extends Object implements Serializable

Serialized Fields

artifactId

String artifactId

Field artifactId.

groupId

String groupId

Field groupId.

Class org.apache.maven.buildcache.xml.config.DirName

class DirName extends Object implements Serializable

Serialized Fields

glob

String glob

Entries are filtered by matching this glob.

value

String value

Directory name in build output directory to attach to cached artifacts.

Class org.apache.maven.buildcache.xml.config.DirScanConfig

class DirScanConfig extends Object implements Serializable

Serialized Fields

excludes

List<TagExclude> excludes

Field excludes.

ignoreParent

boolean ignoreParent

Ignore parent settings or inherit and merge.

includes

List<TagScanConfig> includes

Field includes.

mode

String mode

Either 'auto' (scan directory accordingly to cache implementation) or 'skip' (skip directory).

tagScanConfigs

List<TagScanConfig> tagScanConfigs

Field tagScanConfigs.

Class org.apache.maven.buildcache.xml.config.Discovery

class Discovery extends Object implements Serializable

Serialized Fields

scanProfiles

List<String> scanProfiles

Field scanProfiles.

Class org.apache.maven.buildcache.xml.config.EffectivePom

class EffectivePom extends Object implements Serializable

Serialized Fields

excludeProperties

List<String> excludeProperties

Field excludeProperties.

Class org.apache.maven.buildcache.xml.config.Exclude

class Exclude extends Object implements Serializable

Serialized Fields

entryType

String entryType

Type of entries filtered. One of FILE, DIRECTORY, ALL. Excluding a directory excludes its subfiles and subdirectories.

glob

String glob

Entries are filtered by matching this glob (see matcherType property).

matcherType

String matcherType

The entry property matched for exclusion. One of FILENAME, PATH. For a path, if the exclusion value is empty or a relative path, matching is done relatively to the project folder.

value

String value

An absolute or relative path to a filename or a directory. In the later case, the exclusion is applied starting from this directory (can be beneficial in term of performances). If empty, the glob is applied on every file listed as a potential part of the checksum.

Class org.apache.maven.buildcache.xml.config.Executables

class Executables extends Object implements Serializable

Serialized Fields

executions

List<ExecutionIdsList> executions

Field executions.

goalsLists

List<GoalsList> goalsLists

Field goalsLists.

plugins

List<PluginSet> plugins

Field plugins.

Class org.apache.maven.buildcache.xml.config.ExecutionConfigurationScan

class ExecutionConfigurationScan extends Object implements Serializable

Serialized Fields

dirScan

DirScanConfig dirScan

Specifies rules of configuration processing in search of referenced source files.

execIds

List<String> execIds

Field execIds.

ignoreParentConfig

boolean ignoreParentConfig

ignore parent config or inherit/merge.

Class org.apache.maven.buildcache.xml.config.ExecutionControl

class ExecutionControl extends Object implements Serializable

Serialized Fields

ignoreMissing

Executables ignoreMissing

Specify which executions/plugins/goals do not affect generated artifacts and do not affect build correctness. If cached build lacks of ignorable executions only, it still could be reused. Typically case is then cached build is produced with 'verify' and you locally you run 'install'. Strictly speaking these are different builds but in most of cases you want this difference to be ignored .

reconcile

Reconcile reconcile

Specify which plugin should run always if present in build regardless of cached status.

runAlways

Executables runAlways

Specify which plugin should run always if present in build regardless of cached status.

Class org.apache.maven.buildcache.xml.config.ExecutionIdsList

class ExecutionIdsList extends CoordinatesBase implements Serializable

Serialized Fields

execIds

List<String> execIds

Field execIds.

Class org.apache.maven.buildcache.xml.config.GoalId

class GoalId extends CoordinatesBase implements Serializable

Serialized Fields

goal

String goal

Field goal.

Class org.apache.maven.buildcache.xml.config.GoalReconciliation

class GoalReconciliation extends GoalId implements Serializable

Serialized Fields

logAll

boolean logAll

Controls if all plugin properties to be logged (true is default). All the properties logged with respect to log/nolog children: * true: logged all if no blacklists (<nolog/>) and whitelists (<log/>) specified on plugin level * false: logged only tracked and included by whitelists (<log/>) on plugin level .

logs

List<PropertyName> logs

Field logs.

nologs

List<PropertyName> nologs

Field nologs.

reconciles

List<TrackedProperty> reconciles

Field reconciles.

Class org.apache.maven.buildcache.xml.config.GoalsList

class GoalsList extends CoordinatesBase implements Serializable

Serialized Fields

goals

List<String> goals

Field goals.

Class org.apache.maven.buildcache.xml.config.Include

class Include extends Object implements Serializable

Serialized Fields

glob

String glob

Files in a directory are filtered by matching their names against this glob.

recursive

boolean recursive

Will search in sub-folders if set to true.

value

String value

Path to add to the checksum computation.

Class org.apache.maven.buildcache.xml.config.Input

class Input extends Object implements Serializable

Serialized Fields

global

PathSet global

Global input calculation rules applicable to all projects and plugins in the build.

plugins

List<PluginConfigurationScan> plugins

Field plugins.

Class org.apache.maven.buildcache.xml.config.Local

class Local extends Object implements Serializable

Serialized Fields

location

String location

The base directory where the local cache is located. Defaults to ~/.m2/build-cache/.

maxBuildsCached

int maxBuildsCached

Maximum number of cached build per artifact in local cache. First created cache (the oldest) is evicted if breached.

Class org.apache.maven.buildcache.xml.config.MultiModule

class MultiModule extends Object implements Serializable

Serialized Fields

discovery

Discovery discovery

Section to specify how to discover multi module projects.

Class org.apache.maven.buildcache.xml.config.Output

class Output extends Object implements Serializable

Serialized Fields

exclude

OutputExclude exclude

Patterns to exclude output artifacts applicable to all projects in the build.

Class org.apache.maven.buildcache.xml.config.OutputExclude

class OutputExclude extends Object implements Serializable

Serialized Fields

patterns

List<String> patterns

Field patterns.

Class org.apache.maven.buildcache.xml.config.PathSet

class PathSet extends Object implements Serializable

Serialized Fields

excludes

List<Exclude> excludes

Field excludes.

glob

String glob

Type of files to globally scan. All types are scanned by default. Example to scan only java and xml files : {*.java,*.xml}

includes

List<Include> includes

Field includes.

Class org.apache.maven.buildcache.xml.config.PluginConfigurationScan

class PluginConfigurationScan extends CoordinatesBase implements Serializable

Serialized Fields

dirScan

DirScanConfig dirScan

Specifies plugin level rules of configuration processing in search of referenced source files.

effectivePom

EffectivePom effectivePom

Effective pom calculation rules.

excludeDependencies

boolean excludeDependencies

True to exclude plugin dependencies from the calculation rules.

executions

List<ExecutionConfigurationScan> executions

Field executions.

Class org.apache.maven.buildcache.xml.config.PluginSet

class PluginSet extends CoordinatesBase implements Serializable

Class org.apache.maven.buildcache.xml.config.ProjectVersioning

class ProjectVersioning extends Object implements Serializable

Serialized Fields

adjustMetaInf

boolean adjustMetaInf

Determines whether version in metadata must be changed according to building project version.

calculateProjectVersionChecksum

boolean calculateProjectVersionChecksum

Determines whether project version should be included to calculate checksum input.

Class org.apache.maven.buildcache.xml.config.PropertyName

class PropertyName extends Object implements Serializable

Serialized Fields

propertyName

String propertyName

Field propertyName.

value

String value

Field value.

Class org.apache.maven.buildcache.xml.config.Reconcile

class Reconcile extends Object implements Serializable

Serialized Fields

logAllProperties

boolean logAllProperties

Controls if all plugin properties to be logged (true is default). All the properties logged with respect to children: * logAll on plugin level overrides global value * true: logged all if no blacklists (<nolog/>) and whitelists (<log/>) specified on plugin level * false: logged only tracked and included by whitelists (<log/>) on plugin level <log/> .

plugins

List<GoalReconciliation> plugins

Field plugins.

Class org.apache.maven.buildcache.xml.config.Remote

class Remote extends Object implements Serializable

Serialized Fields

enabled

boolean enabled

Field enabled.

id

String id

The repository id used to find authentication / mirror information in maven settings, default to 'cache'.

saveToRemote

boolean saveToRemote

Save output to remote cache. Recommended to enable on CI agents only.

transport

String transport

The transport to use, currently, only 'resolver' is supported

url

String url

Address of remote cache.

Class org.apache.maven.buildcache.xml.config.TagExclude

class TagExclude extends Object implements Serializable

Serialized Fields

tagName

String tagName

Field tagName.

Class org.apache.maven.buildcache.xml.config.TagScanConfig

class TagScanConfig extends TagExclude implements Serializable

Serialized Fields

glob

String glob

Field glob.

recursive

boolean recursive

Field recursive.

Class org.apache.maven.buildcache.xml.config.TrackedProperty

class TrackedProperty extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

Field defaultValue.

propertyName

String propertyName

Field propertyName.

skipValue

String skipValue

Field skipValue.

value

String value

Field value.

Package org.apache.maven.buildcache.xml.diff

Class org.apache.maven.buildcache.xml.diff.Diff

class Diff extends Object implements Serializable

Serialized Fields

mismatches

List<Mismatch> mismatches

Field mismatches.

modelEncoding

String modelEncoding

Field modelEncoding.

Class org.apache.maven.buildcache.xml.diff.Mismatch

class Mismatch extends Object implements Serializable

Serialized Fields

baseline

String baseline

Field baseline.

context

String context

Field context.

current

String current

Field current.

detail

List<MismatchDetail> detail

Field detail.

item

String item

Field item.

reason

String reason

Field reason.

resolution

String resolution

Field resolution.

Class org.apache.maven.buildcache.xml.diff.MismatchDetail

class MismatchDetail extends Object implements Serializable

Package org.apache.maven.buildcache.xml.report

Class org.apache.maven.buildcache.xml.report.CacheReport

class CacheReport extends Object implements Serializable

Serialized Fields

modelEncoding

String modelEncoding

Field modelEncoding.

projects

List<ProjectReport> projects

Field projects.

Class org.apache.maven.buildcache.xml.report.ProjectReport

class ProjectReport extends Object implements Serializable

Serialized Fields

artifactId

String artifactId

Field artifactId.

checksum

String checksum

Field checksum.

checksumMatched

Boolean checksumMatched

Field checksumMatched.

groupId

String groupId

Field groupId.

lifecycleMatched

Boolean lifecycleMatched

Field lifecycleMatched.

pluginsMatched

Boolean pluginsMatched

Field pluginsMatched.

sharedToRemote

Boolean sharedToRemote

Field sharedToRemote.

source

String source

Field source.

url

String url

Field url.