com.cloudbees.plugins.deployer.hosts

Class DeployHostDescriptor<S extends DeployHost<S,T>,T extends DeployTarget<T>>

java.lang.Object

hudson.model.Descriptor<DeployHost<S,T>>

com.cloudbees.plugins.deployer.hosts.DeployHostDescriptor<S,T>

All Implemented Interfaces:

Saveable, OnMaster

public abstract class DeployHostDescriptor<S extends DeployHost<S,T>,T extends DeployTarget<T>>
extends Descriptor<DeployHost<S,T>>

The base class for DeployHost 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	DeployHostDescriptor()
protected	DeployHostDescriptor(Class<? extends DeployHost<S,T>> clazz)

Method Summary

Modifier and Type	Method and Description
static ExtensionList<? extends DeployHostDescriptor<?,?>>	all() Returns all the DeployHost descriptors.
static List<DeployHostDescriptor<?,?>>	allSupported(Set<DeploySourceOrigin> origins, Class<? extends AbstractProject> jobType) Returns the descriptors that are supported for the specified origins and job type.
S	createDefault(AbstractProject<?,?> owner, Set<DeploySourceOrigin> origins) Creates a default DeployHost instance from the specified project considering the specified origins.
abstract S	createDefault(Run<?,?> run, Set<DeploySourceOrigin> origins) Creates a default DeployHost instance from the specified project run considering the specified origins.
abstract Class<T>	getDeployTargetClass() Returns the subclass of DeployTarget that the DeployHost is restricted to.
DeployTargetDescriptor<T>	getDeployTargetDescriptor()
boolean	isSupported(Set<DeploySourceOrigin> origins, Class<? extends AbstractProject> jobType) Returns true if and only if this host is valid for the specified origins and job type.
boolean	isSupported(Set<DeploySourceOrigin> origins, Run<?,?> run) Returns true if and only if this host is valid for the specified origins and run.
S	updateDefault(AbstractProject<?,?> owner, Set<DeploySourceOrigin> origins, S template) Update a default DeployHost instance from the specified project considering the specified origins, filling in any information missing from the previous default but which now has a better guess.
S	updateDefault(Run<?,?> run, Set<DeploySourceOrigin> origins, S template) Update a default DeployHost instance from the specified project run considering the specified origins, filling in any information missing from the previous default but which now has a better guess.

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

DeployHostDescriptor

protected DeployHostDescriptor()

DeployHostDescriptor

protected DeployHostDescriptor(Class<? extends DeployHost<S,T>> clazz)

Method Detail

getDeployTargetClass

@NonNull
public abstract Class<T> getDeployTargetClass()

Returns the subclass of DeployTarget that the DeployHost is restricted to.

Returns:

the subclass of DeployTarget that the DeployHost is restricted to.

getDeployTargetDescriptor

@NonNull
public DeployTargetDescriptor<T> getDeployTargetDescriptor()

createDefault

@CheckForNull
public S createDefault(@CheckForNull
                                     AbstractProject<?,?> owner,
                                     @CheckForNull
                                     Set<DeploySourceOrigin> origins)

Creates a default DeployHost instance from the specified project considering the specified origins.

Parameters:

owner - the project.

origins - the origins.

Returns:

the best guess at a default deployment from the specified project when using the specified origins or null if there is no default.

createDefault

@CheckForNull
public abstract S createDefault(@CheckForNull
                                              Run<?,?> run,
                                              @CheckForNull
                                              Set<DeploySourceOrigin> origins)

Creates a default DeployHost instance from the specified project run considering the specified origins.

Parameters:

run - the project run.

origins - the origins.

Returns:

the best guess at a default deployment from the specified project run when using the specified origins or null if there is no default.

updateDefault

@CheckForNull
public S updateDefault(@CheckForNull
                                     AbstractProject<?,?> owner,
                                     @CheckForNull
                                     Set<DeploySourceOrigin> origins,
                                     @CheckForNull
                                     S template)

Update a default DeployHost instance from the specified project considering the specified origins, filling in any information missing from the previous default but which now has a better guess.

Parameters:

owner - the project run.

origins - the origins.

template - the previous default.

Returns:

the best guess at a default deployment from the specified project when using the specified origins or null if there is no default.

updateDefault

@CheckForNull
public S updateDefault(@CheckForNull
                                     Run<?,?> run,
                                     @CheckForNull
                                     Set<DeploySourceOrigin> origins,
                                     @CheckForNull
                                     S template)

Update a default DeployHost instance from the specified project run considering the specified origins, filling in any information missing from the previous default but which now has a better guess.

Parameters:

run - the project run.

origins - the origins.

template - the previous default.

Returns:

the best guess at a default deployment from the specified project run when using the specified origins or null if there is no default.

isSupported

public boolean isSupported(@NonNull
                           Set<DeploySourceOrigin> origins,
                           @CheckForNull
                           Class<? extends AbstractProject> jobType)

Returns true if and only if this host is valid for the specified origins and job type.

Parameters:

origins - the origins

jobType - the job type.

Returns:

true if and only if this host is valid for the specified origins and job type.

isSupported

public boolean isSupported(@NonNull
                           Set<DeploySourceOrigin> origins,
                           @CheckForNull
                           Run<?,?> run)

Returns true if and only if this host is valid for the specified origins and run.

Parameters:

origins - the origins

run - the run.

Returns:

true if and only if this host is valid for the specified origins and run.

all

public static ExtensionList<? extends DeployHostDescriptor<?,?>> all()

Returns all the DeployHost descriptors.

Returns:

all the DeployHost descriptors.

allSupported

public static List<DeployHostDescriptor<?,?>> allSupported(@NonNull
                                                           Set<DeploySourceOrigin> origins,
                                                           @CheckForNull
                                                           Class<? extends AbstractProject> jobType)

Returns the descriptors that are supported for the specified origins and job type.

Parameters:

origins - the origins

jobType - the job type.

Returns:

the descriptors that are supported for the specified origins and job type.