PunchPlatformPropertiesImpl (Punch Common Core Library 6.4.5-SNAPSHOT API)

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.PunchPlatformPropertiesImpl

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>, IPunchPlatformProperties, ISettingsMap
```
public class PunchPlatformPropertiesImpl
extends JsonSettingsMapImpl
implements IPunchPlatformProperties
```
Implementation of PunchPlatformPropertiesImpl. NEVER create this by yourself. Always use the PunchEnvironment methods.

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 inherited from class org.thales.punch.settings.impl.SettingsMapImpl
  originatorName

Constructor Summary

Constructors
Constructor and Description
`PunchPlatformPropertiesImpl()` Use this constructor when using punch apps outside a 6.x platform.
`PunchPlatformPropertiesImpl(byte[] jsonContent)` Deprecated. do not use it because there is no resolving
`PunchPlatformPropertiesImpl(String propertiesFile)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ISettingsMap`	`asSettingsMap()`
`boolean`	`clusterExists(EClusterType type, String cluster)`
`String`	`getApplicationControlKafkaClusterBootstrapUrl()`
`String`	`getApplicationControlKafkaClusterName()`
`String`	`getApplicationControlTopic()`
`Object`	`getAsRequiredObjectOfClass(String key, Class<? extends Object> expectedClass)`
`org.apache.http.HttpHost[]`	`getCephAdminApiHosts(String clusterName)`
`Set<String>`	`getCephClusterNames()`
`Set<String>`	`getClickhouseClusterNames()`
`ISettingsMap`	`getCreateCephCluster(String cluster)`
`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 clusterName)` 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> reporterIds)`
`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 stormClusterName)`
`List<String>`	`getStormSupervisors(String stormClusterName)`
`org.apache.http.HttpHost[]`	`getStormUAdminUrl(String stormClusterName)`
`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 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, 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.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, 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

- Constructor Detail
  - PunchPlatformPropertiesImpl
```
public PunchPlatformPropertiesImpl()
```
    Use this constructor when using punch apps outside a 6.x platform.
  - PunchPlatformPropertiesImpl
```
public PunchPlatformPropertiesImpl(String propertiesFile)
```
    Constructor. This load the content of a punchplatform.properties from a user and apply resolution of tags defined location
    
    Parameters:
    
    propertiesFile - the path to the punchplatform
    
    Throws:
    
    IOException
  - PunchPlatformPropertiesImpl
```
public PunchPlatformPropertiesImpl(byte[] jsonContent)
```
    Deprecated. do not use it because there is no resolving
    
    Parameters:
    
    jsonContent - - json version of a punchplatform properties content
- Method Detail
  - asSettingsMap
```
public ISettingsMap asSettingsMap()
```
    Specified by:
    
    asSettingsMap in interface IPunchPlatformProperties
    
    Returns:
    
    the properties as a plain settings map
  - getZkConnectionString
```
public String getZkConnectionString(String zkClusterKey)
```
    Description copied from interface: IPunchPlatformProperties
    
    Retrieve the zookeeper connection string of a given zookeeper cluster
    
    Specified by:
    
    getZkConnectionString in interface IPunchPlatformProperties
    
    Parameters:
    
    zkClusterKey - the zookeeper cluster key.
    
    Returns:
    
    something like "hots1:2181,ip2:2181,ip3:2181/your-root"
  - getStormClusterNames
```
public Set<String> getStormClusterNames()
```
    Specified by:
    
    getStormClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of storm cluster names
  - getCreateStormCluster
