org.thales.punch.platform.impl

Class EntityImpl

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.thales.punch.settings.impl.SettingsMapImpl

org.thales.punch.settings.impl.NamedSettingsMapImpl

org.thales.punch.settings.impl.JsonSettingsMapImpl

org.thales.punch.platform.impl.EntityImpl

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, IEntity, ISettingsMap

Direct Known Subclasses:

BookImpl, ChannelImpl

public abstract class EntityImpl
extends JsonSettingsMapImpl
implements IEntity

IChannel implementation

Author:

dimi

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Path	path
protected String	shortName
protected TenantImpl	tenant

Fields inherited from class org.thales.punch.settings.impl.SettingsMapImpl

originatorName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityImpl(TenantImpl tenant, String name, ISettingsMap map) Constructor when called from configuration folder.

Method Summary

Modifier and Type	Method and Description
IApplication	getApplication(String name)
IApplication	getApplicationForCluster(String name, String cluster) Return the a given application
Collection<IApplication>	getApplications()
List<IApplication>	getApplications(String namePattern)
List<IApplication>	getApplicationsForCluster(String namePattern, String clusterPattern)
int	getApplicationSize()
List<String>	getApplicationsName()
String	getHash(String folder)
Collection<ITopic>	getKafkaTopics()
int	getMajorVersion()
int	getMinorVersion()
String	getName()
Path	getPath()
TenantImpl	getTenant()
String	getUUID()
String	getVersion()
boolean	isStartableByTenant()
boolean	isStoppableByTenant()

Methods inherited from class org.thales.punch.settings.impl.NamedSettingsMapImpl

newSettingsListChild, newSettingsMapChild, put, putAll, putWithNoCloning, setOriginatorName

Methods inherited from class org.thales.punch.settings.impl.SettingsMapImpl

asFlatValuesMap, asFlatValuesMap, asFlatValuesMapIgnoreSettingsList, asHjsonString, asJsonString, asJsonString, asKvString, asListFlatValuesMapIgnoreSettingsList, asYamlString, childAsJson, childAsRawContent, childAsTarGz, childFileAsMap, childIsDir, childIsFile, getAsBoolean, getAsBoolean, getAsDouble, getAsInteger, getAsInteger, getAsIsoDateTime, getAsLong, getAsLong, getAsMsDuration, getAsRequiredBoolean, getAsRequiredDouble, getAsRequiredInteger, getAsRequiredIsoDateTime, getAsRequiredLong, getAsRequiredObject, getAsRequiredObjectOfClass, getAsRequiredSettingsList, getAsRequiredSettingsMap, getAsRequiredString, getAsRequiredTimeValue, getAsRequiredZonedDateTime, getAsSettingsList, getAsSettingsList, getAsSettingsListOrEmpty, getAsSettingsMap, getAsSettingsMap, getAsString, getAsString, getAsTimeValue, getChildName, getCreateMap, getDeepCopy, getMapOrEmpty, getNestedProperty, getNewInstance, getOrCreateNestedSettingsMap, getOriginatorName, getRequiredNestedProperty, getStringOrFail, getStringOrFail, getTimeValueMs, newSettingsMapChild, overrideWith, putUsingDottedPath, putUsingSlashPath, removeUsingDottedPath, removeUsingSlashPath, setJsonDecoding, setNestedProperty, setPropertyIfMissing

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.thales.punch.platform.api.IEntity

getHash, getRoot, getStructure, getType, isBook, isChannel

Methods inherited from interface org.thales.punch.settings.api.ISettingsMap

asFlatValuesMap, asFlatValuesMap, asFlatValuesMapIgnoreSettingsList, asHjsonString, asJsonString, asJsonString, asKvString, asListFlatValuesMapIgnoreSettingsList, asYamlString, childAsJson, childAsListOfString, childAsMapEntries, childAsMapValues, childAsRawContent, childAsRequiredListOfString, childAsRequiredString, childAsString, childAsStringContent, childAsTarGz, childFileAsMap, childIsDir, childIsFile, getAsBoolean, getAsBoolean, getAsDouble, getAsInteger, getAsInteger, getAsIsoDateTime, getAsLong, getAsLong, getAsMsDuration, getAsRequiredBoolean, getAsRequiredDouble, getAsRequiredInteger, getAsRequiredIsoDateTime, getAsRequiredLong, getAsRequiredObject, getAsRequiredObjectOfClass, getAsRequiredSettingsList, getAsRequiredSettingsMap, getAsRequiredString, getAsRequiredTimeValue, getAsRequiredZonedDateTime, getAsSettingsList, getAsSettingsList, getAsSettingsListOrEmpty, getAsSettingsMap, getAsSettingsMap, getAsString, getAsString, getAsTimeValue, getCreateAsListOfMap, getCreateMap, getDeepCopy, getMapOrEmpty, getNestedProperty, getOrCreateNestedSettingsMap, getOriginatorName, getRequiredNestedProperty, getStringOrFail, getStringOrFail, getTimeValueMs, overrideWith, putUsingDottedPath, putUsingSlashPath, removeUsingDottedPath, removeUsingSlashPath, setNestedProperty, setOriginatorName, setPropertyIfMissing

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

