|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RepositorySystem
The main entry point to the repository system.
Method Summary | |
---|---|
CollectResult |
collectDependencies(RepositorySystemSession session,
CollectRequest request)
Collects the transitive dependencies of an artifact and builds a dependency graph. |
DeployResult |
deploy(RepositorySystemSession session,
DeployRequest request)
Uploads a collection of artifacts and their accompanying metadata to a remote repository. |
InstallResult |
install(RepositorySystemSession session,
InstallRequest request)
Installs a collection of artifacts and their accompanying metadata to the local repository. |
LocalRepositoryManager |
newLocalRepositoryManager(LocalRepository localRepository)
Creates a new manager for the specified local repository. |
SyncContext |
newSyncContext(RepositorySystemSession session,
boolean shared)
Creates a new synchronization context. |
ArtifactDescriptorResult |
readArtifactDescriptor(RepositorySystemSession session,
ArtifactDescriptorRequest request)
Gets information about an artifact like its direct dependencies and potential relocations. |
ArtifactResult |
resolveArtifact(RepositorySystemSession session,
ArtifactRequest request)
Resolves the paths for an artifact. |
java.util.List<ArtifactResult> |
resolveArtifacts(RepositorySystemSession session,
java.util.Collection<? extends ArtifactRequest> requests)
Resolves the paths for a collection of artifacts. |
java.util.List<ArtifactResult> |
resolveDependencies(RepositorySystemSession session,
CollectRequest request,
DependencyFilter filter)
Deprecated. Use resolveDependencies(RepositorySystemSession, DependencyRequest) instead. |
java.util.List<ArtifactResult> |
resolveDependencies(RepositorySystemSession session,
DependencyNode node,
DependencyFilter filter)
Deprecated. Use resolveDependencies(RepositorySystemSession, DependencyRequest) instead. |
DependencyResult |
resolveDependencies(RepositorySystemSession session,
DependencyRequest request)
Collects and resolves the transitive dependencies of an artifact. |
java.util.List<MetadataResult> |
resolveMetadata(RepositorySystemSession session,
java.util.Collection<? extends MetadataRequest> requests)
Resolves the paths for a collection of metadata. |
VersionResult |
resolveVersion(RepositorySystemSession session,
VersionRequest request)
Resolves an artifact's meta version (if any) to a concrete version. |
VersionRangeResult |
resolveVersionRange(RepositorySystemSession session,
VersionRangeRequest request)
Expands a version range to a list of matching versions, in ascending order. |
Method Detail |
---|
VersionRangeResult resolveVersionRange(RepositorySystemSession session, VersionRangeRequest request) throws VersionRangeResolutionException
session
- The repository session, must not be null
.request
- The version range request, must not be null
null
.
VersionRangeResolutionException
- If the requested range could not be parsed. Note that an empty range does
not raise an exception.VersionResult resolveVersion(RepositorySystemSession session, VersionRequest request) throws VersionResolutionException
session
- The repository session, must not be null
.request
- The version request, must not be null
null
.
VersionResolutionException
- If the metaversion could not be resolved.ArtifactDescriptorResult readArtifactDescriptor(RepositorySystemSession session, ArtifactDescriptorRequest request) throws ArtifactDescriptorException
session
- The repository session, must not be null
.request
- The descriptor request, must not be null
null
.
ArtifactDescriptorException
- If the artifact descriptor could not be read.RepositorySystemSession.isIgnoreInvalidArtifactDescriptor()
,
RepositorySystemSession.isIgnoreMissingArtifactDescriptor()
CollectResult collectDependencies(RepositorySystemSession session, CollectRequest request) throws DependencyCollectionException
resolveDependencies(RepositorySystemSession, DependencyRequest)
.
session
- The repository session, must not be null
.request
- The collection request, must not be null
null
.
DependencyCollectionException
- If the dependency tree could not be built.RepositorySystemSession.getDependencyTraverser()
,
RepositorySystemSession.getDependencyManager()
,
RepositorySystemSession.getDependencySelector()
,
RepositorySystemSession.getDependencyGraphTransformer()
DependencyResult resolveDependencies(RepositorySystemSession session, DependencyRequest request) throws DependencyResolutionException
collectDependencies(RepositorySystemSession, CollectRequest)
and
resolveArtifacts(RepositorySystemSession, Collection)
.
session
- The repository session, must not be null
.request
- The dependency request, must not be null
null
.
DependencyResolutionException
- If the dependency tree could not be built or any dependency artifact could
not be resolved.@Deprecated java.util.List<ArtifactResult> resolveDependencies(RepositorySystemSession session, DependencyNode node, DependencyFilter filter) throws ArtifactResolutionException
resolveDependencies(RepositorySystemSession, DependencyRequest)
instead.
session
- The repository session, must not be null
.node
- The root node of the dependency graph whose artifacts shall be resolved, must not be null
filter
- The node filter to use to select the actual nodes to resolve, may be null
to resolve all
nodes.
null
.
ArtifactResolutionException
- If any artifact could not be resolved.Artifact.getFile()
@Deprecated java.util.List<ArtifactResult> resolveDependencies(RepositorySystemSession session, CollectRequest request, DependencyFilter filter) throws DependencyCollectionException, ArtifactResolutionException
resolveDependencies(RepositorySystemSession, DependencyRequest)
instead.
collectDependencies(RepositorySystemSession, CollectRequest)
and
resolveDependencies(RepositorySystemSession, DependencyNode, DependencyFilter)
.
session
- The repository session, must not be null
.request
- The collection request, must not be null
filter
- The node filter to use to select the actual nodes to resolve, may be null
to resolve all
nodes.
null
.
DependencyCollectionException
- If the dependency tree could not be built.
ArtifactResolutionException
- If any artifact could not be resolved.ArtifactResult resolveArtifact(RepositorySystemSession session, ArtifactRequest request) throws ArtifactResolutionException
session
- The repository session, must not be null
.request
- The resolution request, must not be null
null
.
ArtifactResolutionException
- If the artifact could not be resolved.Artifact.getFile()
java.util.List<ArtifactResult> resolveArtifacts(RepositorySystemSession session, java.util.Collection<? extends ArtifactRequest> requests) throws ArtifactResolutionException
session
- The repository session, must not be null
.requests
- The resolution requests, must not be null
null
.
ArtifactResolutionException
- If any artifact could not be resolved.Artifact.getFile()
java.util.List<MetadataResult> resolveMetadata(RepositorySystemSession session, java.util.Collection<? extends MetadataRequest> requests)
session
- The repository session, must not be null
.requests
- The resolution requests, must not be null
null
.Metadata.getFile()
InstallResult install(RepositorySystemSession session, InstallRequest request) throws InstallationException
session
- The repository session, must not be null
.request
- The installation request, must not be null
.
null
.
InstallationException
- If any artifact/metadata from the request could not be installed.DeployResult deploy(RepositorySystemSession session, DeployRequest request) throws DeploymentException
session
- The repository session, must not be null
.request
- The deployment request, must not be null
.
null
.
DeploymentException
- If any artifact/metadata from the request could not be deployed.LocalRepositoryManager newLocalRepositoryManager(LocalRepository localRepository)
localRepository
- The local repository to create a manager for, must not be null
.
null
.
java.lang.IllegalArgumentException
- If the specified repository type is not recognized or no base directory is
given.SyncContext newSyncContext(RepositorySystemSession session, boolean shared)
session
- The repository session during which the context will be used, must not be null
.shared
- A flag indicating whether access to the artifacts/metadata associated with the new context can be
shared among concurrent readers or whether access needs to be exclusive to the calling thread.
null
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |