com.cloudbees.plugins.deployer.resolvers

Class CapabilitiesResolver

java.lang.Object

com.cloudbees.plugins.deployer.resolvers.CapabilitiesResolver

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

PromotionCapabilitiesResolver

public abstract class CapabilitiesResolver
extends Object
implements ExtensionPoint

Provides information about the capabilities that should be exposed for different project types. If there is a specific project type which should have its own tweaks (e.g. promoted-builds) then it can implement an extension of this type and change the effective behaviour.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
CapabilitiesResolver()

Method Summary

Modifier and Type	Method and Description
abstract Set<DeploySourceOrigin>	getBuilderSources(AbstractProject<?,?> project) Return the set of sources to be used by DeployBuilder.
abstract Set<DeploySourceOrigin>	getInstantSources(AbstractProject<?,?> project) Return the set of sources to be used by DeployNowRunAction.
static Run<?,?>	getLastDeployableBuild(Job<?,?> job) Returns the most recent successful or stable build of the specified job.
abstract Run<?,?>	getLastSuccessfulBuild(AbstractProject<?,?> project) Returns the last successful build of the specified project.
abstract Set<DeploySourceOrigin>	getPublisherSources(AbstractProject<?,?> project) Return the set of sources to be used by DeployPublisher.
boolean	isBuilderApplicable() Return true if and only if DeployBuilder is allowed to apply to project types known by this resolver.
boolean	isBuilderFromWorkspace() Return true if and only if DeployBuilder is allowed to resolve deployable artifacts from the job workspace.
boolean	isInstantApplicable() Return true if and only if DeployNowRunAction is allowed to apply to project types known by this resolver.
boolean	isPublisherApplicable() Return true if and only if DeployPublisher is allowed to apply to project types known by this resolver.
boolean	isPublisherFromWorkspace() Return true if and only if DeployPublisher is allowed to resolve deployable artifacts from the job workspace.
protected abstract boolean	knows(Class<? extends AbstractProject> jobType) Returns true if this resolver applies to the specific job type.
static CapabilitiesResolver	of(AbstractProject<?,?> project) Returns the CapabilitiesResolver for the specified project.
static CapabilitiesResolver	of(Class<? extends AbstractProject> jobType) Returns the CapabilitiesResolver for the specified job type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CapabilitiesResolver

public CapabilitiesResolver()

Method Detail

knows

protected abstract boolean knows(@NonNull
                                 Class<? extends AbstractProject> jobType)

Returns true if this resolver applies to the specific job type.

Parameters:

jobType - the specific job type.

Returns:

true if this resolver applies to the specific job type.

getBuilderSources

@NonNull
public abstract Set<DeploySourceOrigin> getBuilderSources(@CheckForNull
                                                                   AbstractProject<?,?> project)

Return the set of sources to be used by DeployBuilder.

Parameters:

project - the project.

Returns:

the set of sources to be used by DeployBuilder.

getPublisherSources

@NonNull
public abstract Set<DeploySourceOrigin> getPublisherSources(@CheckForNull
                                                                     AbstractProject<?,?> project)

Return the set of sources to be used by DeployPublisher.

Parameters:

project - the project.

Returns:

the set of sources to be used by DeployPublisher.

getInstantSources

@NonNull
public abstract Set<DeploySourceOrigin> getInstantSources(@CheckForNull
                                                                   AbstractProject<?,?> project)

Return the set of sources to be used by DeployNowRunAction.

Parameters:

project - the project.

Returns:

the set of sources to be used by DeployNowRunAction.

isBuilderApplicable

public boolean isBuilderApplicable()

Return true if and only if DeployBuilder is allowed to apply to project types known by this resolver.

Returns:

true if and only if DeployBuilder is allowed to apply to project types known by this resolver.

isPublisherApplicable

public boolean isPublisherApplicable()

Return true if and only if DeployPublisher is allowed to apply to project types known by this resolver.

Returns:

true if and only if DeployPublisher is allowed to apply to project types known by this resolver.

isInstantApplicable

public boolean isInstantApplicable()

Return true if and only if DeployNowRunAction is allowed to apply to project types known by this resolver.

Returns:

true if and only if DeployNowRunAction is allowed to apply to project types known by this resolver.

isBuilderFromWorkspace

public boolean isBuilderFromWorkspace()

Return true if and only if DeployBuilder is allowed to resolve deployable artifacts from the job workspace.

Returns:

true if and only if DeployBuilder is allowed to resolve deployable artifacts from the job workspace.

isPublisherFromWorkspace

public boolean isPublisherFromWorkspace()

Return true if and only if DeployPublisher is allowed to resolve deployable artifacts from the job workspace.

Returns:

true if and only if DeployPublisher is allowed to resolve deployable artifacts from the job workspace.

getLastSuccessfulBuild

@CheckForNull
public abstract Run<?,?> getLastSuccessfulBuild(@CheckForNull
                                                              AbstractProject<?,?> project)

Returns the last successful build of the specified project.

Parameters:

project - the specified project.

Returns:

the last successful build or null if no such build exists.

of

@NonNull
public static CapabilitiesResolver of(@CheckForNull
                                               Class<? extends AbstractProject> jobType)

Returns the CapabilitiesResolver for the specified job type.

Parameters:

jobType - the specified job type.

Returns:

the CapabilitiesResolver

getLastDeployableBuild

@CheckForNull
public static Run<?,?> getLastDeployableBuild(@CheckForNull
                                                            Job<?,?> job)

Returns the most recent successful or stable build of the specified job.

Parameters:

job - the specified job.

Returns:

the most recent successful or stable build of the specified job.

of

@NonNull
public static CapabilitiesResolver of(@CheckForNull
                                               AbstractProject<?,?> project)

Returns the CapabilitiesResolver for the specified project.

Parameters:

project - the specified project.

Returns:

the CapabilitiesResolver