shortName

protected final String shortName

tenant

protected transient TenantImpl tenant

path

protected transient Path path

Constructor Detail

EntityImpl

protected EntityImpl(TenantImpl tenant,
                     String name,
                     ISettingsMap map)

Constructor when called from configuration folder.

Parameters:

tenant - the owning tenant

name - entity name

map - map containing the file names as keys and the file paths as values

Method Detail

getName

public String getName()

Specified by:

getName in interface IEntity

Returns:

the name of this entity

getTenant

public TenantImpl getTenant()

Specified by:

getTenant in interface IEntity

Returns:

this entity tenant

getHash

public String getHash(String folder)

getApplicationsName

public List<String> getApplicationsName()
                                 throws ConfigurationException

Specified by:

getApplicationsName in interface IEntity

Returns:

only the names of the applications.

Throws:

ConfigurationException

getApplications

public Collection<IApplication> getApplications()
                                         throws ConfigurationException

Specified by:

getApplications in interface IEntity

Returns:

the topologies associated to this entity

Throws:

ConfigurationException

getKafkaTopics

public Collection<ITopic> getKafkaTopics()
                                  throws ConfigurationException

Specified by:

getKafkaTopics in interface IEntity

Returns:

the topics associated to this entity

Throws:

ConfigurationException

getApplications

public List<IApplication> getApplications(String namePattern)
                                   throws ConfigurationException

Specified by:

getApplications in interface IEntity

Parameters:

namePattern - the job name pattern (using '*' as wildcard)

Returns:

the corresponding jobs if any

Throws:

ConfigurationException

getApplication

public IApplication getApplication(String name)
                            throws ConfigurationException

Specified by:

getApplication in interface IEntity

Throws:

ConfigurationException

getApplicationsForCluster

public List<IApplication> getApplicationsForCluster(String namePattern,
                                                    String clusterPattern)
                                             throws ConfigurationException

Specified by:

getApplicationsForCluster in interface IEntity

Parameters:

namePattern - either an exact job name or a pattern using '*' as wildcard

clusterPattern - cluster either an exact cluster name or a pattern using '*' as wildcard

Returns:

the list of matching jobs

Throws:

ConfigurationException

getApplicationForCluster

public IApplication getApplicationForCluster(String name,
                                             String cluster)
                                      throws ConfigurationException

Description copied from interface: IEntity

Return the a given application

Specified by:

getApplicationForCluster in interface IEntity

Parameters:

name - the application name

cluster - the associated cluster

Returns:

the found application, null if not there

Throws:

ConfigurationException

getApplicationSize

public int getApplicationSize()
                       throws ConfigurationException

Specified by:

getApplicationSize in interface IEntity

Returns:

the number of configured jobs

Throws:

ConfigurationException

getVersion

public String getVersion()
                  throws ConfigurationException

Specified by:

getVersion in interface IEntity

Returns:

a version string corresponding to the version field.

Throws:

ConfigurationException

getMajorVersion

public int getMajorVersion()
                    throws ConfigurationException

Specified by:

getMajorVersion in interface IEntity

Returns:

the major version

Throws:

ConfigurationException

getMinorVersion

public int getMinorVersion()
                    throws ConfigurationException

Specified by:

getMinorVersion in interface IEntity

Returns:

the minor version

Throws:

ConfigurationException

getPath

public Path getPath()

Specified by:

getPath in interface IEntity

Returns:

the absolute path of this entity.

isStartableByTenant

public boolean isStartableByTenant()
                            throws ConfigurationException

Specified by:

isStartableByTenant in interface IEntity

Returns:

true if it can be started using a per tenant command

Throws:

ConfigurationException

isStoppableByTenant

public boolean isStoppableByTenant()
                            throws ConfigurationException

Specified by:

isStoppableByTenant in interface IEntity

Returns:

true if it can be started using a per tenant command

Throws:

ConfigurationException

getUUID

public String getUUID()

Specified by:

getUUID in interface IEntity

Returns:

the unique id of this book instance.