org.thales.punch.platform.api

Class ApplicationEnv

java.lang.Object

org.thales.punch.platform.api.ApplicationEnv

public class ApplicationEnv
extends Object

An application is one of the many application launched by books or channels. Typically these are punchlines.

Applications are provided with an environment variable that includes their launcher identifier, name and possibly other injected configuration.

This pojo-like class makes it easy to deal with it.

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
ApplicationEnv(String entityName, String entityUUID, String applicationName, String applicationUuid, EExitType exitType, ISettingsMap exitSettings) This constructor sets the essential fields but none of the kafka properties.

Method Summary

Modifier and Type	Method and Description
String	asJsonString()
static ApplicationEnv	fromMap(ISettingsMap map) Call ths from your application.
String	getApplicationControlBootstrapUrl()
String	getApplicationControlTopic()
String	getApplicationName()
String	getApplicationUuid()
String	getEntityName()
String	getEntityUUID()
ISettingsMap	getExitCondition() Type is always present
EExitType	getExitType()
JavaStoreSecurity	getKafkaCredentials()
void	setExitConditions(ISettingsMap spoutExitConditions)
ApplicationEnv	setKafkaProperties(String kafkaTopic, String kafkaBootstratUrl, JavaStoreSecurity kafkaCredentials) Add the optional and mandatory kafka related properties and return a ready to use instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationEnv

public ApplicationEnv(String entityName,
                      String entityUUID,
                      String applicationName,
                      String applicationUuid,
                      EExitType exitType,
                      ISettingsMap exitSettings)

This constructor sets the essential fields but none of the kafka properties. As such you cannot use it.

This constructor is used by the book at startup to create the first application environment. Applications go through the fromMap method.

Parameters:

entityName - your entity (typically book or channel) name

entityUUID - the unique id of your entity

applicationName - the application name, only useful for info and debug

exitType - one o f the supported exit type

applicationUuid - the application unique id.

Method Detail

setKafkaProperties

public ApplicationEnv setKafkaProperties(String kafkaTopic,
                                         String kafkaBootstratUrl,
                                         JavaStoreSecurity kafkaCredentials)

Add the optional and mandatory kafka related properties and return a ready to use instance.

Parameters:

kafkaTopic -

kafkaBootstratUrl -

kafkaTrustoreLocation -

kafkaTrustorePassword -

Returns:

this instance

asJsonString

public String asJsonString()

fromMap

public static ApplicationEnv fromMap(ISettingsMap map)
                              throws ConfigurationException

Call ths from your application.

Parameters:

map - a settings map

Returns:

an ApplicationEnv instance

Throws:

ConfigurationException

an - exception if some of the field is missing.

getEntityName

public String getEntityName()

getEntityUUID

public String getEntityUUID()

getApplicationUuid

public String getApplicationUuid()

getApplicationName

public String getApplicationName()

getExitCondition

public ISettingsMap getExitCondition()

Type is always present

condition is an optional key

 
      exit:
      {
        type: default
        condition: {
          failure:
          {
            acks_greater_or_equal_to: 0
            inactive_for_more_than: 5s
          }
          success:
          {
            fails_greater_or_equal_to: 0
          }
        }
      }
 
 

Returns:

getExitType

public EExitType getExitType()

getApplicationControlTopic

public String getApplicationControlTopic()

getApplicationControlBootstrapUrl

public String getApplicationControlBootstrapUrl()

getKafkaCredentials

public JavaStoreSecurity getKafkaCredentials()

setExitConditions

public void setExitConditions(ISettingsMap spoutExitConditions)