com.cloudbees.clickstack.domain.metadata

Class Metadata

java.lang.Object

com.cloudbees.clickstack.domain.metadata.Metadata

public class Metadata
extends Object

It stores GenApp resources, environment variables (given by -P with the SDK), and runtime parameters (given by -R with the SDK). It also makes them accessible for other classes to (typically) write configuration files whithin ClickStacks.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.Builder The Builder class creates a new Metadata instance from a metadata.json file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_JAVA_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
	Metadata()
protected	Metadata(Map<String,Resource> resources, Map<String,String> environment, Map<String,RuntimeProperty> runtimeProperties) This constructor is used by the Builder subclass to create a new Metadata instance

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getEnvironment()
String	getEnvironmentVariable(String variableName)
Path	getJavaExecutable()
Path	getJavaHome()
<R extends Resource> R	getResource(String resourceName)
Map<String,Resource>	getResources()
<R extends Resource> Collection<R>	getResources(Class<R> type)
String	getRuntimeParameter(String parent, String propertyName)
String	getRuntimeParameter(String parent, String propertyName, String defaultValue)
Map<String,String>	getRuntimeProperty(String section)
void	setRuntimeParameter(String parameter, String value)
void	setRuntimeParameter(String section, String property, String value)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_JAVA_VERSION

public static final String DEFAULT_JAVA_VERSION

See Also:

Constant Field Values

Constructor Detail

Metadata

protected Metadata(Map<String,Resource> resources,
        Map<String,String> environment,
        Map<String,RuntimeProperty> runtimeProperties)

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

Parameters:

resources - A map of the GenApp resources

environment - A map of the environment variables

runtimeProperties - A map of RuntimeProperties

Metadata

public Metadata()

Method Detail

getResource

@Nonnull
public <R extends Resource> R getResource(String resourceName)

getResources

@Nonnull
public Map<String,Resource> getResources()

getResources

@Nonnull
public <R extends Resource> Collection<R> getResources(Class<R> type)

getEnvironmentVariable

public String getEnvironmentVariable(String variableName)

getEnvironment

public Map<String,String> getEnvironment()

getRuntimeProperty

@Nullable
public Map<String,String> getRuntimeProperty(String section)

Throws:

NullPointerException - if parent property does not exist

getRuntimeParameter

@Nullable
public String getRuntimeParameter(String parent,
                                  String propertyName)

getRuntimeParameter

public String getRuntimeParameter(String parent,
                         String propertyName,
                         String defaultValue)

setRuntimeParameter

public void setRuntimeParameter(String parameter,
                       String value)

setRuntimeParameter

public void setRuntimeParameter(String section,
                       String property,
                       String value)

getJavaExecutable

@Nonnull
public Path getJavaExecutable()

getJavaHome

@Nonnull
public Path getJavaHome()