org.thales.punch.platform.api

Interface IEntity

All Superinterfaces:

ISettingsMap, Map<String,Object>

All Known Subinterfaces:

IBook, IChannel

All Known Implementing Classes:

BookImpl, ChannelImpl, EntityImpl

public interface IEntity
extends ISettingsMap

The IEntity interface lets you access a given entity or dag resources. Both are very similar. Hence the name entity.

Author:

dimi

Nested Class Summary

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

Map.Entry<K,V>

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() Compute and return the entity hash based on entity content
Collection<ITopic>	getKafkaTopics()
int	getMajorVersion()
int	getMinorVersion()
String	getName()
Path	getPath()
String	getRoot()
ISettingsMap	getStructure()
ITenant	getTenant()
String	getType()
String	getUUID()
String	getVersion()
default boolean	isBook()
default boolean	isChannel()
boolean	isStartableByTenant()
boolean	isStoppableByTenant()

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

Method Detail

isBook

default boolean isBook()

Returns:

true if this entity is a book

isChannel

default boolean isChannel()

Returns:

true if this entity is a channel

getName

String getName()

Returns:

the name of this entity

getTenant

ITenant getTenant()

Returns:

this entity tenant

getHash

String getHash()

Compute and return the entity hash based on entity content

Returns:

the hash

getStructure

ISettingsMap getStructure()
                   throws ConfigurationException

Returns:

entity or service structure settings

Throws:

ConfigurationException

getApplications

Collection<IApplication> getApplications()
                                  throws ConfigurationException

Returns:

the topologies associated to this entity

Throws:

ConfigurationException

getApplications

List<IApplication> getApplications(String namePattern)
                            throws ConfigurationException

Parameters:

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

Returns:

the corresponding jobs if any

Throws:

ConfigurationException

getApplicationForCluster

IApplication getApplicationForCluster(String name,
                                      String cluster)
                               throws ConfigurationException

Return the a given application

Parameters:

name - the application name

cluster - the associated cluster

Returns:

the found application, null if not there

Throws:

ConfigurationException

getApplicationsForCluster

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

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

getKafkaTopics

Collection<ITopic> getKafkaTopics()
                           throws ConfigurationException

Returns:

the topics associated to this entity

Throws:

ConfigurationException

getApplicationSize

int getApplicationSize()
                throws ConfigurationException

Returns:

the number of configured jobs

Throws:

ConfigurationException

getVersion

String getVersion()
           throws ConfigurationException

Returns:

a version string corresponding to the version field.

Throws:

ConfigurationException

getMajorVersion

int getMajorVersion()
             throws ConfigurationException

Returns:

the major version

Throws:

ConfigurationException

getMinorVersion

int getMinorVersion()
             throws ConfigurationException

Returns:

the minor version

Throws:

ConfigurationException

getPath

Path getPath()

Returns:

the absolute path of this entity.

isStartableByTenant

boolean isStartableByTenant()
                     throws ConfigurationException

Returns:

true if it can be started using a per tenant command

Throws:

ConfigurationException

isStoppableByTenant

boolean isStoppableByTenant()
                     throws ConfigurationException

Returns:

true if it can be started using a per tenant command

Throws:

ConfigurationException

getType

String getType()

Returns:

"channel" or "book"

getRoot

String getRoot()

Returns:

"channels" or "books"

getUUID

String getUUID()

Returns:

the unique id of this book instance.

getApplicationsName

List<String> getApplicationsName()
                          throws ConfigurationException

Returns:

only the names of the applications.

Throws:

ConfigurationException

getApplication

IApplication getApplication(String name)
                     throws ConfigurationException

Throws:

ConfigurationException