Package org.apache.maven.buildcache.xml

Class CacheConfigImpl

java.lang.Object

org.apache.maven.buildcache.xml.CacheConfigImpl

All Implemented Interfaces:

CacheConfig

@Named
public class CacheConfigImpl
extends Object
implements CacheConfig

CacheConfigImpl

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALWAYS_RUN_PLUGINS
static final String	BASELINE_BUILD_URL_PROPERTY_NAME
static final String	CACHE_ENABLED_PROPERTY_NAME
static final String	CACHE_LOCATION_PROPERTY_NAME
static final String	CACHE_SKIP	Flag to control if we should skip lookup for cached artifacts globally or for a particular project even if qualifying artifacts exist in build cache.
static final String	CONFIG_PATH_PROPERTY_NAME
static final String	FAIL_FAST_PROPERTY_NAME
static final String	LAZY_RESTORE_PROPERTY_NAME
static final String	MANDATORY_CLEAN
static final String	REMOTE_ENABLED_PROPERTY_NAME
static final String	REMOTE_SERVER_ID_PROPERTY_NAME
static final String	REMOTE_URL_PROPERTY_NAME
static final String	RESTORE_GENERATED_SOURCES_PROPERTY_NAME
static final String	RESTORE_ON_DISK_ARTIFACTS_PROPERTY_NAME
static final String	SAVE_NON_OVERRIDEABLE_NAME
static final String	SAVE_TO_REMOTE_PROPERTY_NAME
static final String	SKIP_SAVE	Flag to disable cache saving

Constructor Summary

Constructors

Constructor	Description
CacheConfigImpl(XmlService xmlService, javax.inject.Provider<org.apache.maven.execution.MavenSession> providerSession, org.apache.maven.rtinfo.RuntimeInformation rtInfo)

Method Summary

Modifier and Type	Method	Description
boolean	adjustMetaInfVersion()
boolean	calculateProjectVersionChecksum()
boolean	canIgnore(org.apache.maven.plugin.MojoExecution mojoExecution)
String	getAlwaysRunPlugins()
List<DirName>	getAttachedOutputs()
String	getBaselineCacheUrl()
String	getDefaultGlob()
List<String>	getEffectivePomExcludeProperties(org.apache.maven.model.Plugin plugin)
List<Pattern>	getExcludePatterns()
PluginScanConfig	getExecutionDirScanConfig(org.apache.maven.model.Plugin plugin, org.apache.maven.model.PluginExecution exec)
List<Exclude>	getGlobalExcludePaths()
List<Include>	getGlobalIncludePaths()
HashFactory	getHashFactory()
String	getId()
String	getLocalRepositoryLocation()
List<PropertyName>	getLoggedProperties(org.apache.maven.plugin.MojoExecution mojoExecution)
int	getMaxLocalBuildsCached()
MultiModule	getMultiModule()
List<PropertyName>	getNologProperties(org.apache.maven.plugin.MojoExecution mojoExecution)
PluginScanConfig	getPluginDirScanConfig(org.apache.maven.model.Plugin plugin)
List<TrackedProperty>	getTrackedProperties(org.apache.maven.plugin.MojoExecution mojoExecution)
String	getTransport()
String	getUrl()
CacheState	initialize()
boolean	isBaselineDiffEnabled()
boolean	isEnabled()
boolean	isFailFast()
boolean	isForcedExecution(org.apache.maven.plugin.MojoExecution execution)
boolean	isLazyRestore()	Artifacts restore policy.
boolean	isLogAllProperties(org.apache.maven.plugin.MojoExecution mojoExecution)
boolean	isMandatoryClean()	Flag to save in cache only if a build went through the clean lifecycle
boolean	isPluginDependenciesExcluded(org.apache.maven.model.Plugin plugin)
boolean	isPreservePermissions()
String	isProcessPlugins()
boolean	isRemoteCacheEnabled()
boolean	isRestoreGeneratedSources()	Flag to restore (default) or not generated sources as it might be desired to disable it in continuous integration scenarios
boolean	isRestoreOnDiskArtifacts()	Flag to restore (default) or not generated artifacts
boolean	isSaveToRemote()
boolean	isSaveToRemoteFinal()
boolean	isSkipCache()
boolean	isSkipSave()	Flag to disable cache saving

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_PATH_PROPERTY_NAME

public static final String CONFIG_PATH_PROPERTY_NAME

See Also:

• Constant Field Values

CACHE_ENABLED_PROPERTY_NAME

public static final String CACHE_ENABLED_PROPERTY_NAME

See Also:

• Constant Field Values

CACHE_LOCATION_PROPERTY_NAME

public static final String CACHE_LOCATION_PROPERTY_NAME

See Also:

• Constant Field Values

