com.cloudbees.plugins.deployer.targets

Class DeployTargetDescriptor<T extends DeployTarget<T>>

java.lang.Object

hudson.model.Descriptor<T>

com.cloudbees.plugins.deployer.targets.DeployTargetDescriptor<T>

Type Parameters:

T - the class.

All Implemented Interfaces:

Saveable, OnMaster

public abstract class DeployTargetDescriptor<T extends DeployTarget<T>>
extends Descriptor<T>

The base class for DeployTarget descriptors

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

Modifier	Constructor and Description
protected	DeployTargetDescriptor() Infers the type of the corresponding DeployTarget from the outer class.
protected	DeployTargetDescriptor(Class<? extends T> clazz) For cases where the common convention cannot be followed.

Method Summary

Modifier and Type	Method and Description
DeploySource	defaultDeploySource(DeploySource source, Set<DeploySourceOrigin> origins, Class<? extends AbstractProject> jobType) If the specified source is null, try to pick the best default to select initially.
DescriptorExtensionList<DeploySource,Descriptor<DeploySource>>	getDeploySourceDescriptors() Gets all the DeploySource descriptors.
List<DeploySourceDescriptor>	getDeploySourceDescriptors(Set<DeploySourceOrigin> origins, Class<? extends AbstractProject> jobType) Returns the DeploySourceDescriptors that are valid for the specific context.
boolean	isDirectoryTarget() Returns true if and only if this target can accept directories.
boolean	isFileTarget() Returns true if and only if this target can accept files.
FormValidation	validateFilePath(String filePathName, FilePath filePath) An extra validation hook for DeployTarget instances to provide additional checks on the user's specified DeploySource when resolving from the DeploySourceOrigin.WORKSPACE.

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

DeployTargetDescriptor

protected DeployTargetDescriptor()

Infers the type of the corresponding DeployTarget from the outer class. This version works when you follow the common convention, where a descriptor is written as the static nested class of the describable class.

DeployTargetDescriptor

protected DeployTargetDescriptor(@NonNull
                                 Class<? extends T> clazz)

For cases where the common convention cannot be followed.

Parameters:

clazz - the type of DeployTarget that this descriptor describes.

Method Detail

isFileTarget

public boolean isFileTarget()

Returns true if and only if this target can accept files.

Returns:

true if and only if this target can accept files.

isDirectoryTarget

public boolean isDirectoryTarget()

Returns true if and only if this target can accept directories.

Returns:

true if and only if this target can accept directories.

getDeploySourceDescriptors

@NonNull
public DescriptorExtensionList<DeploySource,Descriptor<DeploySource>> getDeploySourceDescriptors()

Gets all the DeploySource descriptors.

Returns:

all the DeploySource descriptors.

getDeploySourceDescriptors

@NonNull
public List<DeploySourceDescriptor> getDeploySourceDescriptors(@CheckForNull
                                                                        Set<DeploySourceOrigin> origins,
                                                                        @CheckForNull
                                                                        Class<? extends AbstractProject> jobType)

Returns the DeploySourceDescriptors that are valid for the specific context.

Parameters:

origins - the valid origins.

jobType - the project type.

Returns:

the DeploySourceDescriptors that are valid for the specific context.

defaultDeploySource

@CheckForNull
public DeploySource defaultDeploySource(@CheckForNull
                                                      DeploySource source,
                                                      @CheckForNull
                                                      Set<DeploySourceOrigin> origins,
                                                      @CheckForNull
                                                      Class<? extends AbstractProject> jobType)

If the specified source is null, try to pick the best default to select initially.

Parameters:

source - the possibly null source.

origins - the origins from which sources can be considered valid.

jobType - the project type.

Returns:

either the passed through source, or the (possible null) best guess default.

validateFilePath

public FormValidation validateFilePath(String filePathName,
                                       FilePath filePath)
                                throws IOException,
                                       InterruptedException

An extra validation hook for DeployTarget instances to provide additional checks on the user's specified DeploySource when resolving from the DeploySourceOrigin.WORKSPACE.

Parameters:

filePathName - the user specified file path name value.

filePath - the resulting resolved file path.

Returns:

the validation results.

Throws:

IOException

InterruptedException