Package | Description |
---|---|
org.thales.punch.api | |
org.thales.punch.exceptions | |
org.thales.punch.platform.api |
To deal with configuration and administative tasks, the punchplatform relies on a carefully
well designed configuration service.
|
org.thales.punch.platform.api.book | |
org.thales.punch.platform.impl | |
org.thales.punch.platform.utils | |
org.thales.punch.settings.api |
Copyright © 2016-2021 Thales Services Numériques
Licensed under the Thales Inner Source Software License:
Version 1.2, InnerOpen - Distribution Controlled
You may not use this file except in compliance with the License.
|
org.thales.punch.settings.impl |
Modifier and Type | Method and Description |
---|---|
static Artefact |
Artefact.createResource(String r) |
Modifier and Type | Class and Description |
---|---|
class |
EnvironmentConfigurationException
Some value from the environment is invalid.
|
class |
InvalidClusterConfigurationException |
class |
InvalidConfigurationPropertyException
This exception returns a useful and handy error message to immediately inform the
caller about which missing property he deals with.
|
class |
InvalidResolverKeyConfigurationException |
class |
InvalidStructureConfigurationException |
class |
KafkaConfigurationException
Throw this exception whenever an application is submitted with an invalid
configuration.
|
class |
MissingClusterConfigurationException |
class |
MissingPlatformPropertiesConfigurationException
An application or service expect a property from the punchplatform.properties file.
|
class |
MissingStringConfigurationPropertyException
Signal a missing String property.
|
class |
MissingStructureConfigurationException |
class |
PlatformPropertiesConfigurationException
An application or service expect a property from the punchplatform.properties file.
|
Modifier and Type | Method and Description |
---|---|
void |
IApplication.audit()
Audit an application.
|
static ApplicationEnv |
ApplicationEnv.fromMap(ISettingsMap map)
Call ths from your application.
|
static EClusterType |
EClusterType.get(String s) |
static EExitType |
EExitType.get(String s) |
IApplication |
IEntity.getApplication(String name) |
String |
IPunchPlatformProperties.getApplicationControlKafkaClusterBootstrapUrl() |
String |
IPunchPlatformProperties.getApplicationControlKafkaClusterName() |
String |
IPunchPlatformProperties.getApplicationControlTopic() |
IApplication |
IEntity.getApplicationForCluster(String name,
String cluster)
Return the a given application
|
Collection<IApplication> |
IEntity.getApplications() |
List<IApplication> |
IEntity.getApplications(String namePattern) |
List<IApplication> |
IEntity.getApplicationsForCluster(String namePattern,
String clusterPattern) |
int |
IEntity.getApplicationSize() |
List<String> |
IEntity.getApplicationsName() |
String |
IShivaCluster.getAssignementTopic() |
IBook |
ITenant.getBook(String driverName)
Get one of the tenant's channel.
|
IChannel |
ITenant.getChannel(String channelName)
Get one of the tenant's channel.
|
String |
IApplication.getCluster() |
String |
IShivaCluster.getCommandTopic() |
List<IEntity> |
ITenant.getEntities()
Get one of the tenant's channel.
|
ISettingsMap |
IApplication.getExitSettingsOrDefault(ISettingsMap defaultExitCondition)
Applications, as defined in a book structure, can specify an optional
exit settings.
|
String |
IShivaCluster.getFilesystemRoot()
Simple shiva "cluster" can run on one node and rely on the local filesystem.
|
String |
IApplication.getFullName()
This returns something like : "stormshield_networksecurity/main/single_topology".
|
String |
IShivaCluster.getKafkaBoostrapServers() |
String |
IPunchPlatformProperties.getKafkaBootstrapServer(String targetDataKafkaClusterName)
Return a ready to use bootstrap server url for a target kafka cluster
|
String |
ITopic.getKafkaCluster() |
String |
IShivaCluster.getKafkaClusterName() |
Collection<ITopic> |
IEntity.getKafkaTopics() |
int |
IEntity.getMajorVersion() |
int |
IEntity.getMinorVersion() |
Set<String> |
IShivaCluster.getServerNames()
Get the set of Shiva server hostnames
|
IShivaCluster |
IPunchPlatformProperties.getShivaCluster(String shivaClusterName) |
ISettingsMap |
IEntity.getStructure() |
EClusterType |
IApplication.getType() |
String |
IEntity.getVersion() |
Set<String> |
IShivaCluster.getWorkersServerNames()
Get the set of Shiva workers server hostnames
|
boolean |
IShivaCluster.isLocalFileSystemDaemon()
Simple shiva "cluster" can run on one node and rely on the local filesystem.
|
boolean |
IApplication.isShivaApplication() |
boolean |
IApplication.isSparkStreamingApplication() |
boolean |
IEntity.isStartableByTenant() |
boolean |
IEntity.isStoppableByTenant() |
boolean |
IApplication.isStormApplication() |
ISettingsMap |
IResolver.resolve(File file,
String runtime)
Resolve the provided file.
|
ISettingsMap |
IResolver.resolve(ISettingsMap input,
ISettingsMap fileMetaInfo,
String fileName)
Resolve the provided input without matching any rule to only resolve
tags and environment variables.
|
ISettingsMap |
IResolver.resolve(ISettingsMap settings,
String runtime,
String fileName)
Resolve the provided settings map.
|
String |
IPunchPlatformProperties.sparkMaster(String clusterName)
Example of return value:
|
Modifier and Type | Method and Description |
---|---|
void |
IBookActiveReporter.start(IBook book) |
Modifier and Type | Method and Description |
---|---|
void |
StormApplicationImpl.audit() |
void |
ShivaApplicationImpl.audit() |
void |
ApplicationImpl.audit() |
protected void |
ApplicationImpl.auditFile(String path,
boolean isDict)
Audit a settings file.
|
protected void |
ApplicationImpl.auditFileByPrefix(String path,
boolean isDict) |
IApplication |
EntityImpl.getApplication(String name) |
String |
PunchPlatformPropertiesImpl.getApplicationControlKafkaClusterBootstrapUrl() |
String |
PunchPlatformPropertiesImpl.getApplicationControlKafkaClusterName() |
String |
PunchPlatformPropertiesImpl.getApplicationControlTopic() |
IApplication |
EntityImpl.getApplicationForCluster(String name,
String cluster) |
Collection<IApplication> |
EntityImpl.getApplications() |
List<IApplication> |
EntityImpl.getApplications(String namePattern) |
List<IApplication> |
EntityImpl.getApplicationsForCluster(String namePattern,
String clusterPattern) |
int |
EntityImpl.getApplicationSize() |
List<String> |
EntityImpl.getApplicationsName() |
String |
ShivaClusterImpl.getAssignementTopic() |
IBook |
TenantImpl.getBook(String name) |
IChannel |
TenantImpl.getChannel(String channelName) |
String |
ApplicationImpl.getCluster() |
String |
ShivaClusterImpl.getCommandTopic() |
List<IEntity> |
TenantImpl.getEntities() |
ISettingsMap |
ApplicationImpl.getExitSettingsOrDefault(ISettingsMap defaultExitCondition) |
String |
ShivaClusterImpl.getFilesystemRoot() |
String |
ApplicationImpl.getFullName() |
String |
ShivaClusterImpl.getKafkaBoostrapServers() |
String |
PunchPlatformPropertiesImpl.getKafkaBootstrapServer(String clusterName) |
String |
TopicImpl.getKafkaCluster() |
String |
ShivaClusterImpl.getKafkaClusterName() |
Collection<ITopic> |
EntityImpl.getKafkaTopics() |
int |
EntityImpl.getMajorVersion() |
int |
EntityImpl.getMinorVersion() |
Set<String> |
ShivaClusterImpl.getServerNames() |
IShivaCluster |
PunchPlatformPropertiesImpl.getShivaCluster(String shivaClusterName) |
ISettingsMap |
ChannelImpl.getStructure() |
ISettingsMap |
BookImpl.getStructure() |
EClusterType |
ApplicationImpl.getType() |
protected static EClusterType |
ApplicationImpl.getType(ISettingsMap map) |
String |
EntityImpl.getVersion() |
Set<String> |
ShivaClusterImpl.getWorkersServerNames() |
boolean |
ShivaClusterImpl.isLocalFileSystemDaemon() |
boolean |
ApplicationImpl.isShivaApplication() |
boolean |
ApplicationImpl.isSparkStreamingApplication() |
boolean |
EntityImpl.isStartableByTenant() |
boolean |
EntityImpl.isStoppableByTenant() |
boolean |
ApplicationImpl.isStormApplication() |
ISettingsMap |
ResolverImpl.resolve(File file,
String runtime) |
ISettingsMap |
ResolverImpl.resolve(ISettingsMap input,
ISettingsMap fileMetaInfo,
String fileName) |
ISettingsMap |
ResolverImpl.resolve(ISettingsMap input,
String runtime,
String fileName) |
static Object |
ResolverUtil.resolveEnvVar(String[] pathPart)
Resolve an environment variable or a specific key in file pointed by this
variable
|
static ISettingsMap |
ResolverUtil.resolveTagsInMap(ISettingsMap inputMap)
This function resolves tags if given in map input
|
static String |
ResolverUtil.resolveTagsInString(String input)
This function resolvers tags in given string input
|
String |
PunchPlatformPropertiesImpl.sparkMaster(String clusterName) |
Constructor and Description |
---|
BookImpl(TenantImpl tenant,
String name,
ISettingsMap map)
Constructor when called from configuration folder.
|
ChannelImpl(TenantImpl tenant,
String name,
ISettingsMap map)
Constructor when called from configuration folder.
|
ShivaClusterImpl(String shivaClusterName,
IPunchPlatformProperties properties)
Ctor
|
Modifier and Type | Method and Description |
---|---|
static String |
EntityUtils.getEntityFilename(ISettingsMap map,
String shortName)
Return the name with extension of a file, from the given map of short names (possibly prefixes)
|
static ISettingsMap |
EntityUtils.getResolvedMap(String prefix,
String type,
ISettingsMap map,
String entityName,
String tenantName)
Returned the resolved file content as a SettingsMap
|
Modifier and Type | Method and Description |
---|---|
SettingsMapBuilder |
SettingsMapBuilder.fromFile(File file) |
SettingsListBuilder |
SettingsListBuilder.fromFile(File file) |
SettingsMapBuilder |
SettingsMapBuilder.fromFile(Path path)
Return a builder for a yml, yaml json or hjson file.
|
SettingsListBuilder |
SettingsListBuilder.fromFile(Path path) |
SettingsMapBuilder |
SettingsMapBuilder.fromFile(String path)
Return a builder for a simple json or hjson file.
|
String |
ISettingsMap.getStringOrFail(String key)
Return a mandatory string property.
|
String |
ISettingsMap.getStringOrFail(String key,
String defaultValue)
Return a string property or a default value
|
Modifier and Type | Method and Description |
---|---|
String |
SettingsMapImpl.getStringOrFail(String key) |
String |
SettingsMapImpl.getStringOrFail(String key,
String defaultValue) |
Constructor and Description |
---|
FileSystemConfigurationStoreImpl(String root,
String adminTopic)
Ctor
|
Copyright © 2014–2022. All rights reserved.