IPunchPlatformProperties (Punch Common Core Library 6.4.4 API)

All Superinterfaces:: ISettingsMap, Map<String,Object>

All Known Implementing Classes:: PunchPlatformPropertiesImpl

public interface IPunchPlatformProperties
extends ISettingsMap

The PunchPlatformProperties represents your platform punchplatform.properties file. Once loaded you can access properties using either the plain SettingsMap api, or the higher level settings map api.

Say your punchplatform.properties contains :


   "zookeeper" : {
        "clusters" : {
                "common" : {
                        "hosts" : ["localhost"],
                        "cluster_port" : 2181
                }
        }
   }

To retrieve that file content, and extract some properties, do as follows:


        import org.punch.platform.env.IKeys.*;
        ...
        IPlatform platform = PlatformProvider.getPlatform();
        IPunchPlatformProperties properties = platform.getPlatformProperties();
        PunchPlatformProperties properties = PunchEnvironment.getPunchPlatformProperties();
        int clusterPort = properties
        .childAsMap(ZOOKEEPER)
        .childAsMap(CLUSTERS)
        .childAsMap(COMMON)
        .getAsRequiredInteger(CLUSTER_PORT);

Besides giving you access to the properties, this class also defines all the key names you can rely on.

In addition, you are provided with a few specific helper access method. Checkout out the doc below.

