Package org.apache.camel.main.download

Class MavenDependencyDownloader

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.main.download.MavenDependencyDownloader

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, DependencyDownloader, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.StatefulService, org.apache.camel.StaticService, org.apache.camel.SuspendableService

public class MavenDependencyDownloader
extends org.apache.camel.support.service.ServiceSupport
implements DependencyDownloader

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
MavenDependencyDownloader()

Method Summary

Modifier and Type	Method	Description
void	addArtifactDownloadListener(ArtifactDownloadListener downloadListener)	Adds a listener to capture download activity
void	addDownloadListener(DownloadListener downloadListener)	Adds a listener to capture download activity
boolean	alreadyOnClasspath(String groupId, String artifactId, String version)	Checks whether the dependency is already on the classpath
protected void	doBuild()
protected void	doDownloadDependency(String groupId, String artifactId, String version, boolean transitively, boolean hidden, String extraRepos)
protected void	doInit()
protected void	doStop()
org.apache.camel.tooling.maven.MavenArtifact	downloadArtifact(String groupId, String artifactId, String version)	Downloads a single maven artifact (no transitive dependencies)
void	downloadDependency(String groupId, String artifactId, String version)	Downloads the dependency incl transitive dependencies
void	downloadDependency(String groupId, String artifactId, String version, boolean transitively)	Downloads the dependency
void	downloadDependency(String groupId, String artifactId, String version, String extraRepos)	Downloads the dependency incl transitive dependencies
void	downloadHiddenDependency(String groupId, String artifactId, String version)	Downloads as hidden dependency that are not captured as a requirement
Collection<DownloadRecord>	downloadRecords()	Gets the records for the downloaded artifacts
org.apache.camel.CamelContext	getCamelContext()
ClassLoader	getClassLoader()	Classloader able to load from downloaded dependencies.
DownloadRecord	getDownloadState(String groupId, String artifactId, String version)	Gets download record for a given artifact
KnownReposResolver	getKnownReposResolver()
String	getMavenSettings()
String	getMavenSettingsSecurity()
String	getRepositories()
org.apache.camel.tooling.maven.RepositoryResolver	getRepositoryResolver()	Gets the RepositoryResolver
boolean	isDownload()	Whether downloading from remote Maven repositories is enabled
boolean	isFresh()
boolean	isMavenApacheSnapshotEnabled()	Whether downloading JARs from ASF Maven Snapshot repository is enabled
boolean	isMavenCentralEnabled()	Whether downloading JARs from Maven Central repository is enabled
boolean	isVerbose()
void	onLoadingKamelet(String name)	When a kamelet is being loaded
void	onLoadingModeline(String key, String value)	When a modeline is being loaded
List<String[]>	resolveAvailableVersions(String groupId, String artifactId, String minimumVersion, String repo)	Resolves the available versions for the given maven artifact
List<org.apache.camel.tooling.maven.MavenArtifact>	resolveDependenciesViaAether(List<String> depIds, Set<String> extraRepositories, boolean transitively, boolean useApacheSnapshots)
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setClassLoader(ClassLoader classLoader)	Sets the classloader to use that will be able to load from downloaded dependencies
void	setDownload(boolean download)	Whether downloading from remote Maven repositories is enabled
void	setFresh(boolean fresh)	Make sure we use fresh (i.e. non-cached) resources.
void	setKnownReposResolver(KnownReposResolver knownReposResolver)
void	setMavenApacheSnapshotEnabled(boolean mavenApacheSnapshotEnabled)	Whether downloading JARs from ASF Maven Snapshot repository is enabled
void	setMavenCentralEnabled(boolean mavenCentralEnabled)	Whether downloading JARs from Maven Central repository is enabled
void	setMavenSettings(String mavenSettings)	Configure location of Maven settings.xml file
void	setMavenSettingsSecurity(String mavenSettingsSecurity)	Configure location of Maven settings-security.xml file
void	setRepositories(String repositories)	Additional maven repositories for download on-demand (Use commas to separate multiple repositories).
void	setVerbose(boolean verbose)

Methods inherited from class org.apache.camel.support.service.BaseService

build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Details

MavenDependencyDownloader

public MavenDependencyDownloader()

