com.cloudbees.plugins.deployer.sources

Class DeploySourceDescriptor

java.lang.Object

hudson.model.Descriptor<DeploySource>

com.cloudbees.plugins.deployer.sources.DeploySourceDescriptor

All Implemented Interfaces:

Saveable, OnMaster

Direct Known Subclasses:

FixedDirectoryDeploySource.DescriptorImpl, MavenArtifactDeploySource.DescriptorImpl, StaticSelectionDeploySource.DescriptorImpl, WildcardPathDeploySource.DescriptorImpl

public abstract class DeploySourceDescriptor
extends Descriptor<DeploySource>

The base class for all DeploySource Descriptor instances.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DeploySourceDescriptor()

Method Summary

Modifier and Type	Method and Description
protected FormValidation	delegatePathValidationToTarget(String pathName, String targetDescriptorId, FilePath path) Delegates the final path validation to the DeployTarget.
protected Job	findJob() If the stapler request ancestor is a Run or one of the deploy now actions, will return null, otherwise returns the job.
protected Run	findRun() If the stapler request ancestor is a Run or one of the deploy now actions, will return null, otherwise returns the run.
boolean	isApplicable(Class<? extends AbstractProject> jobType) Returns true if and only if this DeploySource is relevant to the job type
boolean	isDirectorySource() Returns true if and only if this DeploySource can return directories.
boolean	isFileSource() Returns true if and only if this DeploySource can return files.
static boolean	isMavenJob(Class<? extends AbstractProject> jobType) Returns true if and only if the supplied type is a Maven job type class.
boolean	isSupported(DeploySourceOrigin... origins) Returns true if and only if this DeploySource can operate from at least one of the specified origins.
abstract boolean	isSupported(DeploySourceOrigin origin) Returns true if and only if this DeploySource can operate from the specified origin.
DeploySource	newInstance() Create a new default instance of the DeploySource

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploySourceDescriptor

public DeploySourceDescriptor()

Method Detail

isMavenJob

public static boolean isMavenJob(Class<? extends AbstractProject> jobType)

Returns true if and only if the supplied type is a Maven job type class.

Parameters:

jobType - the job type.

Returns:

true if and only if the supplied type is a Maven job type class.

isApplicable

public boolean isApplicable(@CheckForNull
                            Class<? extends AbstractProject> jobType)

Returns true if and only if this DeploySource is relevant to the job type

Parameters:

jobType - the type of job.

Returns:

true if and only if this DeploySource is relevant to the job type

isSupported

public abstract boolean isSupported(@CheckForNull
                                    DeploySourceOrigin origin)

Returns true if and only if this DeploySource can operate from the specified origin.

Parameters:

origin - the origin.

Returns:

true if and only if this DeploySource can operate from the specified origin.

isSupported

public boolean isSupported(@CheckForNull
                           DeploySourceOrigin... origins)

Returns true if and only if this DeploySource can operate from at least one of the specified origins.

Parameters:

origins - the origins.

Returns:

true if and only if this DeploySource can operate from at least one of the specified origins

isFileSource

public boolean isFileSource()

Returns true if and only if this DeploySource can return files.

Returns:

true if and only if this DeploySource can return files.

isDirectorySource

public boolean isDirectorySource()

Returns true if and only if this DeploySource can return directories.

Returns:

true if and only if this DeploySource can return directories.

findRun

@CheckForNull
protected Run findRun()

If the stapler request ancestor is a Run or one of the deploy now actions, will return null, otherwise returns the run.

Returns:

the run ancestor of the stapler request or null if there is none.

findJob

@CheckForNull
protected Job findJob()

If the stapler request ancestor is a Run or one of the deploy now actions, will return null, otherwise returns the job.

Returns:

the job ancestor of the stapler request or null if there is none.

newInstance

public DeploySource newInstance()

Create a new default instance of the DeploySource

Returns:

the new instance.

delegatePathValidationToTarget

protected FormValidation delegatePathValidationToTarget(@CheckForNull
                                                        String pathName,
                                                        @CheckForNull
                                                        String targetDescriptorId,
                                                        @CheckForNull
                                                        FilePath path)
                                                 throws IOException,
                                                        InterruptedException

Delegates the final path validation to the DeployTarget.

Parameters:

targetDescriptorId - the class name of the DeployTarget to delegate to.

path - the path we believe to be OK.

Returns:

the results of validation.

Throws:

IOException

InterruptedException