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 within 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.

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)
<R extends Resource> R	getResource(String resourceName)
Resource	getResourceByType(String type)
Map<String,Resource>	getResources()
<R extends Resource> Collection<R>	getResources(Class<R> type)
<R extends Resource> Collection<R>	getResourcesByType(String type)
String	getRuntimeParameter(String section, String name)
String	getRuntimeParameter(String section, String name, String defaultValue)
RuntimeProperty	getRuntimeProperty(String section)
boolean	hasSection(String section)
void	setRuntimeParameter(String parameter, String value)
void	setRuntimeParameter(String section, String name, String value)

Methods inherited from class java.lang.Object

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

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()

Returns:

key resource entry key in metadata.json, value: the Resource

getResources

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

getResourcesByType

@Nonnull
public <R extends Resource> Collection<R> getResourcesByType(@Nullable
                                                            String type)

getResourceByType

@Nullable
public Resource getResourceByType(@Nullable
                                  String type)
                           throws IllegalStateException

Parameters:

type -

Returns:

Throws:

IllegalStateException - more than 1 Resource matching given

getEnvironmentVariable

@Nullable
public String getEnvironmentVariable(String variableName)

getEnvironment

@Nonnull
public Map<String,String> getEnvironment()

hasSection

public boolean hasSection(@Nullable
                 String section)

getRuntimeProperty

@Nullable
public RuntimeProperty getRuntimeProperty(String section)

Throws:

NullPointerException - if section does not exist

getRuntimeParameter

@Nullable
public String getRuntimeParameter(@Nullable
                                  String section,
                                  @Nullable
                                  String name)

Parameters:

section -

name -

Returns:

null if the section does not exist or if the parameter does not exist

getRuntimeParameter

@Nullable
public String getRuntimeParameter(@Nullable
                                  String section,
                                  @Nullable
                                  String name,
                                  @Nullable
                                  String defaultValue)

Parameters:

section -

name -

defaultValue -

Returns:

null if the section does not exist or if the parameter does not exist and the defaultValue is null

setRuntimeParameter

public void setRuntimeParameter(@Nonnull
                       String parameter,
                       @Nonnull
                       String value)

Parameters:

parameter - format section + '.' + parameterName

value -

setRuntimeParameter

public void setRuntimeParameter(@Nonnull
                       String section,
                       @Nonnull
                       String name,
                       @Nonnull
                       String value)