Package org.apache.maven.buildcache.xml

Interface CacheConfig

All Known Implementing Classes:

CacheConfigImpl

public interface CacheConfig

A java interface to the information configured in the maven-build-cache-config.xml file

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
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

Method Detail

initialize

@Nonnull
CacheState initialize()

getTrackedProperties

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

isLogAllProperties

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

getLoggedProperties

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

getNologProperties

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

getEffectivePomExcludeProperties

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

getMultiModule

@Nullable
MultiModule getMultiModule()

isProcessPlugins

String isProcessPlugins()

getDefaultGlob

String getDefaultGlob()

getGlobalIncludePaths

@Nonnull
List<Include> getGlobalIncludePaths()

getGlobalExcludePaths

@Nonnull
List<Exclude> getGlobalExcludePaths()

getPluginDirScanConfig

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

getExecutionDirScanConfig

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

getHashFactory

@Nonnull
HashFactory getHashFactory()

isForcedExecution

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

getId

String getId()

getUrl

String getUrl()

getTransport

String getTransport()

isEnabled

boolean isEnabled()

isRemoteCacheEnabled

boolean isRemoteCacheEnabled()

isSaveToRemote

boolean isSaveToRemote()

isSaveToRemoteFinal

boolean isSaveToRemoteFinal()

isSkipCache

boolean isSkipCache()

isFailFast

boolean isFailFast()

getMaxLocalBuildsCached

int getMaxLocalBuildsCached()

getLocalRepositoryLocation

String getLocalRepositoryLocation()

getAttachedOutputs

List<DirName> getAttachedOutputs()

adjustMetaInfVersion

boolean adjustMetaInfVersion()

calculateProjectVersionChecksum

boolean calculateProjectVersionChecksum()

canIgnore

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

getExcludePatterns

@Nonnull
List<Pattern> getExcludePatterns()

isBaselineDiffEnabled

boolean isBaselineDiffEnabled()

getBaselineCacheUrl

String getBaselineCacheUrl()

isLazyRestore

boolean isLazyRestore()

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)

isRestoreGeneratedSources

boolean isRestoreGeneratedSources()

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

isRestoreOnDiskArtifacts

boolean isRestoreOnDiskArtifacts()

Flag to restore (default) or not generated artifacts

getAlwaysRunPlugins

String getAlwaysRunPlugins()

isSkipSave

boolean isSkipSave()

Flag to disable cache saving

isMandatoryClean

boolean isMandatoryClean()

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