Class SessionStub

java.lang.Object

org.apache.maven.api.plugin.testing.stubs.SessionStub

All Implemented Interfaces:

ProtoSession, Session

public class SessionStub
extends Object
implements Session

A stub implementation of Session for basic testing scenarios. Provides minimal implementation of session methods without mock dependencies.

For more comprehensive session mocking, consider using SessionMock instead.

Since:

4.0.0

See Also:

• SessionMock

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.maven.api.ProtoSession

ProtoSession.Builder

Constructor Summary

Constructors

Constructor	Description
SessionStub()
SessionStub(Map<String,String> userProperties)
SessionStub(Map<String,String> systemProperties, Map<String,String> userProperties, org.apache.maven.api.settings.Settings settings)
SessionStub(org.apache.maven.api.settings.Settings settings)

Method Summary

Modifier and Type	Method	Description
Node	collectDependencies(Artifact artifact, PathScope scope)
Node	collectDependencies(DependencyCoordinates dependencyCoordinates, PathScope scope)
Node	collectDependencies(Project project, PathScope scope)
Artifact	createArtifact(String groupId, String artifactId, String version, String extension)
Artifact	createArtifact(String groupId, String artifactId, String version, String classifier, String extension, String type)
ArtifactCoordinates	createArtifactCoordinates(String coordString)
ArtifactCoordinates	createArtifactCoordinates(String groupId, String artifactId, String version, String extension)
ArtifactCoordinates	createArtifactCoordinates(String groupId, String artifactId, String version, String classifier, String extension, String type)
ArtifactCoordinates	createArtifactCoordinates(Artifact artifact)
DependencyCoordinates	createDependencyCoordinates(ArtifactCoordinates artifactCoordinates)
DependencyCoordinates	createDependencyCoordinates(Dependency dependency)
LocalRepository	createLocalRepository(Path path)
ProducedArtifact	createProducedArtifact(String groupId, String artifactId, String version, String extension)
ProducedArtifact	createProducedArtifact(String groupId, String artifactId, String version, String classifier, String extension, String type)
RemoteRepository	createRemoteRepository(String id, String url)
RemoteRepository	createRemoteRepository(Repository repository)
void	deployArtifact(RemoteRepository repository, ProducedArtifact... artifacts)
List<Node>	flattenDependencies(Node node, PathScope scope)
Optional<Path>	getArtifactPath(Artifact artifact)
SessionData	getData()
int	getDegreeOfConcurrency()
Map<String,String>	getEffectiveProperties(Project project)
Collection<Listener>	getListeners()
LocalRepository	getLocalRepository()
Version	getMavenVersion()
Path	getPathForLocalArtifact(Artifact artifact)
Path	getPathForRemoteArtifact(RemoteRepository remote, Artifact artifact)
Map<String,Object>	getPluginContext(Project project)
List<Project>	getProjects()
List<RemoteRepository>	getRemoteRepositories()
Path	getRootDirectory()
<T extends Service> T	getService(Class<T> clazz)
org.apache.maven.api.settings.Settings	getSettings()
Instant	getStartTime()
Map<String,String>	getSystemProperties()
Collection<org.apache.maven.api.toolchain.ToolchainModel>	getToolchains()
Path	getTopDirectory()
Map<String,String>	getUserProperties()
void	installArtifacts(Collection<ProducedArtifact> artifacts)
void	installArtifacts(ProducedArtifact... artifacts)
boolean	isVersionSnapshot(String version)
Version	parseVersion(String version)
VersionConstraint	parseVersionConstraint(String s)
VersionRange	parseVersionRange(String versionRange)
void	registerListener(Listener listener)
DependencyScope	requireDependencyScope(String id)
Language	requireLanguage(String id)
Packaging	requirePackaging(String id)
PathScope	requirePathScope(String id)
ProjectScope	requireProjectScope(String id)
Type	requireType(String id)
DownloadedArtifact	resolveArtifact(Artifact artifact)
DownloadedArtifact	resolveArtifact(ArtifactCoordinates coordinate)
DownloadedArtifact	resolveArtifact(ArtifactCoordinates coordinates, List<RemoteRepository> repositories)
DownloadedArtifact	resolveArtifact(Artifact artifact, List<RemoteRepository> repositories)
Collection<DownloadedArtifact>	resolveArtifacts(Collection<? extends ArtifactCoordinates> collection)
Collection<DownloadedArtifact>	resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates, List<RemoteRepository> repositories)
Collection<DownloadedArtifact>	resolveArtifacts(Artifact... artifacts)
Collection<DownloadedArtifact>	resolveArtifacts(ArtifactCoordinates... artifactCoordinates)
List<Path>	resolveDependencies(List<DependencyCoordinates> dependencyCoordinatess)
List<Path>	resolveDependencies(DependencyCoordinates dependencyCoordinates)
Map<PathType, List<Path>>	resolveDependencies(DependencyCoordinates dependencyCoordinates, PathScope scope, Collection<PathType> desiredTypes)
List<Path>	resolveDependencies(Project project, PathScope scope)
Map<PathType, List<Path>>	resolveDependencies(Project project, PathScope scope, Collection<PathType> desiredTypes)
Optional<Version>	resolveHighestVersion(ArtifactCoordinates artifact, List<RemoteRepository> repositories)
Version	resolveVersion(ArtifactCoordinates artifact)
List<Version>	resolveVersionRange(ArtifactCoordinates artifact)
List<Version>	resolveVersionRange(ArtifactCoordinates artifact, List<RemoteRepository> repositories)
void	setArtifactPath(ProducedArtifact artifact, Path path)
void	unregisterListener(Listener listener)
Session	withLocalRepository(LocalRepository localRepository)
Session	withRemoteRepositories(List<RemoteRepository> repositories)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.api.ProtoSession