```
public ISettingsMap getCreateStormCluster(String cluster)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the Storm settings map for this cluster
    
    Specified by:
    
    getCreateStormCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    cluster - the Storm cluster name
    
    Returns:
    
    the Storm cluster settings map
  - getSparkClusterNames
```
public Set<String> getSparkClusterNames()
```
    Specified by:
    
    getSparkClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the declared spark clusters names
  - getStormUAdminUrl
```
public org.apache.http.HttpHost[] getStormUAdminUrl(String stormClusterName)
```
    Specified by:
    
    getStormUAdminUrl in interface IPunchPlatformProperties
    
    Parameters:
    
    stormClusterName - the name of a storm cluster
    
    Returns:
    
    the associated storm ui address
  - getStormNimbusNodes
```
public List<String> getStormNimbusNodes(String stormClusterName)
```
    Specified by:
    
    getStormNimbusNodes in interface IPunchPlatformProperties
    
    Parameters:
    
    stormClusterName - the name of a storm cluster
    
    Returns:
    
    the list of nimbus node names
  - getStormNimbusPort
```
public int getStormNimbusPort(String stormClusterName)
```
    Specified by:
    
    getStormNimbusPort in interface IPunchPlatformProperties
  - getStormSupervisors
```
public List<String> getStormSupervisors(String stormClusterName)
```
    Specified by:
    
    getStormSupervisors in interface IPunchPlatformProperties
    
    Parameters:
    
    stormClusterName - the name of a storm cluster
    
    Returns:
    
    the list of supervisors hostnames in this cluster
  - getElasticsearchHttpHosts
```
public org.apache.http.HttpHost[] getElasticsearchHttpHosts(String clusterName,
                                                            boolean ssl)
```
    Specified by:
    
    getElasticsearchHttpHosts in interface IPunchPlatformProperties
    
    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
```
public org.apache.http.HttpHost[] getElasticsearchHttpHostsForMonitoring(String clusterName,
                                                                         boolean ssl)
```
    Specified by:
    
    getElasticsearchHttpHostsForMonitoring in interface IPunchPlatformProperties
    
    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
  - getSparkHttpHosts
```
public org.apache.http.HttpHost[] getSparkHttpHosts(String clusterName)
```
    Specified by:
    
    getSparkHttpHosts in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the name of an spark cluster
    
    Returns:
    
    the list of http host you likely use as master urls
  - getSparkInstallDir
```
public String getSparkInstallDir()
```
    Specified by:
    
    getSparkInstallDir in interface IPunchPlatformProperties
    
    Returns:
    
    the spark installation directory
  - getCreateSparkCluster
```
public ISettingsMap getCreateSparkCluster(String clusterName)
```
    Specified by:
    
    getCreateSparkCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the name of an spark cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getZkConnectionStringForKafkaCluster
```
public String getZkConnectionStringForKafkaCluster(String kafkaClusterName)
```
    Specified by:
    
    getZkConnectionStringForKafkaCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    kafkaClusterName - the target kafka cluster name
    
    Returns:
    
    the associated zookeeper connection url
  - getElasticsearchClusterNames
```
public List<String> getElasticsearchClusterNames()
```
    Specified by:
    
    getElasticsearchClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of all Elasticsearch cluster names of the platform configuration
  - getCreateElasticsearchCluster
```
public ISettingsMap getCreateElasticsearchCluster(String esCluster)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the Elasticsearch settings map from its cluster name
    
    Specified by:
    
    getCreateElasticsearchCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    esCluster - the Elasticsearch cluster name
    
    Returns:
    
    the Elasticsearch settings map
  - getKafkaCluster
```
public IKafkaCluster getKafkaCluster(String clusterName)
```
    Specified by:
    
    getKafkaCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - as appearing in the list of keys in the 'kafka.clusters' platform setting
    
    Returns:
    
    the settings of the required Kafka cluster
  - getKafkaClusters
```
public List<IKafkaCluster> getKafkaClusters()
```
    Specified by:
    
    getKafkaClusters in interface IPunchPlatformProperties
    
    Returns:
    
    the list of all declared kafka clusters
  - getKafkaClusterNames
```
public Set<String> getKafkaClusterNames()
```
    Specified by:
    
    getKafkaClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the name of all declared Kafka clusters
  - getCreateKafkaCluster
