A B C D E F G H I L M N P R S T U X

A

appDir - Variable in class com.cloudbees.clickstack.domain.environment.Environment

app_dir: The application source package directory

appId - Variable in class com.cloudbees.clickstack.domain.environment.Environment

app_id: The unique ID of the application being deployed

appPort - Variable in class com.cloudbees.clickstack.domain.environment.Environment

app_port: The genapp assigned port for the application

appUser - Variable in class com.cloudbees.clickstack.domain.environment.Environment

app_user: The user associated with the application being deployed

argumentsToEnvironment(String[]) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

B

beginWith(String, String) - Static method in class com.cloudbees.clickstack.util.Strings2

buildResource(Map<String, String>) - Static method in class com.cloudbees.clickstack.domain.metadata.Resource.Builder

Creates a new resource from a given metadata section.

C

checkResource(Resource) - Static method in class com.cloudbees.clickstack.domain.metadata.Database

Checks if a given Resource is a database definition.

checkResource(Resource) - Static method in class com.cloudbees.clickstack.domain.metadata.Email

Checks if a given Resource is a mail endpoint.

checkResource(Resource) - Static method in class com.cloudbees.clickstack.domain.metadata.SessionStore

Checks if a Resource is a session store.

checkRootElement(Document, String) - Static method in class com.cloudbees.clickstack.util.XmlUtils

chmodAddReadExecute(Path) - Static method in class com.cloudbees.clickstack.util.Files2

chmodAddReadWrite(Path) - Static method in class com.cloudbees.clickstack.util.Files2

chmodReadExecute(Path) - Static method in class com.cloudbees.clickstack.util.Files2

chmodReadOnly(Path) - Static method in class com.cloudbees.clickstack.util.Files2

chmodReadWrite(Path) - Static method in class com.cloudbees.clickstack.util.Files2

Deprecated.

use Files2.chmodSetReadWrite(java.nio.file.Path)

chmodSetReadOnly(Path) - Static method in class com.cloudbees.clickstack.util.Files2

chmodSetReadWrite(Path) - Static method in class com.cloudbees.clickstack.util.Files2

clickstackDir - Variable in class com.cloudbees.clickstack.domain.environment.Environment

Aka plugin_dir

com.cloudbees.clickstack.domain.environment - package com.cloudbees.clickstack.domain.environment

com.cloudbees.clickstack.domain.metadata - package com.cloudbees.clickstack.domain.metadata

com.cloudbees.clickstack.util - package com.cloudbees.clickstack.util

CommandLineUtils - Class in com.cloudbees.clickstack.util

CommandLineUtils() - Constructor for class com.cloudbees.clickstack.util.CommandLineUtils

controlDir - Variable in class com.cloudbees.clickstack.domain.environment.Environment

control_dir: The control subdirectory located within the genapp directory

copyArtifactToDirectory(Path, String, Path) - Static method in class com.cloudbees.clickstack.util.Files2

copyDirectoryContent(Path, Path) - Static method in class com.cloudbees.clickstack.util.Files2

copyToDirectory(Path, Path) - Static method in class com.cloudbees.clickstack.util.Files2

D

Database - Class in com.cloudbees.clickstack.domain.metadata

This class stores Resources that contain Database credentials.

Database(Resource) - Constructor for class com.cloudbees.clickstack.domain.metadata.Database

DEFAULT_JAVA_VERSION - Static variable in class com.cloudbees.clickstack.domain.metadata.Metadata

deleteDirectory(Path) - Static method in class com.cloudbees.clickstack.util.Files2

DRIVER_MS_SQLSERVER - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

DRIVER_MYSQL - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

DRIVER_ORACLE - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

DRIVER_POSTGRES - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

dump(Path) - Static method in class com.cloudbees.clickstack.util.Files2

E

Email - Class in com.cloudbees.clickstack.domain.metadata

Stores a SMTP server as a Resource.

Email(Resource) - Constructor for class com.cloudbees.clickstack.domain.metadata.Email

Environment - Class in com.cloudbees.clickstack.domain.environment

See genapp documentation / plugins / Setup Environment Variables

Environment(Path, Path, Path, String, String, int, Path, Path) - Constructor for class com.cloudbees.clickstack.domain.environment.Environment

F

Files2 - Class in com.cloudbees.clickstack.util

Files2() - Constructor for class com.cloudbees.clickstack.util.Files2

filterProperties(Collection<String>) - Method in class com.cloudbees.clickstack.domain.metadata.Resource