toBuilder

Constructor Details

SessionStub

public SessionStub(org.apache.maven.api.settings.Settings settings)

SessionStub

public SessionStub()

SessionStub

public SessionStub(Map<String,String> userProperties)

SessionStub

public SessionStub(Map<String,String> systemProperties,
 Map<String,String> userProperties,
 org.apache.maven.api.settings.Settings settings)

Method Details

getSettings

public org.apache.maven.api.settings.Settings getSettings()

Specified by:

getSettings in interface Session

getSystemProperties

public Map<String,String> getSystemProperties()

Specified by:

getSystemProperties in interface ProtoSession

getUserProperties

public Map<String,String> getUserProperties()

Specified by:

getUserProperties in interface ProtoSession

getEffectiveProperties

@Nonnull
public Map<String,String> getEffectiveProperties(@Nullable
 Project project)

Specified by:

getEffectiveProperties in interface Session

getLocalRepository

public LocalRepository getLocalRepository()

Specified by:

getLocalRepository in interface Session

getTopDirectory

public Path getTopDirectory()

Specified by:

getTopDirectory in interface ProtoSession

getRootDirectory

public Path getRootDirectory()

Specified by:

getRootDirectory in interface ProtoSession

getRemoteRepositories

public List<RemoteRepository> getRemoteRepositories()

Specified by:

getRemoteRepositories in interface Session

getData

public SessionData getData()

Specified by:

getData in interface Session

getMavenVersion

public Version getMavenVersion()

Specified by:

getMavenVersion in interface Session

getDegreeOfConcurrency

public int getDegreeOfConcurrency()

Specified by:

getDegreeOfConcurrency in interface Session

getStartTime

public Instant getStartTime()

Specified by:

getStartTime in interface ProtoSession

getProjects

public List<Project> getProjects()

Specified by:

getProjects in interface Session

getPluginContext

public Map<String,Object> getPluginContext(Project project)

Specified by:

getPluginContext in interface Session

getService

public <T extends Service> T getService(Class<T> clazz)

Specified by:

getService in interface Session

withLocalRepository

public Session withLocalRepository(LocalRepository localRepository)

Specified by:

withLocalRepository in interface Session

withRemoteRepositories

