com.cloudbees.plugins.deployer.hosts

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

java.lang.Object

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

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

All Implemented Interfaces:

Describable<DeployHost<S,T>>

public abstract class DeployHost<S extends DeployHost<S,T>,T extends DeployTarget<T>>
extends AbstractDescribableImpl<DeployHost<S,T>>

A set of DeployTargets to be deployed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeployHost(List<T> targets) Constructor.

Method Summary

Modifier and Type	Method and Description
static List<DeployHost<?,?>>	createDefaults(AbstractProject<?,?> owner, Set<DeploySourceOrigin> origins)
static List<DeployHost<?,?>>	createDefaults(Run<?,?> run, Set<DeploySourceOrigin> origins)
boolean	equals(Object o)
DeployHostDescriptor<S,T>	getDescriptor()
abstract String	getDisplayName()
List<T>	getTargets() Returns the targets to deploy.
int	hashCode()
protected abstract boolean	isAuthenticationValid(Authentication authentication) Return true if and only if this DeployHost requires to resolve some specific Credentials from the CredentialsProvider API and the provided Authentication can find those Credentials
boolean	isValid(AbstractProject<?,?> project) Checks if this deploy set is valid for use against the specified project by the system authentication.
boolean	isValid(AbstractProject<?,?> project, Authentication authentication) Checks if this deploy set is valid for use against the specified project by the specified authentication.
static boolean	isValid(List<? extends DeployHost<?,?>> sets, AbstractProject<?,?> owner, Authentication authentication)
static boolean	isValid(List<? extends DeployHost<?,?>> sets, Run<?,?> owner, Authentication authentication)
boolean	isValid(Run<?,?> run) Checks if this deploy set is valid for use against the specified run by the system authentication.
boolean	isValid(Run<?,?> run, Authentication authentication) Checks if this deploy set is valid for use against the specified run by the specified authentication.
String	toString()
static List<DeployHost<?,?>>	updateDefaults(AbstractProject<?,?> owner, Set<DeploySourceOrigin> origins, List<? extends DeployHost<?,?>> templates)
static List<DeployHost<?,?>>	updateDefaults(Run<?,?> run, Set<DeploySourceOrigin> origins, List<? extends DeployHost<?,?>> templates)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeployHost

protected DeployHost(@CheckForNull
                     List<T> targets)

Constructor.

Parameters:

targets - the targets to deploy.

Method Detail

isValid

public static boolean isValid(List<? extends DeployHost<?,?>> sets,
                              Run<?,?> owner,
                              Authentication authentication)

isValid

public static boolean isValid(List<? extends DeployHost<?,?>> sets,
                              AbstractProject<?,?> owner,
                              Authentication authentication)

getTargets

@NonNull
public final List<T> getTargets()

Returns the targets to deploy.

Returns:

the targets to deploy.

isValid

public final boolean isValid(AbstractProject<?,?> project,
                             Authentication authentication)

Checks if this deploy set is valid for use against the specified project by the specified authentication.

Parameters:

project - the AbstractProject to check (will be the last successful Run of the project).

authentication - the Authentication that the deployment would be performed as.

Returns:

true if and only if this deploy set is valid for use against the specified project by the specified authentication.

isValid

public final boolean isValid(AbstractProject<?,?> project)

Checks if this deploy set is valid for use against the specified project by the system authentication.

Parameters:

project - the AbstractProject to check (will be the last successful Run of the project).

Returns:

true if and only if this deploy set is valid for use against the specified project by the system authentication.

isValid

public final boolean isValid(Run<?,?> run)

Checks if this deploy set is valid for use against the specified run by the system authentication.

Parameters:

run - the Run to check.

Returns:

true if and only if this deploy set is valid for use against the specified run by the system authentication.

isValid

public final boolean isValid(Run<?,?> run,
                             Authentication authentication)

Checks if this deploy set is valid for use against the specified run by the specified authentication.

Parameters:

run - the Run to check.

authentication - the Authentication that the deployment would be performed as.

Returns:

true if and only if this deploy set is valid for use against the specified run by the specified authentication.

isAuthenticationValid

protected abstract boolean isAuthenticationValid(Authentication authentication)

Return true if and only if this DeployHost requires to resolve some specific Credentials from the CredentialsProvider API and the provided Authentication can find those Credentials

Parameters:

authentication - the authentication.

Returns:

true if and only if the provided Authentication can resolve all the required Credentials needed to deploy this DeployHost.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDisplayName

public abstract String getDisplayName()

getDescriptor

public DeployHostDescriptor<S,T> getDescriptor()

Specified by:

getDescriptor in interface Describable<DeployHost<S extends DeployHost<S,T>,T extends DeployTarget<T>>>

Overrides:

getDescriptor in class AbstractDescribableImpl<DeployHost<S extends DeployHost<S,T>,T extends DeployTarget<T>>>

createDefaults

public static List<DeployHost<?,?>> createDefaults(@CheckForNull
                                                   AbstractProject<?,?> owner,
                                                   @CheckForNull
                                                   Set<DeploySourceOrigin> origins)

createDefaults

@CheckForNull
public static List<DeployHost<?,?>> createDefaults(@CheckForNull
                                                                 Run<?,?> run,
                                                                 @CheckForNull
                                                                 Set<DeploySourceOrigin> origins)

updateDefaults

public static List<DeployHost<?,?>> updateDefaults(@CheckForNull
                                                   AbstractProject<?,?> owner,
                                                   @CheckForNull
                                                   Set<DeploySourceOrigin> origins,
                                                   List<? extends DeployHost<?,?>> templates)

updateDefaults

@CheckForNull
public static List<DeployHost<?,?>> updateDefaults(@CheckForNull
                                                                 Run<?,?> run,
                                                                 @CheckForNull
                                                                 Set<DeploySourceOrigin> origins,
                                                                 List<? extends DeployHost<?,?>> templates)