Method Details

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.spi.HasCamelContext

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

getClassLoader

public ClassLoader getClassLoader()

Description copied from interface: DependencyDownloader

Classloader able to load from downloaded dependencies.

Specified by:

getClassLoader in interface DependencyDownloader

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Description copied from interface: DependencyDownloader

Sets the classloader to use that will be able to load from downloaded dependencies

Specified by:

setClassLoader in interface DependencyDownloader

isVerbose

public boolean isVerbose()

setVerbose

public void setVerbose(boolean verbose)

getKnownReposResolver

public KnownReposResolver getKnownReposResolver()

setKnownReposResolver

public void setKnownReposResolver(KnownReposResolver knownReposResolver)

getRepositoryResolver

public org.apache.camel.tooling.maven.RepositoryResolver getRepositoryResolver()

Description copied from interface: DependencyDownloader

Gets the RepositoryResolver

Specified by:

getRepositoryResolver in interface DependencyDownloader

addDownloadListener

public void addDownloadListener(DownloadListener downloadListener)

Description copied from interface: DependencyDownloader

Adds a listener to capture download activity

Specified by:

addDownloadListener in interface DependencyDownloader

addArtifactDownloadListener

public void addArtifactDownloadListener(ArtifactDownloadListener downloadListener)

Description copied from interface: DependencyDownloader

Adds a listener to capture download activity

Specified by:

addArtifactDownloadListener in interface DependencyDownloader

getRepositories

public String getRepositories()

Specified by:

getRepositories in interface DependencyDownloader

setRepositories

public void setRepositories(String repositories)

Description copied from interface: DependencyDownloader

Additional maven repositories for download on-demand (Use commas to separate multiple repositories).

Specified by:

setRepositories in interface DependencyDownloader

isFresh

public boolean isFresh()

Specified by:

isFresh in interface DependencyDownloader

setFresh

public void setFresh(boolean fresh)

Description copied from interface: DependencyDownloader

Make sure we use fresh (i.e. non-cached) resources.

Specified by:

setFresh in interface DependencyDownloader

isDownload

public boolean isDownload()

Description copied from interface: DependencyDownloader

Whether downloading from remote Maven repositories is enabled

Specified by:

isDownload in interface DependencyDownloader

setDownload

public void setDownload(boolean download)

Description copied from interface: DependencyDownloader

Whether downloading from remote Maven repositories is enabled

Specified by:

setDownload in interface DependencyDownloader

getMavenSettings

public String getMavenSettings()

Specified by:

getMavenSettings in interface DependencyDownloader

setMavenSettings

public void setMavenSettings(String mavenSettings)

Description copied from interface: DependencyDownloader

Configure location of Maven settings.xml file

Specified by:

setMavenSettings in interface DependencyDownloader

getMavenSettingsSecurity

public String getMavenSettingsSecurity()

Specified by:

getMavenSettingsSecurity in interface DependencyDownloader

setMavenSettingsSecurity

public void setMavenSettingsSecurity(String mavenSettingsSecurity)

Description copied from interface: DependencyDownloader

Configure location of Maven settings-security.xml file

Specified by:

setMavenSettingsSecurity in interface DependencyDownloader

isMavenCentralEnabled

public boolean isMavenCentralEnabled()

Description copied from interface: DependencyDownloader

Whether downloading JARs from Maven Central repository is enabled

Specified by:

isMavenCentralEnabled in interface DependencyDownloader

setMavenCentralEnabled

public void setMavenCentralEnabled(boolean mavenCentralEnabled)

Description copied from interface: DependencyDownloader

Whether downloading JARs from Maven Central repository is enabled

Specified by:

setMavenCentralEnabled in interface DependencyDownloader

isMavenApacheSnapshotEnabled

public boolean isMavenApacheSnapshotEnabled()

Description copied from interface: DependencyDownloader

Whether downloading JARs from ASF Maven Snapshot repository is enabled

Specified by:

isMavenApacheSnapshotEnabled in interface DependencyDownloader

setMavenApacheSnapshotEnabled

public void setMavenApacheSnapshotEnabled(boolean mavenApacheSnapshotEnabled)

Description copied from interface: DependencyDownloader

