Package com.atlassian.bitbucket.jenkins.internal.deployments

Class DeploymentStepUtils

java.lang.Object

com.atlassian.bitbucket.jenkins.internal.deployments.DeploymentStepUtils

public class DeploymentStepUtils
extends Object

Since:

3.1.0

Constructor Summary

Constructors

Constructor	Description
DeploymentStepUtils()

Method Summary

Modifier and Type	Method	Description
static BitbucketDeploymentEnvironment	getEnvironment(DeploymentStep step, Run<?,?> run, TaskListener listener)	Create a BitbucketDeploymentEnvironment.
static String	getOrGenerateEnvironmentKey()	Generates a random UUID to be used as an environment key.
static String	getOrGenerateEnvironmentKey(String environmentKey)	Gets the provided environmentKey, stripping away whitespace, or generates a random UUID if a blank environmentKey was provided.
static BitbucketDeploymentEnvironmentType	normalizeEnvironmentType(String environmentType)	Converts an environment type String to a BitbucketDeploymentEnvironmentType.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentStepUtils

public DeploymentStepUtils()

Method Detail

getOrGenerateEnvironmentKey

public static String getOrGenerateEnvironmentKey()

Generates a random UUID to be used as an environment key.

Returns:

the generated environmentKey, or a generated one if the provided one is blank

getOrGenerateEnvironmentKey

public static String getOrGenerateEnvironmentKey(@CheckForNull
                                                 String environmentKey)

Gets the provided environmentKey, stripping away whitespace, or generates a random UUID if a blank environmentKey was provided.

Parameters:

environmentKey - a unique identifier for the environment, or null to have one generated

Returns:

the provided environmentKey, or a generated one if the provided one is blank

normalizeEnvironmentType

@CheckForNull
public static BitbucketDeploymentEnvironmentType normalizeEnvironmentType(@CheckForNull
                                                                          String environmentType)

Converts an environment type String to a BitbucketDeploymentEnvironmentType.

Parameters:

environmentType - the Enum.name()

Returns:

the associated BitbucketDeploymentEnvironmentType or null if there is none that match

getEnvironment

public static BitbucketDeploymentEnvironment getEnvironment(DeploymentStep step,
                                                            Run<?,?> run,
                                                            TaskListener listener)

Create a BitbucketDeploymentEnvironment.

Parameters:

step - the DeploymentStep being executed

run - the Run

listener - the TaskListener

Returns:

the BitbucketDeploymentEnvironment configured by the provided step