Author:: dimi

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ISettingsMap`	`asSettingsMap()`
`boolean`	`clusterExists(EClusterType eClusterType, String name)`
`String`	`getApplicationControlKafkaClusterBootstrapUrl()`
`String`	`getApplicationControlKafkaClusterName()`
`String`	`getApplicationControlTopic()`
`org.apache.http.HttpHost[]`	`getCephAdminApiHosts(String clusterName)`
`Set<String>`	`getCephClusterNames()`
`Set<String>`	`getClickhouseClusterNames()`
`ISettingsMap`	`getCreateCephCluster(String clusterName)`
`ISettingsMap`	`getCreateClickhouseCluster(String clusterName)`
`ISettingsMap`	`getCreateElasticsearchCluster(String esCluster)` Get the Elasticsearch settings map from its cluster name
`ISettingsMap`	`getCreateGatewayCluster(String clusterName)`
`ISettingsMap`	`getCreateKafkaCluster(String cluster)` Get the Kafka settings map for this cluster
`ISettingsMap`	`getCreateKubernetesCluster(String cluster)` Get the Kubernetes settings map for this cluster
`ISettingsMap`	`getCreateMinioCluster(String clusterName)`
`ISettingsMap`	`getCreateShivaCluster(String cluster)` Get the Shiva settings map for this cluster
`ISettingsMap`	`getCreateSparkCluster(String clusterName)`
`ISettingsMap`	`getCreateStormCluster(String cluster)` Get the Storm settings map for this cluster
`ISettingsMap`	`getCreateZookeeperCluster(String zkCluster)` Get the Zookeeper settings map for this cluster
`List<String>`	`getElasticsearchClusterNames()`
`org.apache.http.HttpHost[]`	`getElasticsearchHttpHosts(String clusterName, boolean ssl)`
`org.apache.http.HttpHost[]`	`getElasticsearchHttpHostsForMonitoring(String clusterName, boolean ssl)`
`Set<String>`	`getGatewayClusterNames()`
`ISettingsMap`	`getGatewayConfiguration()` Load gateway configuration
`String`	`getKafkaBootstrapServer(String targetDataKafkaClusterName)` Return a ready to use bootstrap server url for a target kafka cluster
`IKafkaCluster`	`getKafkaCluster(String clusterName)`
`Set<String>`	`getKafkaClusterNames()`
`List<IKafkaCluster>`	`getKafkaClusters()`
`Set<String>`	`getMinioClusterNames()`
`ISettingsMap`	`getOrCreate(String... tree)` Get a properties and creates it if necessary.
`String`	`getPlanSchedulerInstallDir()` Full path of punchplatform plan scheduler
`org.apache.http.HttpHost[]`	`getPlatformEsCluster()`
`String`	`getPlatformEsIndexPrefix()`
`String`	`getPlatformId()`
`List<ISettingsMap>`	`getReporters(List<String> reporterId)`
`ISettingsMap`	`getResourceManagerConfiguration()`
`SecurityImpl`	`getSecuritySectionForCommands()`
`IShivaCluster`	`getShivaCluster(String shivaClusterName)`
`Set<String>`	`getShivaClusterNames()`
`List<IShivaCluster>`	`getShivaClusters()` Get the list of Shiva clusters
`Set<String>`	`getSparkClusterNames()`
`org.apache.http.HttpHost[]`	`getSparkHttpHosts(String clusterName)`
`String`	`getSparkInstallDir()`
`Set<String>`	`getStormClusterNames()`
`List<String>`	`getStormNimbusNodes(String stormClusterName)`
`int`	`getStormNimbusPort(String cluster)`
`List<String>`	`getStormSupervisors(String stormClusterName)`
`org.apache.http.HttpHost[]`	`getStormUAdminUrl(String name)`
`String`	`getZkConnectionString(String zkClusterKey)` Retrieve the zookeeper connection string of a given zookeeper cluster
`String`	`getZkConnectionStringForKafkaCluster(String kafkaClusterName)`
`IZookeeperCluster`	`getZookeeperCluster(String zkClusterName)`
`Set<String>`	`getZookeeperClusterNames()`
`List<IZookeeperCluster>`	`getZookeeperClusters()`
`String`	`sparkMaster(String clusterName)` Example of return value:

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
  - getPlanSchedulerInstallDir
```
String getPlanSchedulerInstallDir()
```
    Full path of punchplatform plan scheduler
    
    Returns:
    
    as string the install dir of punchplatform plan scheduler
  - getZkConnectionString
```
String getZkConnectionString(String zkClusterKey)
```
    Retrieve the zookeeper connection string of a given zookeeper cluster
    
    Parameters:
    
    zkClusterKey - the zookeeper cluster key.
    
    Returns:
    
    something like "hots1:2181,ip2:2181,ip3:2181/your-root"
  - getStormUAdminUrl
```
org.apache.http.HttpHost[] getStormUAdminUrl(String name)
```
    Parameters:
    
    name - the name of a storm cluster
    
    Returns:
    
    the associated storm ui address
  - getStormClusterNames
```
Set<String> getStormClusterNames()
```
    Returns:
    
    the list of storm cluster names
  - getStormSupervisors
```
List<String> getStormSupervisors(String stormClusterName)
```
    Parameters:
    
    stormClusterName - the name of a storm cluster
    
    Returns:
    
    the list of supervisors hostnames in this cluster
  - getStormNimbusNodes
```
List<String> getStormNimbusNodes(String stormClusterName)
```
    Parameters:
    
    stormClusterName - the name of a storm cluster
    
    Returns:
    
    the list of nimbus node names
  - getElasticsearchHttpHosts
```
org.apache.http.HttpHost[] getElasticsearchHttpHosts(String clusterName,
                                                     boolean ssl)
```
    Parameters:
    
    clusterName - the name of an elasticsearch cluster
    
    ssl - https if true, else http
    
    Returns:
    
    the list of http host you likely need to insert or get data from that cluster
  - getElasticsearchHttpHostsForMonitoring
```
org.apache.http.HttpHost[] getElasticsearchHttpHostsForMonitoring(String clusterName,
                                                                  boolean ssl)