```
public ISettingsMap getCreateKafkaCluster(String cluster)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the Kafka settings map for this cluster
    
    Specified by:
    
    getCreateKafkaCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    cluster - the Kafka cluster name
    
    Returns:
    
    the Kafka cluster settings map
  - getPlatformEsCluster
```
public org.apache.http.HttpHost[] getPlatformEsCluster()
```
    Specified by:
    
    getPlatformEsCluster in interface IPunchPlatformProperties
    
    Returns:
    
    the address of the elasticsearch identified as the monitoring elasticsearch for the platform level.
  - getPlatformEsIndexPrefix
```
public String getPlatformEsIndexPrefix()
```
    Specified by:
    
    getPlatformEsIndexPrefix in interface IPunchPlatformProperties
    
    Returns:
    
    the index prefix to be used to write platform level documents
  - getPlatformId
```
public String getPlatformId()
```
    Specified by:
    
    getPlatformId in interface IPunchPlatformProperties
    
    Returns:
    
    the unique platform identifier of this platform
  - getReporters
```
public List<ISettingsMap> getReporters(List<String> reporterIds)
```
    Specified by:
    
    getReporters in interface IPunchPlatformProperties
    
    Returns:
    
    a list of platform reporters
  - getZookeeperClusters
```
public List<IZookeeperCluster> getZookeeperClusters()
```
    Specified by:
    
    getZookeeperClusters in interface IPunchPlatformProperties
    
    Returns:
    
    the list of all declared zookeeper clusters
  - getZookeeperClusterNames
```
public Set<String> getZookeeperClusterNames()
```
    Specified by:
    
    getZookeeperClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of all Zookeeper cluster names of the platform configuration
  - getZookeeperCluster
```
public IZookeeperCluster getZookeeperCluster(String zkClusterName)
```
    Specified by:
    
    getZookeeperCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    zkClusterName - as appearing in the list of keys in the 'zookeeper.clusters' platform setting
    
    Returns:
    
    the settings of the required Zookeeper cluster
  - getCreateZookeeperCluster
```
public ISettingsMap getCreateZookeeperCluster(String zkCluster)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the Zookeeper settings map for this cluster
    
    Specified by:
    
    getCreateZookeeperCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    zkCluster - the Zookeeper cluster name
    
    Returns:
    
    the Zookeeper settings map
  - getShivaClusters
```
public List<IShivaCluster> getShivaClusters()
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the list of Shiva clusters
    
    Specified by:
    
    getShivaClusters in interface IPunchPlatformProperties
    
    Returns:
    
    the list of Shiva clusters
  - getShivaClusterNames
```
public Set<String> getShivaClusterNames()
```
    Specified by:
    
    getShivaClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the name of all declared Shiva clusters
  - getCreateShivaCluster
```
public ISettingsMap getCreateShivaCluster(String cluster)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the Shiva settings map for this cluster
    
    Specified by:
    
    getCreateShivaCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    cluster - the Shiva cluster name
    
    Returns:
    
    the Shiva cluster settings map
  - getShivaCluster
```
public IShivaCluster getShivaCluster(String shivaClusterName)
                              throws ConfigurationException
```
    Specified by:
    
    getShivaCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    shivaClusterName - the target shiva cluster name
    
    Returns:
    
    the corresponding shiva cluster settings
    
    Throws:
    
    ConfigurationException
  - getGatewayConfiguration
```
public ISettingsMap getGatewayConfiguration()
```
    Description copied from interface: IPunchPlatformProperties
    
    Load gateway configuration
    
    Specified by:
    
    getGatewayConfiguration in interface IPunchPlatformProperties
    
    Returns:
    
    the map of the gateway configuration
  - getOrCreate
