public class AppProps extends Props
Flow
may or may not be required to have set. These properties are typically passed to a Flow
via a FlowConnector
.
In prior releases, the FlowConnector was responsible for setting the "application jar" class or path. Those
methods have been deprecated and moved to AppProps.
New property settings that may be set in Cascading 2 are application name, version, and any tags.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
APP_FRAMEWORKS |
static java.lang.String |
APP_ID |
static java.lang.String |
APP_JAR_CLASS |
static java.lang.String |
APP_JAR_PATH |
static java.lang.String |
APP_NAME |
static java.lang.String |
APP_TAGS |
static java.lang.String |
APP_VERSION |
protected java.util.Set<java.lang.String> |
frameworks |
protected java.lang.Class |
jarClass |
protected java.lang.String |
jarPath |
protected java.lang.String |
name |
protected java.util.Set<java.lang.String> |
tags |
protected java.lang.String |
version |
Constructor and Description |
---|
AppProps() |
AppProps(java.lang.String name,
java.lang.String version)
Sets the name and version of this application.
|
Modifier and Type | Method and Description |
---|---|
static void |
addApplicationFramework(java.util.Map<java.lang.Object,java.lang.Object> properties,
java.lang.String framework)
Adds a framework "name:version" string to the property set and to the System properties.
|
static void |
addApplicationTag(java.util.Map<java.lang.Object,java.lang.Object> properties,
java.lang.String tag) |
AppProps |
addFramework(java.lang.String framework)
Adds a new framework name to the list of frameworks used.
|
AppProps |
addFramework(java.lang.String framework,
java.lang.String version)
Adds a new framework name and its version to the list of frameworks used.
|
AppProps |
addFrameworks(java.lang.String... frameworks)
Adds new framework names to the list of frameworks used.
|
protected void |
addPropertiesTo(java.util.Properties properties) |
AppProps |
addTag(java.lang.String tag) |
AppProps |
addTags(java.lang.String... tags) |
static AppProps |
appProps() |
static java.lang.String |
getApplicationFrameworks(java.util.Map<java.lang.Object,java.lang.Object> properties) |
static java.lang.String |
getApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties) |
static java.lang.Class |
getApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties)
Method getApplicationJarClass returns the Class set by the setApplicationJarClass method.
|
static java.lang.String |
getApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties)
Method getApplicationJarPath return the path set by the setApplicationJarPath method.
|
static java.lang.String |
getApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties) |
static java.lang.String |
getApplicationTags(java.util.Map<java.lang.Object,java.lang.Object> properties) |
static java.lang.String |
getApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties) |
java.lang.String |
getFrameworks()
Returns a list of frameworks used to build this App.
|
java.lang.String |
getTags() |
static void |
resetAppID()
Sets the static appID value to null.
|
static void |
setApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties) |
static void |
setApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties,
java.lang.Class type)
Method setApplicationJarClass is used to set the application jar file.
|
static void |
setApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties,
java.lang.String path)
Method setApplicationJarPath is used to set the application jar file.
|
static void |
setApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties,
java.lang.String name) |
static void |
setApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties,
java.lang.String version) |
AppProps |
setJarClass(java.lang.Class jarClass)
Method setJarClass is used to set the application jar file.
|
AppProps |
setJarPath(java.lang.String jarPath)
Method setJarPath is used to set the application jar file.
|
AppProps |
setName(java.lang.String name) |
AppProps |
setVersion(java.lang.String version) |
buildProperties, buildProperties, buildProperties, buildProperties, setProperties, setProperties
public static final java.lang.String APP_ID
public static final java.lang.String APP_NAME
public static final java.lang.String APP_VERSION
public static final java.lang.String APP_TAGS
public static final java.lang.String APP_FRAMEWORKS
public static final java.lang.String APP_JAR_CLASS
public static final java.lang.String APP_JAR_PATH
protected java.lang.String name
protected java.lang.String version
protected java.util.Set<java.lang.String> tags
protected java.lang.Class jarClass
protected java.lang.String jarPath
protected java.util.Set<java.lang.String> frameworks
public AppProps()
public AppProps(java.lang.String name, java.lang.String version)
name
- of type Stringversion
- of type Stringpublic static AppProps appProps()
public static void setApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.Class type)
setApplicationJarPath(java.util.Map, String)
, otherwise ClassNotFound exceptions are likely.properties
- of type Maptype
- of type Classpublic static java.lang.Class getApplicationJarClass(java.util.Map<java.lang.Object,java.lang.Object> properties)
properties
- of type Mappublic static void setApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String path)
setApplicationJarClass(java.util.Map, Class)
or
setApplicationJarPath(java.util.Map, String), otherwise ClassNotFound exceptions are likely.properties
- of type Mappath
- of type Stringpublic static java.lang.String getApplicationJarPath(java.util.Map<java.lang.Object,java.lang.Object> properties)
properties
- of type Mappublic static void setApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties)
public static java.lang.String getApplicationID(java.util.Map<java.lang.Object,java.lang.Object> properties)
public static void resetAppID()
public static void setApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String name)
public static java.lang.String getApplicationName(java.util.Map<java.lang.Object,java.lang.Object> properties)
public static void setApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String version)
public static java.lang.String getApplicationVersion(java.util.Map<java.lang.Object,java.lang.Object> properties)
public static void addApplicationTag(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String tag)
public static java.lang.String getApplicationTags(java.util.Map<java.lang.Object,java.lang.Object> properties)
public static void addApplicationFramework(java.util.Map<java.lang.Object,java.lang.Object> properties, java.lang.String framework)
properties
- may be null, additionally adds to System propertiesframework
- "name:version" Stringpublic static java.lang.String getApplicationFrameworks(java.util.Map<java.lang.Object,java.lang.Object> properties)
public AppProps setName(java.lang.String name)
public AppProps setVersion(java.lang.String version)
public java.lang.String getTags()
public AppProps addTag(java.lang.String tag)
public AppProps addTags(java.lang.String... tags)
public java.lang.String getFrameworks()
public AppProps addFramework(java.lang.String framework)
foo-flow-builder:1.2.3
.
See addFramework(String, String)
.framework
- A Stringpublic AppProps addFramework(java.lang.String framework, java.lang.String version)
foo-flow-builder:1.2.3
.framework
- A Stringpublic AppProps addFrameworks(java.lang.String... frameworks)
foo-flow-builder:1.2.3
.frameworks
- Stringspublic AppProps setJarClass(java.lang.Class jarClass)
setApplicationJarPath(java.util.Map, String)
, otherwise ClassNotFound exceptions are likely.jarClass
- of type Classpublic AppProps setJarPath(java.lang.String jarPath)
setJarClass(Class)
or
setJarPath(java.util.Map, String), otherwise ClassNotFound exceptions are likely.jarPath
- of type Stringprotected void addPropertiesTo(java.util.Properties properties)
addPropertiesTo
in class Props