```
    Parameters:
    
    clusterName - the name of an elasticsearch cluster
    
    ssl - set true to use https scheme, false to use http
    
    Returns:
    
    the list of http hosts that can be used for monitoring the clusters (they might not be the same as the addresses for indexing data, because the monitoring is often done from a Shiva node in an admin network, so a list of hosts:port in cluster.hosts_api_for_monitoring["somehost:9200", "otherhost:9200", "vip:9200"]; may override the usual hosts nodes fom cluster.nodes section
  - getElasticsearchClusterNames
```
List<String> getElasticsearchClusterNames()
```
    Returns:
    
    the list of all Elasticsearch cluster names of the platform configuration
  - getSparkHttpHosts
```
org.apache.http.HttpHost[] getSparkHttpHosts(String clusterName)
```
    Parameters:
    
    clusterName - the name of an spark cluster
    
    Returns:
    
    the list of http host you likely use as master urls
  - getSparkClusterNames
```
Set<String> getSparkClusterNames()
```
    Returns:
    
    the declared spark clusters names
  - getSparkInstallDir
```
String getSparkInstallDir()
```
    Returns:
    
    the spark installation directory
  - getCreateSparkCluster
```
ISettingsMap getCreateSparkCluster(String clusterName)
```
    Parameters:
    
    clusterName - the name of an spark cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getZkConnectionStringForKafkaCluster
```
String getZkConnectionStringForKafkaCluster(String kafkaClusterName)
```
    Parameters:
    
    kafkaClusterName - the target kafka cluster name
    
    Returns:
    
    the associated zookeeper connection url
  - getKafkaCluster
```
IKafkaCluster getKafkaCluster(String clusterName)
```
    Parameters:
    
    clusterName - as appearing in the list of keys in the 'kafka.clusters' platform setting
    
    Returns:
    
    the settings of the required Kafka cluster
    
    Throws:
    
    IllegalArgumentException - if no cluster with provided section name can be found in the platform settings
  - getZookeeperCluster
```
IZookeeperCluster getZookeeperCluster(String zkClusterName)
```
    Parameters:
    
    zkClusterName - as appearing in the list of keys in the 'zookeeper.clusters' platform setting
    
    Returns:
    
    the settings of the required Zookeeper cluster
    
    Throws:
    
    IllegalArgumentException - if no cluster with provided section name can be found in the platform settings
  - getShivaClusters
```
List<IShivaCluster> getShivaClusters()
```
    Get the list of Shiva clusters
    
    Returns:
    
    the list of Shiva clusters
  - getShivaCluster
```
IShivaCluster getShivaCluster(String shivaClusterName)
                       throws ConfigurationException
```
    Parameters:
    
    shivaClusterName - the target shiva cluster name
    
    Returns:
    
    the corresponding shiva cluster settings
    
    Throws:
    
    MissingPlatformPropertiesConfigurationException
    
    PlatformPropertiesConfigurationException
    
    ConfigurationException
  - getShivaClusterNames
```
Set<String> getShivaClusterNames()
```
    Returns:
    
    the name of all declared Shiva clusters
  - getGatewayConfiguration
```
ISettingsMap getGatewayConfiguration()
```
    Load gateway configuration
    
    Returns:
    
    the map of the gateway configuration
  - getKafkaClusters
```
List<IKafkaCluster> getKafkaClusters()
```
    Returns:
    
    the list of all declared kafka clusters
  - getKafkaClusterNames
```
Set<String> getKafkaClusterNames()
```
    Returns:
    
    the name of all declared Kafka clusters
  - getZookeeperClusters
```
List<IZookeeperCluster> getZookeeperClusters()
```
    Returns:
    
    the list of all declared zookeeper clusters
  - getZookeeperClusterNames
```
Set<String> getZookeeperClusterNames()
```
    Returns:
    
    the list of all Zookeeper cluster names of the platform configuration
  - getPlatformEsCluster
```
org.apache.http.HttpHost[] getPlatformEsCluster()
```
    Returns:
    
    the address of the elasticsearch identified as the monitoring elasticsearch for the platform level.
  - getPlatformEsIndexPrefix
```
String getPlatformEsIndexPrefix()
```
    Returns:
    
    the index prefix to be used to write platform level documents
  - getPlatformId
```
String getPlatformId()
```
    Returns:
    
    the unique platform identifier of this platform
  - getApplicationControlTopic
```
String getApplicationControlTopic()
                           throws ConfigurationException
