Package eu.maveniverse.maven.mima.context

Class Context

java.lang.Object

eu.maveniverse.maven.mima.context.Context

All Implemented Interfaces:

Closeable, AutoCloseable

public final class Context
extends Object
implements Closeable

The MIMA context holds references to RepositorySystem, RepositorySystemSession and list of RemoteRepository. Context is Closeable, ideally used in try-with-resource constructs.

The very first context instance application creates using Runtime.create(ContextOverrides) is called "root context", and creation of it can be considered "heavy" operation (runtime dependent). Root context should be kept open as long as application is expected to make use of Resolver.

Context instances may be customized with customize(ContextOverrides) method, in that case the returned context is "derived" from this context. In those cases the context instances should be handled "as nested", so closed in opposite order as they were obtained. Creating customized contexts can be considered "light" operation, as they merely alter the RepositorySystemSession instance and repositories, while the RepositorySystem is just inherited from this instance (is not reconstructed).

See Also:

• Runtimes.getRuntime()
• Runtime.create(ContextOverrides)

Constructor Summary

Constructors

Constructor	Description
Context(RuntimeSupport runtime, ContextOverrides contextOverrides, org.eclipse.aether.RepositorySystem repositorySystem, org.eclipse.aether.RepositorySystemSession repositorySystemSession, List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories, Runnable managedCloser)

Method Summary

Modifier and Type	Method	Description
Path	basedir()	Shortcut for ContextOverrides.getBasedir(), never null.
void	close()	Closes the context.
ContextOverrides	contextOverrides()	Returns the ContextOverrides, never null.
Context	customize(ContextOverrides overrides)	Returns a new Context instance, that is customized using passed in ContextOverrides, using this instance as "base".
ContextOverrides.MavenSystemHome	mavenSystemHome()	Returns effective ContextOverrides.MavenSystemHome, may be null, if no Maven Home discovered.
ContextOverrides.MavenUserHome	mavenUserHome()	Returns effective ContextOverrides.MavenUserHome, never null.
List<org.eclipse.aether.repository.RemoteRepository>	remoteRepositories()	Returns the list of RemoteRepository, never null.
org.eclipse.aether.RepositorySystem	repositorySystem()	Returns the RepositorySystem, never null.
org.eclipse.aether.RepositorySystemSession	repositorySystemSession()	Returns the RepositorySystemSession, never null.

Methods inherited from class java.lang.Object

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

Constructor Details

Context

public Context(RuntimeSupport runtime,
 ContextOverrides contextOverrides,
 org.eclipse.aether.RepositorySystem repositorySystem,
 org.eclipse.aether.RepositorySystemSession repositorySystemSession,
 List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories,
 Runnable managedCloser)

Method Details

contextOverrides

public ContextOverrides contextOverrides()

Returns the ContextOverrides, never null.

Since:

2.1.0

basedir

public Path basedir()

Shortcut for ContextOverrides.getBasedir(), never null.

Since:

2.3.0

mavenUserHome

public ContextOverrides.MavenUserHome mavenUserHome()

Returns effective ContextOverrides.MavenUserHome, never null.

Since:

2.1.0

mavenSystemHome

public ContextOverrides.MavenSystemHome mavenSystemHome()

Returns effective ContextOverrides.MavenSystemHome, may be null, if no Maven Home discovered.

Since:

2.1.0

repositorySystemSession

public org.eclipse.aether.RepositorySystemSession repositorySystemSession()

Returns the RepositorySystemSession, never null.

repositorySystem

public org.eclipse.aether.RepositorySystem repositorySystem()

Returns the RepositorySystem, never null.

remoteRepositories

public List<org.eclipse.aether.repository.RemoteRepository> remoteRepositories()

Returns the list of RemoteRepository, never null.

customize

public Context customize(ContextOverrides overrides)

Returns a new Context instance, that is customized using passed in ContextOverrides, using this instance as "base".

close

public void close()

Closes the context. Once closed context instance should not be used anymore.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable