com.cloudbees.clickstack.domain.environment

Class Environment

java.lang.Object

com.cloudbees.clickstack.domain.environment.Environment

public class Environment
extends Object

See genapp documentation / plugins / Setup Environment Variables

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
String	accountName CloudBees account
Path	appDir app_dir: The application source package directory
Path	appExtraFiles Convenient directory for application to embed custom extra files, like runtime dependencies.
String	appId app_id: The unique ID of the application being deployed
String	appName Application name
int	appPort app_port: The genapp assigned port for the application
String	appUser app_user: The user associated with the application being deployed
Path	clickstackDir directory that contains the plugin's setup script, aka plugin_dir
Path	controlDir control_dir: The control subdirectory located within the genapp directory
static String	DEFAULT_JAVA_VERSION
protected FileSystem	fs
Path	genappDir genapp_dir: The genapp subdirectory located within the application directory
Path	javaHome
Path	logDir log_dir: The conventional location for application logs
protected org.slf4j.Logger	logger
Path	packageDir pkd_dir: The application source package directory
String	serverInstanceId Identifier of the server on which the app is deployed, usually the EC2 Instance ID, otherwise the server hostname

Constructor Summary

Constructors

Constructor and Description
Environment(Path appDir, Path clickstackDir, Path packageDir, String appUser, String appId, int appPort, Path controlDir, Path logDir, String appName, String accountName, String serverInstanceId)
Environment(Path appDir, Path clickstackDir, Path packageDir, String appUser, String appId, int appPort, String appName, String accountName, String serverInstanceId)

Method Summary

Methods

Modifier and Type	Method and Description
String	expand(String s) Expand variables in string as $variable or ${variable}/ Invalid variables are left as-is.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JAVA_VERSION

public static final String DEFAULT_JAVA_VERSION

See Also:

Constant Field Values

appDir

@Nonnull
public final Path appDir

app_dir: The application source package directory

clickstackDir

@Nonnull
public final Path clickstackDir

directory that contains the plugin's setup script, aka plugin_dir

packageDir

@Nonnull
public final Path packageDir

pkd_dir: The application source package directory

appUser

@Nonnull
public final String appUser

app_user: The user associated with the application being deployed

appName

@Nonnull
public final String appName

Application name

accountName

@Nonnull
public final String accountName

CloudBees account

appId

@Nonnull
public final String appId

app_id: The unique ID of the application being deployed

appPort

public final int appPort

app_port: The genapp assigned port for the application

controlDir

@Nonnull
public final Path controlDir

control_dir: The control subdirectory located within the genapp directory

logDir

@Nonnull
public final Path logDir

log_dir: The conventional location for application logs

genappDir

@Nonnull
public final Path genappDir

genapp_dir: The genapp subdirectory located within the application directory

This variable is equivalent to $appDir/.genapp.

Plugins may use this variable to reference files located in the genapp subdirectory. These may be files created by other plugins that have already performed their setup operations or files that the plugin itself creates.

appExtraFiles

@Nonnull
public final Path appExtraFiles

Convenient directory for application to embed custom extra files, like runtime dependencies.

This variable is equivalent to $appDir/app-extra-files

serverInstanceId

@Nonnull
public final String serverInstanceId

Identifier of the server on which the app is deployed, usually the EC2 Instance ID, otherwise the server hostname

logger

protected final org.slf4j.Logger logger

fs

protected final FileSystem fs

javaHome

public Path javaHome

Constructor Detail

Environment

public Environment(@Nonnull
           Path appDir,
           @Nonnull
           Path clickstackDir,
           @Nonnull
           Path packageDir,
           @Nonnull
           String appUser,
           @Nonnull
           String appId,
           int appPort,
           @Nonnull
           String appName,
           @Nonnull
           String accountName,
           @Nonnull
           String serverInstanceId)

Environment

public Environment(@Nonnull
           Path appDir,
           @Nonnull
           Path clickstackDir,
           @Nonnull
           Path packageDir,
           @Nonnull
           String appUser,
           @Nonnull
           String appId,
           int appPort,
           @Nonnull
           Path controlDir,
           @Nonnull
           Path logDir,
           @Nonnull
           String appName,
           @Nonnull
           String accountName,
           @Nonnull
           String serverInstanceId)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

expand

public String expand(@Nullable
            String s)

Expand variables in string as $variable or ${variable}/ Invalid variables are left as-is.

Adapted from hudson.Util#replaceMacro