```
    Returns:
    
    the topic used for controlling dag application
    
    Throws:
    
    MissingKafkaTopicConfigurationException
    
    ConfigurationException
  - getApplicationControlKafkaClusterName
```
String getApplicationControlKafkaClusterName()
                                      throws ConfigurationException
```
    Returns:
    
    the kafka cluster name used to hold the dag control topic
    
    Throws:
    
    MissingKafkaClusterConfigurationException
    
    ConfigurationException
  - getApplicationControlKafkaClusterBootstrapUrl
```
String getApplicationControlKafkaClusterBootstrapUrl()
                                              throws ConfigurationException
```
    Returns:
    
    the kafka cluster bootstrap urls used to hold the dag control topic.
    
    Throws:
    
    ConfigurationException
  - getResourceManagerConfiguration
```
ISettingsMap getResourceManagerConfiguration()
```
    Returns:
    
    the resource manager configuration
  - getReporters
```
List<ISettingsMap> getReporters(List<String> reporterId)
```
    Returns:
    
    a list of platform reporters
  - getCreateElasticsearchCluster
```
ISettingsMap getCreateElasticsearchCluster(String esCluster)
```
    Get the Elasticsearch settings map from its cluster name
    
    Parameters:
    
    esCluster - the Elasticsearch cluster name
    
    Returns:
    
    the Elasticsearch settings map
  - getCreateZookeeperCluster
```
ISettingsMap getCreateZookeeperCluster(String zkCluster)
```
    Get the Zookeeper settings map for this cluster
    
    Parameters:
    
    zkCluster - the Zookeeper cluster name
    
    Returns:
    
    the Zookeeper settings map
  - getCreateStormCluster
```
ISettingsMap getCreateStormCluster(String cluster)
```
    Get the Storm settings map for this cluster
    
    Parameters:
    
    cluster - the Storm cluster name
    
    Returns:
    
    the Storm cluster settings map
  - getCreateKafkaCluster
```
ISettingsMap getCreateKafkaCluster(String cluster)
```
    Get the Kafka settings map for this cluster
    
    Parameters:
    
    cluster - the Kafka cluster name
    
    Returns:
    
    the Kafka cluster settings map
  - getCreateKubernetesCluster
```
ISettingsMap getCreateKubernetesCluster(String cluster)
```
    Get the Kubernetes settings map for this cluster
    
    Parameters:
    
    cluster - the Kubernetes cluster name
    
    Returns:
    
    the Kubernetes cluster settings map
  - getCreateShivaCluster
```
ISettingsMap getCreateShivaCluster(String cluster)
```
    Get the Shiva settings map for this cluster
    
    Parameters:
    
    cluster - the Shiva cluster name
    
    Returns:
    
    the Shiva cluster settings map
  - getOrCreate
```
ISettingsMap getOrCreate(String... tree)
```
    Get a properties and creates it if necessary. For not already existing one, an empty map is returned.
    
    Parameters:
    
    tree - the list of map nodes
    
    Returns:
    
    the existing map or an empty new one
  - getCephAdminApiHosts
```
org.apache.http.HttpHost[] getCephAdminApiHosts(String clusterName)
```
    Parameters:
    
    clusterName - the name of an Ceph cluster
    
    Returns:
    
    the list of http host that provide the Ceph admin REST api service
  - getCephClusterNames
```
Set<String> getCephClusterNames()
```
    Returns:
    
    the list of all Ceph cluster names of the platform configuration
  - getCreateCephCluster
```
ISettingsMap getCreateCephCluster(String clusterName)
```
    Parameters:
    
    clusterName - the name of a Ceph cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getKafkaBootstrapServer
```
String getKafkaBootstrapServer(String targetDataKafkaClusterName)
                        throws ConfigurationException
