org.wildfly.swarm.spi.api

Class SwarmProperties

java.lang.Object

org.wildfly.swarm.spi.api.SwarmProperties

public class SwarmProperties
extends Object

This class defines all system properties used by Swarm

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIND_ADDRESS Interface to bind servers, defaults to 0.0.0.0
static String	BUILD_MODULES Internal property
static String	BUILD_REPOS Internal property
static String	CONSUL_URL Full qualified http address, i.e.
static String	CURRENT_DEPLOYMENT Internal property
static String	DEBUG_PORT If provided, the swarm process will pause for debugging on the given port.
static String	DEPLOYMENT_TIMEOUT Timeout, in seconds, to wait for a deployment to occur, defaults to 300
static String	ENVIRONMENT The environment this process is running on (eg.
static String	EXPORT_DEPLOYMENT Causes a deployed artifact to be dumped to disk when swarm starts, for debugging.
static String	EXPORT_UBERJAR Internal property
static String	HTTP_EAGER Since introducing the delayed open HTTP listeners, it has been determined that maybe it'd be useful to be able to eagerly open the listeners through usage of a property.
static String	NODE_ID Internal property
static String	PORT_OFFSET Sets a global port adjustment, defaults to 0
static String	PROJECT_STAGE Activates a stage in project-stages.yml
static String	VERSION Internal property

Constructor Summary

Constructors

Constructor and Description
SwarmProperties()

Method Summary

Modifier and Type	Method and Description
static String	propertyVar(String property) Formats a property as ${property}
static String	propertyVar(String property, String defaultValue) Formats a property as ${property:defaultValue}

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

Internal property

See Also:

Constant Field Values

EXPORT_DEPLOYMENT

public static final String EXPORT_DEPLOYMENT

Causes a deployed artifact to be dumped to disk when swarm starts, for debugging. Defaults to false

See Also:

Constant Field Values

BUILD_MODULES

public static final String BUILD_MODULES

Internal property

See Also:

Constant Field Values

BUILD_REPOS

public static final String BUILD_REPOS

Internal property

See Also:

Constant Field Values

EXPORT_UBERJAR

public static final String EXPORT_UBERJAR

Internal property

See Also:

Constant Field Values

CURRENT_DEPLOYMENT

public static final String CURRENT_DEPLOYMENT

Internal property

See Also:

Constant Field Values

NODE_ID

public static final String NODE_ID

Internal property

See Also:

Constant Field Values

PORT_OFFSET

public static final String PORT_OFFSET

Sets a global port adjustment, defaults to 0

See Also:

Constant Field Values

BIND_ADDRESS

public static final String BIND_ADDRESS

Interface to bind servers, defaults to 0.0.0.0

See Also:

Constant Field Values

HTTP_EAGER

public static final String HTTP_EAGER

Since introducing the delayed open HTTP listeners, it has been determined that maybe it'd be useful to be able to eagerly open the listeners through usage of a property. If non-null, will cause the http listeners to not be lazy.

See Also:

Constant Field Values

DEBUG_PORT

public static final String DEBUG_PORT

If provided, the swarm process will pause for debugging on the given port. This option is only available when running an Arquillian test or mvn wildfly-swarm:run, not when executing java -jar. The latter requires normal Java debug agent parameters.

See Also:

Constant Field Values

ENVIRONMENT

public static final String ENVIRONMENT

The environment this process is running on (eg. openshift)

See Also:

Constant Field Values

PROJECT_STAGE

public static final String PROJECT_STAGE

Activates a stage in project-stages.yml

See Also:

Constant Field Values

CONSUL_URL

public static final String CONSUL_URL

Full qualified http address, i.e. 'http://localhost:8500/

See Also:

Constant Field Values

DEPLOYMENT_TIMEOUT

public static final String DEPLOYMENT_TIMEOUT

Timeout, in seconds, to wait for a deployment to occur, defaults to 300

See Also:

Constant Field Values

Constructor Detail

SwarmProperties

public SwarmProperties()

Method Detail

propertyVar

public static String propertyVar(String property)

Formats a property as ${property}

Parameters:

property - the property to be formatted

Returns:

the formatted value as ${property}

propertyVar

public static String propertyVar(String property,
                                 String defaultValue)

Formats a property as ${property:defaultValue}

Parameters:

property - the property to be formatted

defaultValue -

Returns:

the formatted value as ${property:defaultValue}