org.adroitlogic.x.api

Interface XEnvironment

All Superinterfaces:

Initializable, Startable

All Known Implementing Classes:

Environment

public interface XEnvironment
extends Initializable, Startable

Environment represent the running environment of the project-x runtime. It will be used to determine environment specific details of the deployment.

This class is intended to store the tags attached to this instance where the tags will be changed when the failover strategy change the tags accordingly. The listeners registered will be notified about these tag changes. Each interested entity has to implement the XEnvironmentListener in order to be notified about the tag changes. Whenever a tag is changed, it is that entity's responsibility to take necessary actions to respond to the tag change.

Since:

17.01

Author:

Ruwan Linton, Imesha Sudasingha

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XEnvironment.Mode The mode of the environment usually fits into one of the deployment cycles

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.
Stream<File>	findProjects()
List<String>	getExtensionPackages()
String	getFirstValue(String tagName) Get the first value in the value list under a given key
default 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()
File	getTmpDir()
List<String>	getValues(String tagName) Returns the XTag values in the tag container.
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.

Methods inherited from interface org.adroitlogic.x.api.dec.Initializable

destroy, init

Methods inherited from interface org.adroitlogic.x.api.dec.Startable

start, stop

Method Detail

getProjectBaseDir

File getProjectBaseDir()

Gives the base directory for projects as a file

Returns:

the base directory for projects

getProjectConfDirPath

String getProjectConfDirPath()

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

Returns:

the integration flow files containing directory as a file

getTmpDir

File getTmpDir()

getProductName

String getProductName()

getNodeName

String getNodeName()

findProjects

Stream<File> findProjects()

getExtensionPackages

List<String> getExtensionPackages()

getMode

default XEnvironment.Mode getMode()

getRuntimeVersion

RuntimeVersion getRuntimeVersion()

getNodeSpace

String getNodeSpace()

addTags

void addTags(XTag... newTags)

Adds a XTag to the tag repository.

Parameters:

newTags - The tag to be added

removeTags

void removeTags(XTag... tagsToRemove)

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.

Parameters:

tagsToRemove - The tag to be removed

removeListener

void removeListener(XEnvironmentListener listener)

registerListener

void registerListener(XEnvironmentListener listener)

getValues

List<String> getValues(String tagName)

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

Parameters:

tagName - the name of the tag to retrieve tag values

Returns:

A map of current tags in the repository

getFirstValue

String getFirstValue(String tagName)

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

Parameters:

tagName - key of the tag

Returns:

first value under the given tag | null

containsValue

boolean containsValue(String tagName,
                      String expectedValue)

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

Parameters:

tagName - Tag name

expectedValue - value of the tag

Returns:

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

resetTags

void resetTags()

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.