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
Path	appDir app_dir: The application source package directory
String	appId app_id: The unique ID of the application being deployed
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 Aka plugin_dir
Path	controlDir control_dir: The control subdirectory located within the genapp directory
Path	genappDir genapp_dir: The genapp subdirectory located within the application directory
Path	logDir log_dir: The conventional location for application logs
Path	packageDir pkg_dir: The application source package directory

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

appDir

@Nonnull
public final Path appDir

app_dir: The application source package directory

clickstackDir

@Nonnull
public final Path clickstackDir

Aka plugin_dir

packageDir

@Nonnull
public final Path packageDir

pkg_dir: The application source package directory

appUser

@Nonnull
public final String appUser

app_user: The user associated with the application being deployed

appId

@Nonnull
public final String appId

app_id: The unique ID of the application being deployed

appPort

@Nonnull
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 $app_dir/.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.

Constructor Detail

Environment

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

Method Detail

toString

public String toString()

Overrides:

toString in class Object