io.knotx.stack.model

Class StackResolutionOptions

java.lang.Object

io.knotx.stack.resolver.ResolverOptions

io.knotx.stack.model.StackResolutionOptions

public class StackResolutionOptions
extends ResolverOptions

The options configuring the stack resolution.

Author:

Clement Escoffier

Field Summary

Fields inherited from class io.knotx.stack.resolver.ResolverOptions

HTTP_PROXY_SYS_PROP, HTTPS_PROXY_SYS_PROP, LOCAL_REPO_SYS_PROP, REMOTE_REPOS_SYS_PROP

Constructor Summary

Constructors

Constructor and Description
StackResolutionOptions()

Method Summary

Modifier and Type	Method and Description
File	getCacheFile()
boolean	isCacheDisabled()
boolean	isCacheDisabledForSnapshots()
boolean	isFailOnConflicts()
StackResolutionOptions	setCacheDisabled(boolean cacheDisabled) Sets whether or not the cache is disabled.
StackResolutionOptions	setCacheDisabledForSnapshots(boolean cacheDisabledForSnapshots) Sets whether or not the cache is disabled for snapshot.
StackResolutionOptions	setCacheFile(File cacheFile) Sets the cache file location (json file).
StackResolutionOptions	setFailOnConflicts(boolean failOnConflicts) Sets whether or not the resolution should fail on conflicts.
StackResolutionOptions	setHttpProxy(String httpProxy) Sets the address of the proxy used for HTTP requests.
StackResolutionOptions	setHttpsProxy(String httpsProxy) Sets the address of the proxy used for HTTPS requests.
StackResolutionOptions	setLocalRepository(String localRepository) Sets the path to the local Maven repository.
StackResolutionOptions	setRemoteRepositories(List<String> remoteRepositories) Sets the list of remote repositories used by the resolver.

Methods inherited from class io.knotx.stack.resolver.ResolverOptions

getHttpProxy, getHttpsProxy, getLocalRepository, getRemoteRepositories

Methods inherited from class java.lang.Object

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

Constructor Detail

StackResolutionOptions

public StackResolutionOptions()

Method Detail

isFailOnConflicts

public boolean isFailOnConflicts()

Returns:

whether or not the resolution fails on conflicts or just prints a warning.

setFailOnConflicts

public StackResolutionOptions setFailOnConflicts(boolean failOnConflicts)

Sets whether or not the resolution should fail on conflicts.

Parameters:

failOnConflicts - whether or not the resolution fails on conflicts.

Returns:

the current StackResolutionOptions instance

setHttpProxy

public StackResolutionOptions setHttpProxy(String httpProxy)

Description copied from class: ResolverOptions

Sets the address of the proxy used for HTTP requests.

Overrides:

setHttpProxy in class ResolverOptions

Parameters:

httpProxy - the proxy address

Returns:

the current ResolverOptions instance

setHttpsProxy

public StackResolutionOptions setHttpsProxy(String httpsProxy)

Description copied from class: ResolverOptions

Sets the address of the proxy used for HTTPS requests.

Overrides:

setHttpsProxy in class ResolverOptions

Parameters:

httpsProxy - the proxy address

Returns:

the current ResolverOptions instance

setLocalRepository

public StackResolutionOptions setLocalRepository(String localRepository)

Description copied from class: ResolverOptions

Sets the path to the local Maven repository. By default it's ~/.m2/repository.

Overrides:

setLocalRepository in class ResolverOptions

Parameters:

localRepository - the local repository

Returns:

the current ResolverOptions instance

setRemoteRepositories

public StackResolutionOptions setRemoteRepositories(List<String> remoteRepositories)

Description copied from class: ResolverOptions

Sets the list of remote repositories used by the resolver. The repository must use the Maven 2 repository layout. If you don't want to resolved from remote locations, set it to an empty list. By default it resolves from Maven central and Sonatype OSS Snapshots.

Overrides:

setRemoteRepositories in class ResolverOptions

Parameters:

remoteRepositories - the list of remote repositories

Returns:

the current ResolverOptions instance

isCacheDisabled

public boolean isCacheDisabled()

Returns:

whether or not the cache is disabled.

setCacheDisabled

public StackResolutionOptions setCacheDisabled(boolean cacheDisabled)

Sets whether or not the cache is disabled.

Parameters:

cacheDisabled - true to disable the cache, false to enable it (default)

Returns:

the current StackResolutionOptions instance

isCacheDisabledForSnapshots

public boolean isCacheDisabledForSnapshots()

Returns:

whether or not the cache is disabled for snapshots

setCacheDisabledForSnapshots

public StackResolutionOptions setCacheDisabledForSnapshots(boolean cacheDisabledForSnapshots)

Sets whether or not the cache is disabled for snapshot.

Parameters:

cacheDisabledForSnapshots - true to disable the cache for snapshot, false to enable it (default)

Returns:

the current StackResolutionOptions instance

getCacheFile

public File getCacheFile()

Returns:

the location of the cache file is set.

setCacheFile

public StackResolutionOptions setCacheFile(File cacheFile)

Sets the cache file location (json file).

Parameters:

cacheFile - the cache file

Returns:

the current StackResolutionOptions instance