```
    Return a ready to use bootstrap server url for a target kafka cluster
    
    Parameters:
    
    targetDataKafkaClusterName - the target kafka cluster name
    
    Returns:
    
    the corresponding bootstrap url
    
    Throws:
    
    ConfigurationException
  - asSettingsMap
```
ISettingsMap asSettingsMap()
```
    Returns:
    
    the properties as a plain settings map
  - getStormNimbusPort
```
int getStormNimbusPort(String cluster)
```
  - getMinioClusterNames
```
Set<String> getMinioClusterNames()
```
    Returns:
    
    the list of minio cluster names
  - getCreateMinioCluster
```
ISettingsMap getCreateMinioCluster(String clusterName)
```
    Parameters:
    
    clusterName - the name of a minio cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getClickhouseClusterNames
```
Set<String> getClickhouseClusterNames()
```
    Returns:
    
    the list of Clickhouse cluster names
  - getCreateClickhouseCluster
```
ISettingsMap getCreateClickhouseCluster(String clusterName)
```
    Parameters:
    
    clusterName - the name of a Clickhouse cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getGatewayClusterNames
```
Set<String> getGatewayClusterNames()
```
    Returns:
    
    the list of Gateway cluster names
  - getCreateGatewayCluster
```
ISettingsMap getCreateGatewayCluster(String clusterName)
```
    Parameters:
    
    clusterName - the name of a Gateway cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getSecuritySectionForCommands
```
SecurityImpl getSecuritySectionForCommands()
```
    Returns:
    
    All credentials for punch commands
  - sparkMaster
```
String sparkMaster(String clusterName)
            throws ConfigurationException
```
    Example of return value:
```
 
 - spark://localhost:7077
 - spark://server1:7077,server1:7077
 
 
```
    Parameters:
    
    clusterName - specified in your punchplatform properties
    
    Returns:
    
    a valid spark URL to pass for submitting job to spark master
    
    Throws:
    
    ConfigurationException
  - clusterExists
```
boolean clusterExists(EClusterType eClusterType,
                      String name)
```
    Parameters:
    
    eClusterType - a cluster type
    
    name - a cluster name
    
    Returns:
    
    true if a cluster of the given type exists.

Interface IPunchPlatformProperties

Nested Class Summary

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

Method Summary

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

Methods inherited from interface java.util.Map

Method Detail

getPlanSchedulerInstallDir

getZkConnectionString

getStormUAdminUrl

getStormClusterNames

getStormSupervisors

getStormNimbusNodes

getElasticsearchHttpHosts

getElasticsearchHttpHostsForMonitoring

getElasticsearchClusterNames

getSparkHttpHosts

getSparkClusterNames

getSparkInstallDir

getCreateSparkCluster

getZkConnectionStringForKafkaCluster

getKafkaCluster

getZookeeperCluster

getShivaClusters

getShivaCluster

getShivaClusterNames

getGatewayConfiguration

getKafkaClusters

getKafkaClusterNames

getZookeeperClusters

getZookeeperClusterNames

getPlatformEsCluster

getPlatformEsIndexPrefix

getPlatformId

getApplicationControlTopic

getApplicationControlKafkaClusterName

getApplicationControlKafkaClusterBootstrapUrl

getResourceManagerConfiguration

getReporters

getCreateElasticsearchCluster

getCreateZookeeperCluster

getCreateStormCluster

getCreateKafkaCluster

getCreateKubernetesCluster

getCreateShivaCluster

getOrCreate

getCephAdminApiHosts

getCephClusterNames

getCreateCephCluster

getKafkaBootstrapServer

asSettingsMap

getStormNimbusPort

getMinioClusterNames

getCreateMinioCluster

getClickhouseClusterNames

getCreateClickhouseCluster

getGatewayClusterNames

getCreateGatewayCluster

getSecuritySectionForCommands

sparkMaster

clusterExists