public Session withRemoteRepositories(List<RemoteRepository> repositories)

Specified by:

withRemoteRepositories in interface Session

registerListener

public void registerListener(Listener listener)

Specified by:

registerListener in interface Session

unregisterListener

public void unregisterListener(Listener listener)

Specified by:

unregisterListener in interface Session

getListeners

public Collection<Listener> getListeners()

Specified by:

getListeners in interface Session

createLocalRepository

public LocalRepository createLocalRepository(Path path)

Specified by:

createLocalRepository in interface Session

createRemoteRepository

public RemoteRepository createRemoteRepository(String id,
 String url)

Specified by:

createRemoteRepository in interface Session

createRemoteRepository

public RemoteRepository createRemoteRepository(Repository repository)

Specified by:

createRemoteRepository in interface Session

createArtifact

public Artifact createArtifact(String groupId,
 String artifactId,
 String version,
 String extension)

Specified by:

createArtifact in interface Session

createArtifact

public Artifact createArtifact(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

Specified by:

createArtifact in interface Session

createProducedArtifact

public ProducedArtifact createProducedArtifact(String groupId,
 String artifactId,
 String version,
 String extension)

Specified by:

createProducedArtifact in interface Session

createProducedArtifact

public ProducedArtifact createProducedArtifact(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

Specified by:

createProducedArtifact in interface Session

createArtifactCoordinates

public ArtifactCoordinates createArtifactCoordinates(String groupId,
 String artifactId,
 String version,
 String extension)

Specified by:

createArtifactCoordinates in interface Session

createArtifactCoordinates

public ArtifactCoordinates createArtifactCoordinates(String coordString)

Specified by:

createArtifactCoordinates in interface Session

createArtifactCoordinates

public ArtifactCoordinates createArtifactCoordinates(String groupId,
 String artifactId,
 String version,
 String classifier,
 String extension,
 String type)

Specified by:

createArtifactCoordinates in interface Session

createArtifactCoordinates

public ArtifactCoordinates createArtifactCoordinates(Artifact artifact)

Specified by:

createArtifactCoordinates in interface Session

createDependencyCoordinates

public DependencyCoordinates createDependencyCoordinates(ArtifactCoordinates artifactCoordinates)

Specified by:

createDependencyCoordinates in interface Session

createDependencyCoordinates

public DependencyCoordinates createDependencyCoordinates(Dependency dependency)

Specified by:

createDependencyCoordinates in interface Session

resolveArtifact

public DownloadedArtifact resolveArtifact(Artifact artifact)

Specified by:

resolveArtifact in interface Session

resolveArtifact

public DownloadedArtifact resolveArtifact(ArtifactCoordinates coordinate)

Specified by:

resolveArtifact in interface Session

resolveArtifact

public DownloadedArtifact resolveArtifact(ArtifactCoordinates coordinates,
 List<RemoteRepository> repositories)

Specified by:

resolveArtifact in interface Session

resolveArtifact

public DownloadedArtifact resolveArtifact(Artifact artifact,
 List<RemoteRepository> repositories)

Specified by:

resolveArtifact in interface Session

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(ArtifactCoordinates... artifactCoordinates)

Specified by:

resolveArtifacts in interface Session

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(Collection<? extends ArtifactCoordinates> collection)

Specified by:

resolveArtifacts in interface Session

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(Artifact... artifacts)

Specified by:

resolveArtifacts in interface Session

resolveArtifacts

public Collection<DownloadedArtifact> resolveArtifacts(Collection<? extends ArtifactCoordinates> coordinates,
 List<RemoteRepository> repositories)

Specified by:

resolveArtifacts in interface Session

flattenDependencies

public List<Node> flattenDependencies(Node node,
 PathScope scope)

Specified by:

flattenDependencies in interface Session

resolveDependencies

public List<Path> resolveDependencies(DependencyCoordinates dependencyCoordinates)

Specified by:

resolveDependencies in interface Session

resolveDependencies

public List<Path> resolveDependencies(List<DependencyCoordinates> dependencyCoordinatess)

Specified by:

resolveDependencies in interface Session

resolveDependencies

public List<Path> resolveDependencies(Project project,
 PathScope scope)

Specified by:

resolveDependencies in interface Session

resolveVersion

public Version resolveVersion(ArtifactCoordinates artifact)

Specified by:

resolveVersion in interface Session

resolveVersionRange

public List<Version> resolveVersionRange(ArtifactCoordinates artifact)

Specified by:

resolveVersionRange in interface Session

resolveVersionRange

public List<Version> resolveVersionRange(ArtifactCoordinates artifact,
 List<RemoteRepository> repositories)

Specified by:

resolveVersionRange in interface Session

installArtifacts

public void installArtifacts(ProducedArtifact... artifacts)

Specified by:

installArtifacts in interface Session

installArtifacts

public void installArtifacts(Collection<ProducedArtifact> artifacts)

Specified by:

installArtifacts in interface Session

deployArtifact

public void deployArtifact(RemoteRepository repository,
 ProducedArtifact... artifacts)

Specified by:

deployArtifact in interface Session

setArtifactPath

public void setArtifactPath(ProducedArtifact artifact,
 Path path)

Specified by:

setArtifactPath in interface Session

getArtifactPath

public Optional<Path> getArtifactPath(Artifact artifact)

Specified by:

getArtifactPath in interface Session

isVersionSnapshot

public boolean isVersionSnapshot(String version)

Specified by:

isVersionSnapshot in interface Session

collectDependencies

public Node collectDependencies(Artifact artifact,
 PathScope scope)

Specified by:

collectDependencies in interface Session

collectDependencies

public Node collectDependencies(Project project,
 PathScope scope)

Specified by:

collectDependencies in interface Session

collectDependencies

public Node collectDependencies(DependencyCoordinates dependencyCoordinates,
 PathScope scope)

Specified by:

collectDependencies in interface Session

getPathForLocalArtifact

public Path getPathForLocalArtifact(Artifact artifact)

Specified by:

getPathForLocalArtifact in interface Session

getPathForRemoteArtifact

public Path getPathForRemoteArtifact(RemoteRepository remote,
 Artifact artifact)

Specified by:

getPathForRemoteArtifact in interface Session

parseVersion

public Version parseVersion(String version)

Specified by:

parseVersion in interface Session

parseVersionRange

public VersionRange parseVersionRange(String versionRange)

Specified by:

parseVersionRange in interface Session

parseVersionConstraint

public VersionConstraint parseVersionConstraint(String s)

Specified by:

parseVersionConstraint in interface Session

resolveDependencies

public Map<PathType, List<Path>> resolveDependencies(DependencyCoordinates dependencyCoordinates,
 PathScope scope,
 Collection<PathType> desiredTypes)

Specified by:

resolveDependencies in interface Session

resolveDependencies

public Map<PathType, List<Path>> resolveDependencies(Project project,
 PathScope scope,
 Collection<PathType> desiredTypes)

Specified by:

resolveDependencies in interface Session

requireType

public Type requireType(String id)

Specified by:

requireType in interface Session

requireLanguage

public Language requireLanguage(String id)

Specified by:

requireLanguage in interface Session

requirePackaging

public Packaging requirePackaging(String id)

Specified by:

requirePackaging in interface Session

requireProjectScope

public ProjectScope requireProjectScope(String id)

Specified by:

requireProjectScope in interface Session

requireDependencyScope

public DependencyScope requireDependencyScope(String id)

Specified by:

requireDependencyScope in interface Session

requirePathScope

public PathScope requirePathScope(String id)

Specified by:

requirePathScope in interface Session

resolveHighestVersion

public Optional<Version> resolveHighestVersion(ArtifactCoordinates artifact,
 List<RemoteRepository> repositories)

Specified by:

resolveHighestVersion in interface Session

getToolchains

public Collection<org.apache.maven.api.toolchain.ToolchainModel> getToolchains()

Specified by:

getToolchains in interface Session