REMOTE_ENABLED_PROPERTY_NAME

public static final String REMOTE_ENABLED_PROPERTY_NAME

See Also:

• Constant Field Values

REMOTE_URL_PROPERTY_NAME

public static final String REMOTE_URL_PROPERTY_NAME

See Also:

• Constant Field Values

REMOTE_SERVER_ID_PROPERTY_NAME

public static final String REMOTE_SERVER_ID_PROPERTY_NAME

See Also:

• Constant Field Values

SAVE_TO_REMOTE_PROPERTY_NAME

public static final String SAVE_TO_REMOTE_PROPERTY_NAME

See Also:

• Constant Field Values

SAVE_NON_OVERRIDEABLE_NAME

public static final String SAVE_NON_OVERRIDEABLE_NAME

See Also:

• Constant Field Values

FAIL_FAST_PROPERTY_NAME

public static final String FAIL_FAST_PROPERTY_NAME

See Also:

• Constant Field Values

BASELINE_BUILD_URL_PROPERTY_NAME

public static final String BASELINE_BUILD_URL_PROPERTY_NAME

See Also:

• Constant Field Values

LAZY_RESTORE_PROPERTY_NAME

public static final String LAZY_RESTORE_PROPERTY_NAME

See Also:

• Constant Field Values

RESTORE_ON_DISK_ARTIFACTS_PROPERTY_NAME

public static final String RESTORE_ON_DISK_ARTIFACTS_PROPERTY_NAME

See Also:

• Constant Field Values

RESTORE_GENERATED_SOURCES_PROPERTY_NAME

public static final String RESTORE_GENERATED_SOURCES_PROPERTY_NAME

See Also:

• Constant Field Values

ALWAYS_RUN_PLUGINS

public static final String ALWAYS_RUN_PLUGINS

See Also:

• Constant Field Values

MANDATORY_CLEAN

public static final String MANDATORY_CLEAN

See Also:

• Constant Field Values

CACHE_SKIP

public static final String CACHE_SKIP

Flag to control if we should skip lookup for cached artifacts globally or for a particular project even if qualifying artifacts exist in build cache. E.g. to trigger a forced build (full or for a particular module) May be also activated via properties for projects via a profile e.g. on CI when some files produced by the build are required (e.g. smth. from target folder as additional CI build artifacts): <maven.build.cache.skipCache>true<maven.build.cache.skipCache/>

See Also:

• Constant Field Values

SKIP_SAVE

public static final String SKIP_SAVE

Flag to disable cache saving

See Also:

• Constant Field Values

Constructor Details

CacheConfigImpl

@Inject
public CacheConfigImpl(XmlService xmlService,
 javax.inject.Provider<org.apache.maven.execution.MavenSession> providerSession,
 org.apache.maven.rtinfo.RuntimeInformation rtInfo)

Method Details

initialize

@Nonnull
public CacheState initialize()

Specified by:

initialize in interface CacheConfig

getTrackedProperties

@Nonnull
public List<TrackedProperty> getTrackedProperties(org.apache.maven.plugin.MojoExecution mojoExecution)

Specified by:

getTrackedProperties in interface CacheConfig

isLogAllProperties

public boolean isLogAllProperties(org.apache.maven.plugin.MojoExecution mojoExecution)

Specified by:

isLogAllProperties in interface CacheConfig

getLoggedProperties

@Nonnull
public List<PropertyName> getLoggedProperties(org.apache.maven.plugin.MojoExecution mojoExecution)

Specified by:

getLoggedProperties in interface CacheConfig

getNologProperties

@Nonnull
public List<PropertyName> getNologProperties(org.apache.maven.plugin.MojoExecution mojoExecution)

Specified by:

getNologProperties in interface CacheConfig

getEffectivePomExcludeProperties

@Nonnull
public List<String> getEffectivePomExcludeProperties(org.apache.maven.model.Plugin plugin)

Specified by:

getEffectivePomExcludeProperties in interface CacheConfig

isPluginDependenciesExcluded

public boolean isPluginDependenciesExcluded(org.apache.maven.model.Plugin plugin)

Specified by:

isPluginDependenciesExcluded in interface CacheConfig

getMultiModule

@Nullable
public MultiModule getMultiModule()

Specified by:

getMultiModule in interface CacheConfig

getPluginDirScanConfig

@Nonnull
public PluginScanConfig getPluginDirScanConfig(org.apache.maven.model.Plugin plugin)

Specified by:

getPluginDirScanConfig in interface CacheConfig

getExecutionDirScanConfig

@Nonnull
public PluginScanConfig getExecutionDirScanConfig(org.apache.maven.model.Plugin plugin,
 org.apache.maven.model.PluginExecution exec)

