Package | Description |
---|---|
jenkins.scm.api |
The public API contract of the SCM API plugin.
|
jenkins.scm.api.mixin |
The mix-in interfaces used by
SCMHead
implementations to advertise that a specific head is not just a regular branch but is actually a special type of
branch such as a change request /
tag / etc. |
jenkins.scm.api.trait |
An API/SPI to allow the sharing of common traits between different
SCMSource and
SCMNavigator implementations. |
jenkins.scm.impl |
The common implementations of classes in the public API.
|
Modifier and Type | Class and Description |
---|---|
class |
SCMHeadMigration<S extends SCMSource,H extends SCMHead,R extends SCMRevision>
|
Modifier and Type | Method and Description |
---|---|
SCMRevision |
SCMSource.fetch(SCMHead head,
TaskListener listener)
Gets the current head revision of the specified head.
|
SCMRevision |
SCMSource.fetch(String thingName,
TaskListener listener)
Deprecated.
rather call
SCMSource.fetch(String, TaskListener, Item) |
SCMRevision |
SCMSource.fetch(String thingName,
TaskListener listener,
Item context)
Looks up a specific thingName based on some SCM-specific set of permissible syntaxes.
|
SCMRevision |
SCMHeadObserver.Any.getRevision()
Returns the result.
|
SCMRevision |
SCMFileSystem.getRevision()
If this inspector is looking at the specific commit,
returns that revision.
|
SCMRevision |
SCMRevisionAction.getRevision()
Gets the
SCMRevision . |
static SCMRevision |
SCMRevisionAction.getRevision(Actionable actionable)
Deprecated.
|
static SCMRevision |
SCMRevisionAction.getRevision(SCMSource source,
Actionable actionable)
|
SCMRevision |
SCMSource.getTrustedRevision(SCMRevision revision,
TaskListener listener)
Enables a source to request that an alternative revision be used to obtain security-sensitive build instructions.
|
SCMRevision |
SCMHeadMigration.migrate(S source,
R revision)
Perform a migration.
|
static SCMRevision |
SCMHeadMigration.readResolveSCMRevision(SCMSource source,
SCMRevision revision)
Perform a migration.
|
SCMRevision |
SCMHeadObserver.Selector.result()
Returns the result.
|
SCMRevision |
SCMHeadObserver.Named.result()
Returns the result.
|
SCMRevision |
SCMHeadObserver.Any.result()
Returns the result.
|
protected SCMRevision |
SCMSource.retrieve(SCMHead head,
TaskListener listener)
SPI: Gets the current head revision of the specified head.
|
protected SCMRevision |
SCMSource.retrieve(String thingName,
TaskListener listener)
Deprecated.
rather override
SCMSource.retrieve(String, TaskListener, Item) |
protected SCMRevision |
SCMSource.retrieve(String thingName,
TaskListener listener,
Item context)
SPI: Looks up a specific revision based on some SCM-specific set of permissible syntaxes.
|
Modifier and Type | Method and Description |
---|---|
abstract Map<SCMHead,SCMRevision> |
SCMHeadEvent.heads(SCMSource source)
|
Map<SCMHead,SCMRevision> |
SCMSource.parentHeads(SCMHead head,
TaskListener listener)
Looks up the immediate parent heads of the specified head within the specified source.
|
Set<SCMRevision> |
SCMSource.parentRevisions(SCMHead head,
SCMRevision revision,
TaskListener listener)
Looks up the immediate parent revision(s) of the specified revision within the specified head.
|
Map<SCMHead,SCMRevision> |
SCMHeadObserver.Collector.result()
Returns the collected results.
|
Modifier and Type | Method and Description |
---|---|
abstract SCMFileSystem |
SCMFileSystem.Builder.build(Item owner,
SCM scm,
SCMRevision rev)
Given a
SCM this should try to build a corresponding SCMFileSystem instance that
reflects the content at the specified SCMRevision . |
abstract SCM |
SCMSource.build(SCMHead head,
SCMRevision revision)
Builds a
SCM instance for the specified head and revision, no validation of the
head is performed, a revision for a different head or source will be treated as equivalent to a
null revision. |
SCMFileSystem |
SCMFileSystem.Builder.build(SCMSource source,
SCMHead head,
SCMRevision rev)
Given a
SCMSource , a SCMHead and a SCMRevision this method should try to build a
corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at
the specified SCMRevision . |
boolean |
SCMFileSystem.changesSince(SCMRevision revision,
OutputStream changeLogStream)
Writes the changes between the specified revision and
SCMFileSystem.getRevision() in the format compatible
with the SCM from this SCMFileSystem.of(Item, SCM) to the supplied OutputStream . |
protected SCMProbe |
SCMSource.createProbe(SCMHead head,
SCMRevision revision)
|
List<Action> |
SCMSource.fetchActions(SCMRevision revision,
SCMHeadEvent event,
TaskListener listener)
Fetches any actions that should be persisted for objects related to the specified revision.
|
protected SCMProbe |
SCMSource.fromSCMFileSystem(SCMHead head,
SCMRevision revision)
Helper method for subclasses that have implemented a
SCMFileSystem.Builder and want to use a simple
non-caching SCMProbe based off of the SCMFileSystem . |
SCMRevision |
SCMSource.getTrustedRevision(SCMRevision revision,
TaskListener listener)
Enables a source to request that an alternative revision be used to obtain security-sensitive build instructions.
|
SCMProbe |
SCMSource.newProbe(SCMHead head,
SCMRevision revision)
|
abstract void |
SCMHeadObserver.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.AllFinished.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.OneFinished.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.Collector.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.Selector.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.Named.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.Any.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.None.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.Wrapped.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
void |
SCMHeadObserver.Filter.observe(SCMHead head,
SCMRevision revision)
Observes a head and current revision.
|
static SCMFileSystem |
SCMFileSystem.of(Item owner,
SCM scm,
SCMRevision rev)
Given a
SCM this method will try to retrieve a corresponding SCMFileSystem instance that
reflects the content at the specified SCMRevision . |
static SCMFileSystem |
SCMFileSystem.of(SCMSource source,
SCMHead head,
SCMRevision rev)
Given a
SCMSource , a SCMHead and a SCMRevision this method will try to retrieve a
corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the
specified SCMRevision . |
Set<SCMRevision> |
SCMSource.parentRevisions(SCMHead head,
SCMRevision revision,
TaskListener listener)
Looks up the immediate parent revision(s) of the specified revision within the specified head.
|
static SCMRevision |
SCMHeadMigration.readResolveSCMRevision(SCMSource source,
SCMRevision revision)
Perform a migration.
|
protected List<Action> |
SCMSource.retrieveActions(SCMRevision revision,
SCMHeadEvent event,
TaskListener listener)
|
Constructor and Description |
---|
SCMFileSystem(SCMRevision rev)
Constructor.
|
SCMRevisionAction(SCMRevision revision)
Deprecated.
|
SCMRevisionAction(SCMSource source,
SCMRevision revision)
Constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
ChangeRequestSCMRevision<H extends SCMHead & ChangeRequestSCMHead>
Recommended base class for the
SCMRevision of a ChangeRequestSCMHead . |
Modifier and Type | Method and Description |
---|---|
SCMRevision |
ChangeRequestSCMRevision.getTarget()
Returns the revision of the
ChangeRequestSCMHead.getTarget() that this ChangeRequestSCMHead is
associated with. |
Constructor and Description |
---|
ChangeRequestSCMRevision(H head,
SCMRevision target)
Constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
SCMHeadAuthority<S extends SCMSourceRequest,H extends SCMHeadMixin,R extends SCMRevision>
Abstraction to allow pluggable definitions of trust for
SCMHead and SCMRevision instances in the
context of a specific SCMSourceRequest . |
static interface |
SCMSourceRequest.LazyRevisionLambda<H extends SCMHead,R extends SCMRevision,I>
A lambda that will create the
SCMRevision instance for a specific SCMHead using the intermediate
value produced by a SCMSourceRequest.IntermediateLambda . |
static interface |
SCMSourceRequest.RevisionLambda<H extends SCMHead,R extends SCMRevision>
A lambda that will create the
SCMRevision instance for a specific SCMHead . |
static interface |
SCMSourceRequest.Witness<H extends SCMHead,R extends SCMRevision>
Callback lambda to track the results of
SCMSourceRequest.process(SCMHead, IntermediateLambda, ProbeLambda, LazyRevisionLambda, Witness[]) |
Modifier and Type | Method and Description |
---|---|
<H extends SCMHead,R extends SCMRevision> |
SCMSourceRequest.process(H head,
R revision,
SCMSourceRequest.ProbeLambda<H,R> probeFactory,
SCMSourceRequest.Witness... witnesses)
Processes a head in the context of the current request.
|
<H extends SCMHead,I,R extends SCMRevision> |
SCMSourceRequest.process(H head,
SCMSourceRequest.IntermediateLambda<I> intermediateFactory,
SCMSourceRequest.ProbeLambda<H,I> probeFactory,
SCMSourceRequest.LazyRevisionLambda<H,R,I> revisionFactory,
SCMSourceRequest.Witness... witnesses)
Processes a head in the context of the current request where an intermediary operation is required before
the
SCMRevision can be instantiated. |
<H extends SCMHead,R extends SCMRevision> |
SCMSourceRequest.process(H head,
SCMSourceRequest.RevisionLambda<H,R> revisionFactory,
SCMSourceRequest.ProbeLambda<H,R> probeFactory,
SCMSourceRequest.Witness... witnesses)
Processes a head in the context of the current request.
|
Modifier and Type | Method and Description |
---|---|
SCMRevision |
SCMBuilder.revision()
|
Modifier and Type | Method and Description |
---|---|
boolean |
SCMHeadAuthority.isApplicableTo(SCMRevision revision)
Checks if this authority is relevant to the supplied
SCMRevision . |
boolean |
SCMHeadAuthorityDescriptor.isApplicableToRevision(SCMRevision revision)
Checks if this
SCMHeadAuthorityDescriptor is applicable to the supplied SCMRevision . |
boolean |
SCMHeadAuthority.isTrusted(SCMSourceRequest request,
SCMRevision revision)
Checks if the supplied
SCMRevision is trusted in the context of the specified SCMSourceRequest . |
B |
SCMBuilder.withRevision(SCMRevision revision)
Replace the
SCMBuilder.revision() with a new SCMRevision |
Modifier and Type | Method and Description |
---|---|
static List<SCMHeadAuthorityDescriptor> |
SCMHeadAuthority._for(Class<? extends SCMSourceRequest> requestClass,
Class<? extends SCMHeadMixin> headClass,
Class<? extends SCMRevision> revisionClass,
Class<? extends SCMHeadOrigin>... origins)
Returns the subset of
SCMHeadAuthorityDescriptor instances applicable to the supplied criteria. |
boolean |
SCMHeadAuthorityDescriptor.isApplicableToRevision(Class<? extends SCMRevision> revisionClass)
Checks if this
SCMHeadAuthorityDescriptor is applicable to the supplied type of SCMRevision . |
Constructor and Description |
---|
SCMBuilder(Class<S> clazz,
SCMHead head,
SCMRevision revision)
Constructor.
|
Constructor and Description |
---|
SCMHeadAuthorityDescriptor(Class<? extends SCMHeadAuthority<?,?,?>> clazz,
Class<? extends SCMSourceRequest> requestClass,
Class<? extends SCMHeadMixin> headClass,
Class<? extends SCMRevision> revisionClass)
Constructor to use when type inference using
SCMHeadAuthorityDescriptor() does not work. |
Modifier and Type | Method and Description |
---|---|
SCM |
SingleSCMSource.build(SCMHead head,
SCMRevision revision)
Builds a
SCM instance for the specified head and revision, no validation of the
head is performed, a revision for a different head or source will be treated as equivalent to a
null revision. |
SCM |
NullSCMSource.build(SCMHead head,
SCMRevision revision)
Builds a
SCM instance for the specified head and revision, no validation of the
head is performed, a revision for a different head or source will be treated as equivalent to a
null revision. |
Copyright © 2016–2022. All rights reserved.