```
public ISettingsMap getOrCreate(String... tree)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get a properties and creates it if necessary. For not already existing one, an empty map is returned.
    
    Specified by:
    
    getOrCreate in interface IPunchPlatformProperties
    
    Parameters:
    
    tree - the list of map nodes
    
    Returns:
    
    the existing map or an empty new one
  - getCephAdminApiHosts
```
public org.apache.http.HttpHost[] getCephAdminApiHosts(String clusterName)
```
    Specified by:
    
    getCephAdminApiHosts in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the name of an Ceph cluster
    
    Returns:
    
    the list of http host that provide the Ceph admin REST api service
  - getCephClusterNames
```
public Set<String> getCephClusterNames()
```
    Specified by:
    
    getCephClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of all Ceph cluster names of the platform configuration
  - getCreateCephCluster
```
public ISettingsMap getCreateCephCluster(String cluster)
```
    Specified by:
    
    getCreateCephCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    cluster - the name of a Ceph cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getKafkaBootstrapServer
```
public String getKafkaBootstrapServer(String clusterName)
                               throws ConfigurationException
```
    Description copied from interface: IPunchPlatformProperties
    
    Return a ready to use bootstrap server url for a target kafka cluster
    
    Specified by:
    
    getKafkaBootstrapServer in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the target kafka cluster name
    
    Returns:
    
    the corresponding bootstrap url
    
    Throws:
    
    ConfigurationException
  - getCreateKubernetesCluster
```
public ISettingsMap getCreateKubernetesCluster(String cluster)
```
    Description copied from interface: IPunchPlatformProperties
    
    Get the Kubernetes settings map for this cluster
    
    Specified by:
    
    getCreateKubernetesCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    cluster - the Kubernetes cluster name
    
    Returns:
    
    the Kubernetes cluster settings map
  - getPlanSchedulerInstallDir
```
public String getPlanSchedulerInstallDir()
```
    Description copied from interface: IPunchPlatformProperties
    
    Full path of punchplatform plan scheduler
    
    Specified by:
    
    getPlanSchedulerInstallDir in interface IPunchPlatformProperties
    
    Returns:
    
    as string the install dir of punchplatform plan scheduler
  - getMinioClusterNames
```
public Set<String> getMinioClusterNames()
```
    Specified by:
    
    getMinioClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of minio cluster names
  - getCreateMinioCluster
```
public ISettingsMap getCreateMinioCluster(String clusterName)
```
    Specified by:
    
    getCreateMinioCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the name of a minio cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getClickhouseClusterNames
```
public Set<String> getClickhouseClusterNames()
```
    Specified by:
    
    getClickhouseClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of Clickhouse cluster names
  - getCreateClickhouseCluster
```
public ISettingsMap getCreateClickhouseCluster(String clusterName)
```
    Specified by:
    
    getCreateClickhouseCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the name of a Clickhouse cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getGatewayClusterNames
```
public Set<String> getGatewayClusterNames()
```
    Specified by:
    
    getGatewayClusterNames in interface IPunchPlatformProperties
    
    Returns:
    
    the list of Gateway cluster names
  - getCreateGatewayCluster
```
public ISettingsMap getCreateGatewayCluster(String clusterName)
```
    Specified by:
    
    getCreateGatewayCluster in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - the name of a Gateway cluster
    
    Returns:
    
    the SettingsMap of cluster params
  - getApplicationControlTopic
```
public String getApplicationControlTopic()
                                  throws ConfigurationException
```
    Specified by:
    
    getApplicationControlTopic in interface IPunchPlatformProperties
    
    Returns:
    
    the topic used for controlling dag application
    
    Throws:
    
    ConfigurationException
  - getApplicationControlKafkaClusterName
```
public String getApplicationControlKafkaClusterName()
                                             throws ConfigurationException
```
    Specified by:
    
    getApplicationControlKafkaClusterName in interface IPunchPlatformProperties
    
    Returns:
    
    the kafka cluster name used to hold the dag control topic
    
    Throws:
    
    ConfigurationException
  - getApplicationControlKafkaClusterBootstrapUrl
```
public String getApplicationControlKafkaClusterBootstrapUrl()
                                                     throws ConfigurationException