Specified by:

getExecutionDirScanConfig in interface CacheConfig

isProcessPlugins

public String isProcessPlugins()

Specified by:

isProcessPlugins in interface CacheConfig

getDefaultGlob

public String getDefaultGlob()

Specified by:

getDefaultGlob in interface CacheConfig

getGlobalIncludePaths

@Nonnull
public List<Include> getGlobalIncludePaths()

Specified by:

getGlobalIncludePaths in interface CacheConfig

getGlobalExcludePaths

@Nonnull
public List<Exclude> getGlobalExcludePaths()

Specified by:

getGlobalExcludePaths in interface CacheConfig

getHashFactory

@Nonnull
public HashFactory getHashFactory()

Specified by:

getHashFactory in interface CacheConfig

canIgnore

public boolean canIgnore(org.apache.maven.plugin.MojoExecution mojoExecution)

Specified by:

canIgnore in interface CacheConfig

isForcedExecution

public boolean isForcedExecution(org.apache.maven.plugin.MojoExecution execution)

Specified by:

isForcedExecution in interface CacheConfig

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface CacheConfig

isRemoteCacheEnabled

public boolean isRemoteCacheEnabled()

Specified by:

isRemoteCacheEnabled in interface CacheConfig

isSaveToRemote

public boolean isSaveToRemote()

Specified by:

isSaveToRemote in interface CacheConfig

isSaveToRemoteFinal

public boolean isSaveToRemoteFinal()

Specified by:

isSaveToRemoteFinal in interface CacheConfig

isSkipCache

public boolean isSkipCache()

Specified by:

isSkipCache in interface CacheConfig

isFailFast

public boolean isFailFast()

Specified by:

isFailFast in interface CacheConfig

isBaselineDiffEnabled

public boolean isBaselineDiffEnabled()

Specified by:

isBaselineDiffEnabled in interface CacheConfig

getBaselineCacheUrl

public String getBaselineCacheUrl()

Specified by:

getBaselineCacheUrl in interface CacheConfig

isLazyRestore

public boolean isLazyRestore()

Description copied from interface: CacheConfig

Artifacts restore policy. Eager policy (default) resolves all cached artifacts before restoring project and allows safe to fallback ro normal execution in case of restore failure. Lazy policy restores artifacts on demand minimizing need for downloading any artifacts from cache

Use: -Dmaven.build.cache.lazyRestore=(true|false)

Specified by:

isLazyRestore in interface CacheConfig

isRestoreGeneratedSources

public boolean isRestoreGeneratedSources()

Description copied from interface: CacheConfig

Flag to restore (default) or not generated sources as it might be desired to disable it in continuous integration scenarios

Specified by:

isRestoreGeneratedSources in interface CacheConfig

isRestoreOnDiskArtifacts

public boolean isRestoreOnDiskArtifacts()

Description copied from interface: CacheConfig

Flag to restore (default) or not generated artifacts

Specified by:

isRestoreOnDiskArtifacts in interface CacheConfig

getAlwaysRunPlugins

public String getAlwaysRunPlugins()

Specified by:

getAlwaysRunPlugins in interface CacheConfig

isSkipSave

public boolean isSkipSave()

Description copied from interface: CacheConfig

Flag to disable cache saving

Specified by:

isSkipSave in interface CacheConfig

isMandatoryClean

public boolean isMandatoryClean()

Description copied from interface: CacheConfig

Flag to save in cache only if a build went through the clean lifecycle

Specified by:

isMandatoryClean in interface CacheConfig

getId

public String getId()

Specified by:

getId in interface CacheConfig

getUrl

public String getUrl()

Specified by:

getUrl in interface CacheConfig

getTransport

public String getTransport()

Specified by:

getTransport in interface CacheConfig

getMaxLocalBuildsCached

public int getMaxLocalBuildsCached()

Specified by:

getMaxLocalBuildsCached in interface CacheConfig

getLocalRepositoryLocation

public String getLocalRepositoryLocation()

Specified by:

getLocalRepositoryLocation in interface CacheConfig

getAttachedOutputs

public List<DirName> getAttachedOutputs()

Specified by:

getAttachedOutputs in interface CacheConfig

isPreservePermissions

public boolean isPreservePermissions()

Specified by:

isPreservePermissions in interface CacheConfig

adjustMetaInfVersion

public boolean adjustMetaInfVersion()

Specified by:

adjustMetaInfVersion in interface CacheConfig

calculateProjectVersionChecksum

public boolean calculateProjectVersionChecksum()

Specified by:

calculateProjectVersionChecksum in interface CacheConfig

getExcludePatterns

@Nonnull
public List<Pattern> getExcludePatterns()

Specified by:

getExcludePatterns in interface CacheConfig