Whether downloading JARs from ASF Maven Snapshot repository is enabled

Specified by:

setMavenApacheSnapshotEnabled in interface DependencyDownloader

downloadDependency

public void downloadDependency(String groupId,
 String artifactId,
 String version)

Description copied from interface: DependencyDownloader

Downloads the dependency incl transitive dependencies

Specified by:

downloadDependency in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

downloadDependency

public void downloadDependency(String groupId,
 String artifactId,
 String version,
 String extraRepos)

Description copied from interface: DependencyDownloader

Downloads the dependency incl transitive dependencies

Specified by:

downloadDependency in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

extraRepos - additional remote maven repositories to use when downloading

downloadHiddenDependency

public void downloadHiddenDependency(String groupId,
 String artifactId,
 String version)

Description copied from interface: DependencyDownloader

Downloads as hidden dependency that are not captured as a requirement

Specified by:

downloadHiddenDependency in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

downloadDependency

public void downloadDependency(String groupId,
 String artifactId,
 String version,
 boolean transitively)

Description copied from interface: DependencyDownloader

Downloads the dependency

Specified by:

downloadDependency in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

transitively - whether to include transitive dependencies

doDownloadDependency

protected void doDownloadDependency(String groupId,
 String artifactId,
 String version,
 boolean transitively,
 boolean hidden,
 String extraRepos)

downloadArtifact

public org.apache.camel.tooling.maven.MavenArtifact downloadArtifact(String groupId,
 String artifactId,
 String version)

Description copied from interface: DependencyDownloader

Downloads a single maven artifact (no transitive dependencies)

Specified by:

downloadArtifact in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

Returns:

the artifact, or null if none found

resolveAvailableVersions

public List<String[]> resolveAvailableVersions(String groupId,
 String artifactId,
 String minimumVersion,
 String repo)

Description copied from interface: DependencyDownloader

Resolves the available versions for the given maven artifact

Specified by:

resolveAvailableVersions in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

minimumVersion - optional minimum version to avoid resolving too old releases

repo - to use specific maven repository instead of maven central (used if repo is null)

Returns:

list of versions of the given artifact (0=camel-core version, 1=runtime version, such as spring-boot or quarkus)

alreadyOnClasspath

public boolean alreadyOnClasspath(String groupId,
 String artifactId,
 String version)

Description copied from interface: DependencyDownloader

Checks whether the dependency is already on the classpath

Specified by:

alreadyOnClasspath in interface DependencyDownloader

Parameters:

groupId - maven group id

artifactId - maven artifact id

version - maven version

Returns:

true if already on classpath, false if not.

onLoadingKamelet

public void onLoadingKamelet(String name)

Description copied from interface: DependencyDownloader

When a kamelet is being loaded

Specified by:

onLoadingKamelet in interface DependencyDownloader

Parameters:

name - the kamelet name

onLoadingModeline

public void onLoadingModeline(String key,
 String value)

Description copied from interface: DependencyDownloader

When a modeline is being loaded

Specified by:

onLoadingModeline in interface DependencyDownloader

Parameters:

key - modeline key

value - modeline value

getDownloadState

public DownloadRecord getDownloadState(String groupId,
 String artifactId,
 String version)

Description copied from interface: DependencyDownloader

Gets download record for a given artifact

Specified by:

getDownloadState in interface DependencyDownloader

Returns:

download record (if any) or null if artifact was not downloaded, but could have been resolved from local disk

downloadRecords

public Collection<DownloadRecord> downloadRecords()

Description copied from interface: DependencyDownloader

Gets the records for the downloaded artifacts

Specified by:

downloadRecords in interface DependencyDownloader

doBuild

protected void doBuild()

Overrides:

doBuild in class org.apache.camel.support.service.BaseService

doInit

protected void doInit()

Overrides:

doInit in class org.apache.camel.support.service.BaseService

doStop

protected void doStop()

Overrides:

doStop in class org.apache.camel.support.service.BaseService

resolveDependenciesViaAether

public List<org.apache.camel.tooling.maven.MavenArtifact> resolveDependenciesViaAether(List<String> depIds,
 Set<String> extraRepositories,
 boolean transitively,
 boolean useApacheSnapshots)