```
    Specified by:
    
    getApplicationControlKafkaClusterBootstrapUrl in interface IPunchPlatformProperties
    
    Returns:
    
    the kafka cluster bootstrap urls used to hold the dag control topic.
    
    Throws:
    
    ConfigurationException
  - getResourceManagerConfiguration
```
public ISettingsMap getResourceManagerConfiguration()
```
    Specified by:
    
    getResourceManagerConfiguration in interface IPunchPlatformProperties
    
    Returns:
    
    the resource manager configuration
  - getSecuritySectionForCommands
```
public SecurityImpl getSecuritySectionForCommands()
```
    Specified by:
    
    getSecuritySectionForCommands in interface IPunchPlatformProperties
    
    Returns:
    
    All credentials for punch commands
  - getAsRequiredObjectOfClass
```
public Object getAsRequiredObjectOfClass(String key,
                                         Class<? extends Object> expectedClass)
```
    Specified by:
    
    getAsRequiredObjectOfClass in interface ISettingsMap
    
    Overrides:
    
    getAsRequiredObjectOfClass in class SettingsMapImpl
    
    Parameters:
    
    key - the property key to retrieve
    
    expectedClass - the class of which the property must be checked an instance of
    
    Returns:
    
    fetched value, guaranteed an extension of expectedClass
  - clusterExists
```
public boolean clusterExists(EClusterType type,
                             String cluster)
```
    Specified by:
    
    clusterExists in interface IPunchPlatformProperties
    
    Parameters:
    
    type - a cluster type
    
    cluster - a cluster name
    
    Returns:
    
    true if a cluster of the given type exists.
  - sparkMaster
```
public String sparkMaster(String clusterName)
                   throws ConfigurationException
```
    Description copied from interface: IPunchPlatformProperties
    Example of return value:
```
 
 - spark://localhost:7077
 - spark://server1:7077,server1:7077
 
 
```
    Specified by:
    
    sparkMaster in interface IPunchPlatformProperties
    
    Parameters:
    
    clusterName - specified in your punchplatform properties
    
    Returns:
    
    a valid spark URL to pass for submitting job to spark master
    
    Throws:
    
    ConfigurationException

Class PunchPlatformPropertiesImpl

Nested Class Summary

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

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

Constructor Detail

PunchPlatformPropertiesImpl

PunchPlatformPropertiesImpl

PunchPlatformPropertiesImpl

Method Detail

asSettingsMap

getZkConnectionString

getStormClusterNames

getCreateStormCluster

getSparkClusterNames

getStormUAdminUrl

getStormNimbusNodes

getStormNimbusPort

getStormSupervisors

getElasticsearchHttpHosts

getElasticsearchHttpHostsForMonitoring

getSparkHttpHosts

getSparkInstallDir

getCreateSparkCluster

getZkConnectionStringForKafkaCluster

getElasticsearchClusterNames

getCreateElasticsearchCluster

getKafkaCluster

getKafkaClusters

getKafkaClusterNames

getCreateKafkaCluster

getPlatformEsCluster

getPlatformEsIndexPrefix

getPlatformId

getReporters

getZookeeperClusters

getZookeeperClusterNames

getZookeeperCluster

getCreateZookeeperCluster

getShivaClusters

getShivaClusterNames

getCreateShivaCluster

getShivaCluster

getGatewayConfiguration

getOrCreate

getCephAdminApiHosts

getCephClusterNames

getCreateCephCluster

getKafkaBootstrapServer

getCreateKubernetesCluster

getPlanSchedulerInstallDir

getMinioClusterNames

getCreateMinioCluster

getClickhouseClusterNames

getCreateClickhouseCluster

getGatewayClusterNames

getCreateGatewayCluster

getApplicationControlTopic

getApplicationControlKafkaClusterName

getApplicationControlKafkaClusterBootstrapUrl

getResourceManagerConfiguration

getSecuritySectionForCommands

getAsRequiredObjectOfClass

clusterExists

sparkMaster