Gets all properties matching particular keys.

findArtifact(Path, String) - Static method in class com.cloudbees.clickstack.util.Files2

findArtifact(Path, String, String) - Static method in class com.cloudbees.clickstack.util.Files2

findUniqueFolderBeginningWith(Path, String) - Static method in class com.cloudbees.clickstack.util.Files2

flush(Document, OutputStream) - Static method in class com.cloudbees.clickstack.util.XmlUtils

fromFile(File) - Static method in class com.cloudbees.clickstack.domain.metadata.Metadata.Builder

This method parses a metadata.json file and returns a new Metadata instance containing the metadata that has been parsed.

fromFile(Path) - Static method in class com.cloudbees.clickstack.domain.metadata.Metadata.Builder

fromJson(JsonNode) - Static method in class com.cloudbees.clickstack.domain.metadata.Metadata.Builder

This method is called from the fromStream method to parse json from a stream.

fromJsonString(String, boolean) - Static method in class com.cloudbees.clickstack.domain.metadata.Metadata.Builder

This method is called from the fromStream method to parse json from a stream.

fromStream(InputStream) - Static method in class com.cloudbees.clickstack.domain.metadata.Metadata.Builder

This method is called from the fromFile method to parse json from a stream.

G

genappDir - Variable in class com.cloudbees.clickstack.domain.environment.Environment

genapp_dir: The genapp subdirectory located within the application directory

getDataSourceClassName(String) - Static method in class com.cloudbees.clickstack.domain.metadata.Database

getDataSourceClassName() - Method in class com.cloudbees.clickstack.domain.metadata.Database

getDescriptor(String) - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getDescriptors() - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getDriver(String) - Static method in class com.cloudbees.clickstack.domain.metadata.Database

getDriver() - Method in class com.cloudbees.clickstack.domain.metadata.Database

