org.adroitlogic.x.core

Class Environment

java.lang.Object

org.adroitlogic.x.core.Environment

All Implemented Interfaces:

Initializable, Startable, XEnvironment

@AutoInitialize
 @AutoStart
public class Environment
extends Object
implements XEnvironment

The runtime environment implementation that contains the environment mode and several other information related the Project-X runtime

Since:

17.01

Author:

Ruwan Linton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Environment.ProductInfoProvider

Nested classes/interfaces inherited from interface org.adroitlogic.x.api.XEnvironment

XEnvironment.Mode

Constructor Summary

Constructors

Constructor and Description
Environment(String nodeName)

Method Summary

Modifier and Type	Method and Description
void	addTags(XTag... newTags) Adds a XTag to the tag repository.
boolean	containsValue(String tagName, String expectedValue) This method should be used by the listeners when taking decisions based the current tags in the repository.
void	destroy()
Stream<File>	findProjects()
List<String>	getExtensionPackages()
String	getFirstValue(String key) Get the first value in the value list under a given key
XEnvironment.Mode	getMode()
String	getNodeName()
String	getNodeSpace()
String	getProductName()
File	getProjectBaseDir() Gives the base directory for projects as a file
String	getProjectConfDirPath() Gives the project's configuration directory which contains the integration flow files
RuntimeVersion	getRuntimeVersion()
Map<String,List<String>>	getTags()
File	getTmpDir()
List<String>	getValues(String tagName) Returns the XTag values in the tag container.
void	init(org.springframework.context.ApplicationContext context)
void	registerListener(XEnvironmentListener listener)
void	removeListener(XEnvironmentListener listener)
void	removeTags(XTag... tagsToRemove) Remove one or more XTags from the tag repository.
void	resetTags() Reset the tag listener to its initial state.
void	setExtensionPackages(List<String> extensionPackages)
void	setMode(XEnvironment.Mode mode)
void	setNodeSpace(String nodeSpace)
void	setProjectBaseDir(String projectBaseDir)
void	setTags(Map<String,String> tagsMap)
void	setTmpDir(String tmpDir)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

Environment

public Environment(String nodeName)

Method Detail

setProjectBaseDir

public void setProjectBaseDir(String projectBaseDir)

getProjectBaseDir

public File getProjectBaseDir()

Description copied from interface: XEnvironment

Gives the base directory for projects as a file

Specified by:

getProjectBaseDir in interface XEnvironment

Returns:

the base directory for projects

getProjectConfDirPath

public String getProjectConfDirPath()

Description copied from interface: XEnvironment

Gives the project's configuration directory which contains the integration flow files

Specified by:

getProjectConfDirPath in interface XEnvironment

Returns:

the integration flow files containing directory as a file

setTmpDir

public void setTmpDir(String tmpDir)

getTmpDir

public File getTmpDir()

Specified by:

getTmpDir in interface XEnvironment

getProductName

public String getProductName()

Specified by:

getProductName in interface XEnvironment

findProjects

public Stream<File> findProjects()

Specified by:

findProjects in interface XEnvironment

getMode

public XEnvironment.Mode getMode()

Specified by:

getMode in interface XEnvironment

setMode

public void setMode(XEnvironment.Mode mode)

getExtensionPackages

public List<String> getExtensionPackages()

Specified by:

getExtensionPackages in interface XEnvironment

setExtensionPackages

public void setExtensionPackages(List<String> extensionPackages)

getRuntimeVersion

public RuntimeVersion getRuntimeVersion()

Specified by:

getRuntimeVersion in interface XEnvironment

init

public void init(org.springframework.context.ApplicationContext context)

Specified by:

init in interface Initializable

destroy

public void destroy()

Specified by:

destroy in interface Initializable

start

public void start()

Specified by:

start in interface Startable

stop

public void stop()

Specified by:

stop in interface Startable

addTags

public void addTags(XTag... newTags)

Description copied from interface: XEnvironment

Adds a XTag to the tag repository.

Specified by:

addTags in interface XEnvironment

Parameters:

newTags - The tag to be added

removeTags

public void removeTags(XTag... tagsToRemove)

Description copied from interface: XEnvironment

Remove one or more XTags from the tag repository. The tags to be removed should be given as a key value pair. If the value of the given key is equal, the tag will be removed.

Specified by:

removeTags in interface XEnvironment

Parameters:

tagsToRemove - The tag to be removed

registerListener

public void registerListener(XEnvironmentListener listener)

Specified by:

registerListener in interface XEnvironment

removeListener

public void removeListener(XEnvironmentListener listener)

Specified by:

removeListener in interface XEnvironment

getTags

public Map<String,List<String>> getTags()

containsValue

public boolean containsValue(String tagName,
                             String expectedValue)

Description copied from interface: XEnvironment

This method should be used by the listeners when taking decisions based the current tags in the repository.

Specified by:

containsValue in interface XEnvironment

Parameters:

tagName - Tag name

expectedValue - value of the tag

Returns:

Returns true if the given tag is currently available in the tag repository.

resetTags

public void resetTags()

Description copied from interface: XEnvironment

Reset the tag listener to its initial state. That is, all the changes made after creating the tag container will cleared. All the listeners will be notified about resetting the tag container for them to take necessary actions.

Specified by:

resetTags in interface XEnvironment

getValues

public List<String> getValues(String tagName)

Description copied from interface: XEnvironment

Returns the XTag values in the tag container. It is recommended not to use this method for decision making purposes. Use XEnvironment.containsValue(String, String) instead

Specified by:

getValues in interface XEnvironment

Parameters:

tagName - the name of the tag to retrieve tag values

Returns:

A map of current tags in the repository

getFirstValue

public String getFirstValue(String key)

Description copied from interface: XEnvironment

Get the first value in the value list under a given key

Specified by:

getFirstValue in interface XEnvironment

Parameters:

key - key of the tag

Returns:

first value under the given tag | null

setTags

public void setTags(Map<String,String> tagsMap)

getNodeName

public String getNodeName()

Specified by:

getNodeName in interface XEnvironment

getNodeSpace

public String getNodeSpace()

Specified by:

getNodeSpace in interface XEnvironment

setNodeSpace

public void setNodeSpace(String nodeSpace)