getEnvironment() - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getEnvironmentVariable(String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getHost() - Method in class com.cloudbees.clickstack.domain.metadata.Email

getJavaDriver(String) - Static method in class com.cloudbees.clickstack.domain.metadata.Database

getJavaDriver() - Method in class com.cloudbees.clickstack.domain.metadata.Database

getJavaExecutable() - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

Convenient way to retrieve java executable path, must be kept in sync with Java ClickStack that is the actual implementation to determine JRE to be used at runtime.

getJavaHome() - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

Convenient way to retrieve JAVA_HOME, must be kept in sync with Java ClickStack that is the actual implementation to determine JRE to be used at runtime.

getName() - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getNodes() - Method in class com.cloudbees.clickstack.domain.metadata.SessionStore

Returns a list of the membase nodes for this session store.

getOption(String, String[]) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

getOption(String, String[], String) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

getOption(String, String[], boolean, boolean) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

getOptionAsInt(String, String[]) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

getOptionAsPath(String, String[]) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

getOptionAsPath(String, String[], Path) - Static method in class com.cloudbees.clickstack.util.CommandLineUtils

getParameter(String) - Method in class com.cloudbees.clickstack.domain.metadata.RuntimeProperty

getPassword() - Method in class com.cloudbees.clickstack.domain.metadata.Database

getPassword() - Method in class com.cloudbees.clickstack.domain.metadata.Email

getPassword() - Method in class com.cloudbees.clickstack.domain.metadata.SessionStore

getProperties() - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getProperty(String) - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getProperty(String, String) - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getResource(String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getResources() - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getResources(Class<R>) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getRuntimeParameter(String, String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getRuntimeParameter(String, String, String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getRuntimeProperty(String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

getSection() - Method in class com.cloudbees.clickstack.domain.metadata.RuntimeProperty

getType() - Method in class com.cloudbees.clickstack.domain.metadata.Resource

getUniqueElement(Document, String) - Static method in class com.cloudbees.clickstack.util.XmlUtils

getUniqueElement(Element, String) - Static method in class com.cloudbees.clickstack.util.XmlUtils

getUniqueElement(Node, String) - Static method in class com.cloudbees.clickstack.util.XmlUtils

getUrl() - Method in class com.cloudbees.clickstack.domain.metadata.Database

getUsername() - Method in class com.cloudbees.clickstack.domain.metadata.Database

getUsername() - Method in class com.cloudbees.clickstack.domain.metadata.Email

getUsername() - Method in class com.cloudbees.clickstack.domain.metadata.SessionStore

getValidationQuery(String) - Static method in class com.cloudbees.clickstack.domain.metadata.Database

getValidationQuery() - Method in class com.cloudbees.clickstack.domain.metadata.Database

H

hasSection(String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

HOST_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.Email

I

insertSiblingAfter(Element, Element) - Static method in class com.cloudbees.clickstack.util.XmlUtils

L

loadXmlDocumentFromFile(File) - Static method in class com.cloudbees.clickstack.util.XmlUtils

loadXmlDocumentFromStream(InputStream) - Static method in class com.cloudbees.clickstack.util.XmlUtils

logDir - Variable in class com.cloudbees.clickstack.domain.environment.Environment

log_dir: The conventional location for application logs

M

Metadata - Class in com.cloudbees.clickstack.domain.metadata

It stores GenApp resources, environment variables (given by -P with the SDK), and runtime parameters (given by -R with the SDK).

Metadata(Map<String, Resource>, Map<String, String>, Map<String, RuntimeProperty>) - Constructor for class com.cloudbees.clickstack.domain.metadata.Metadata

This constructor is used by the Builder subclass to create a new Metadata instance

Metadata() - Constructor for class com.cloudbees.clickstack.domain.metadata.Metadata

Metadata.Builder - Class in com.cloudbees.clickstack.domain.metadata

The Builder class creates a new Metadata instance from a metadata.json file.

Metadata.Builder() - Constructor for class com.cloudbees.clickstack.domain.metadata.Metadata.Builder

N

NAME_DESCRIPTOR - Static variable in class com.cloudbees.clickstack.domain.metadata.Resource

NODES_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.SessionStore

P

packageDir - Variable in class com.cloudbees.clickstack.domain.environment.Environment

pkg_dir: The application source package directory

PASSWORD_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

PASSWORD_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.Email

PASSWORD_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.SessionStore

R

Resource - Class in com.cloudbees.clickstack.domain.metadata

The Resource class stores a Genapp resource characterized by descriptors and parameters.

Resource(Map<String, String>, Map<String, String>) - Constructor for class com.cloudbees.clickstack.domain.metadata.Resource

Constructs a new resource, given the properties and descriptors.

Resource.Builder - Class in com.cloudbees.clickstack.domain.metadata

The Builder class instanciates new Resources.

Resource.Builder() - Constructor for class com.cloudbees.clickstack.domain.metadata.Resource.Builder

RuntimeProperty - Class in com.cloudbees.clickstack.domain.metadata

This class stores properties for a given name (i.e.

RuntimeProperty(String, Map<String, String>) - Constructor for class com.cloudbees.clickstack.domain.metadata.RuntimeProperty

Create a new RuntimeProperty from the name name and a map of key-value pairs.

RuntimeProperty(String) - Constructor for class com.cloudbees.clickstack.domain.metadata.RuntimeProperty

S

SessionStore - Class in com.cloudbees.clickstack.domain.metadata

This class stores Membase distributed session stores.

SessionStore(Resource) - Constructor for class com.cloudbees.clickstack.domain.metadata.SessionStore

Creates a new SessionStore from an existing Resource.

setRuntimeParameter(String, String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

setRuntimeParameter(String, String, String) - Method in class com.cloudbees.clickstack.domain.metadata.Metadata

Strings2 - Class in com.cloudbees.clickstack.util

Strings2() - Constructor for class com.cloudbees.clickstack.util.Strings2

substringAfterFirst(String, char) - Static method in class com.cloudbees.clickstack.util.Strings2

substringBeforeFirst(String, char) - Static method in class com.cloudbees.clickstack.util.Strings2

T

toString() - Method in class com.cloudbees.clickstack.domain.environment.Environment

TYPE_DESCRIPTOR - Static variable in class com.cloudbees.clickstack.domain.metadata.Resource

TYPES - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

TYPES - Static variable in class com.cloudbees.clickstack.domain.metadata.Email

TYPES - Static variable in class com.cloudbees.clickstack.domain.metadata.SessionStore

U

unzip(String, String) - Static method in class com.cloudbees.clickstack.util.Files2

Unzips the specified zip file to the specified destination directory.

unzip(Path, Path) - Static method in class com.cloudbees.clickstack.util.Files2

URL_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

USERNAME_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.Database

USERNAME_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.Email

USERNAME_PROPERTY - Static variable in class com.cloudbees.clickstack.domain.metadata.SessionStore

X

XmlUtils - Class in com.cloudbees.clickstack.util

XmlUtils() - Constructor for class com.cloudbees.clickstack.util.XmlUtils

A B C D E F G H I L M N P R S T U X