ApplicationImpl (Punch Common Core Library 6.4.5 API)

java.lang.Object
- org.thales.punch.platform.impl.ApplicationImpl

All Implemented Interfaces:

IApplication

Direct Known Subclasses:

ShivaApplicationImpl, StormApplicationImpl
```
public class ApplicationImpl
extends Object
implements IApplication
```
IApplication implementation

Author:

dimi

Field Summary

Fields
Modifier and Type Field and Description

protected IEntity entity

protected ISettingsMap map

Fields
Modifier and Type	Field and Description
`protected IEntity`	`entity`
`protected ISettingsMap`	`map`

Constructor Summary

Constructors
Constructor and Description

ApplicationImpl(IEntity entity, ISettingsMap map, String configName)
Create a new application.

Constructors
Constructor and Description
`ApplicationImpl(IEntity entity, ISettingsMap map, String configName)` Create a new application.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`audit()` Audit an application.
`protected void`	`auditFile(String path, boolean isDict)` Audit a settings file.
`protected void`	`auditFileByPrefix(String path, boolean isDict)`
`List<String>`	`getApplyResolverOn()`
`String`	`getCluster()`
`IEntity`	`getEntity()`
`ISettingsMap`	`getEnv()`
`IExitRequest`	`getExitRequest()`
`ISettingsMap`	`getExitSettingsOrDefault(ISettingsMap defaultExitCondition)` Applications, as defined in a book structure, can specify an optional exit settings.
`String`	`getFullName()` This returns something like : "stormshield_networksecurity/main/single_topology".
`List<String>`	`getPredecessors()`
`String`	`getReloadAction()`
`ISettingsMap`	`getSettingsMap()`
`List<String>`	`getShivaArgs()`
`String`	`getShivaCommand()`
`String`	`getShivaCronSchedule()`
`List<String>`	`getShivaResources()`
`List<String>`	`getShivaTags()`
`String`	`getShortName()`
`ITenant`	`getTenant()`
`String`	`getTenantName()`
`EClusterType`	`getType()`
`protected static EClusterType`	`getType(ISettingsMap map)`
`String`	`getUUID()` The unique application identifier is attributed by the owner entity (book or channel).
`String`	`getVersion()`
`boolean`	`isOneShot()`
`boolean`	`isShivaApplication()`
`boolean`	`isSparkStreamingApplication()`
`boolean`	`isStormApplication()`
`IApplication`	`setApplicationUUID(String uuid)` Set the unique identifier to this application.
`IApplication`	`setEnv(String name, String value)` Set an environment variable.
`IApplication`	`setExitRequest(IExitRequest request)` Set an exit wish to this application.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - entity
```
protected IEntity entity
```
  - map
```
protected ISettingsMap map
```
- Constructor Detail
  - ApplicationImpl
```
public ApplicationImpl(IEntity entity,
                       ISettingsMap map,
                       String configName)
```
    Create a new application.
    
    Parameters:
    
    entity - a channel or book
    
    map - a map
    
    configName - the file structure name i.e. tenant/channel/appname. It does not have the cluster in it.
- Method Detail
  - getSettingsMap
```
public ISettingsMap getSettingsMap()
```
    Specified by:
    
    getSettingsMap in interface IApplication
    
    Returns:
    
    this application settings map
  - getEntity
```
public IEntity getEntity()
```
    Specified by:
    
    getEntity in interface IApplication
    
    Returns:
    
    this application channel
  - getShortName
```
public String getShortName()
```
    Specified by:
    
    getShortName in interface IApplication
    
    Returns:
    
    the name of this job. This is the name as defined in the job section.
  - getFullName
```
public String getFullName()
                   throws ConfigurationException
```
    Description copied from interface: IApplication
    
    This returns something like : "stormshield_networksecurity/main/single_topology".
    Watchout this method requires a valid cluster to be configured in your application. A checked exception is thrown if you refer to one not known from your platform properties.
    
    Specified by:
    
    getFullName in interface IApplication
    
    Returns:
    
    a per tenant unique name, useful to be used as a persistent key.
    
    Throws:
    
    ConfigurationException
  - getTenant
```
public ITenant getTenant()
```
    Specified by:
    
    getTenant in interface IApplication
    
    Returns:
    
    this application tenant
  - getTenantName
```
public String getTenantName()
```
    Specified by:
    
    getTenantName in interface IApplication
    
    Returns:
    
    the owning tenant name
  - getType
```
public EClusterType getType()
                     throws ConfigurationException
```
    Specified by:
    
    getType in interface IApplication
    
    Returns:
    
    the type of the cluster in charge of this application
    
    Throws:
    
    ConfigurationException
  - getType
```
protected static EClusterType getType(ISettingsMap map)
                               throws ConfigurationException
```
    Throws:
    
    ConfigurationException
  - isStormApplication
```
public boolean isStormApplication()
                           throws ConfigurationException
```
    Specified by:
    
    isStormApplication in interface IApplication
    
    Returns:
    
    true if the job is a storm topology
    
    Throws:
    
    ConfigurationException - is the application has a wrong runtime or type settings
  - isSparkStreamingApplication
```
public boolean isSparkStreamingApplication()
                                    throws ConfigurationException
```
    Specified by:
    
    isSparkStreamingApplication in interface IApplication
    
    Returns:
    
    true if the job is a spark streaming
    
    Throws:
    
    ConfigurationException - is the application has a wrong runtime or type settings
  - isShivaApplication
```
public boolean isShivaApplication()
                           throws ConfigurationException
```
    Specified by:
    
    isShivaApplication in interface IApplication
    
    Returns:
    
    true if this is a shiva job
    
    Throws:
    
    ConfigurationException - is the application has a wrong runtime or type settings
  - isOneShot
```
public boolean isOneShot()
```
    Specified by:
    
    isOneShot in interface IApplication
    
    Returns:
    
    true if this shiva job must be executed only once
  - getCluster
```
public String getCluster()
                  throws ConfigurationException
```
    Specified by:
    
    getCluster in interface IApplication
    
    Returns:
    
    the name of the cluster
    
    Throws:
    
    ConfigurationException
  - getReloadAction
```
public String getReloadAction()
```
    Specified by:
    
    getReloadAction in interface IApplication
    
    Returns:
    
    the reload action associated to this application.
  - getShivaTags
```
public List<String> getShivaTags()
```
    Specified by:
    
    getShivaTags in interface IApplication
    
    Returns:
    
    the list of shiva tags. It returns an empty list if none is declared.
  - getShivaArgs
```
public List<String> getShivaArgs()
```
    Specified by:
    
    getShivaArgs in interface IApplication
    
    Returns:
    
    the list of shiva argument. An empty list if none is there.
  - getShivaResources
```
public List<String> getShivaResources()
```
    Specified by:
    
    getShivaResources in interface IApplication
    
    Returns:
    
    the list of shiva resources files or directories. An empty list if nothing found.
  - getShivaCronSchedule
```
public String getShivaCronSchedule()
```
    Specified by:
    
    getShivaCronSchedule in interface IApplication
    
    Returns:
    
    the shiva quartz cron schedule
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface IApplication
    
    Returns:
    
    the version associated to the job, "0.0" if none is defined.
  - getShivaCommand
```
public String getShivaCommand()
```
    Specified by:
    
    getShivaCommand in interface IApplication
    
    Returns:
    
    the command name to execute, it must be binary path
  - getPredecessors
```
public List<String> getPredecessors()
```
    Specified by:
    
    getPredecessors in interface IApplication
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setExitRequest
```
public IApplication setExitRequest(IExitRequest request)
```
    Description copied from interface: IApplication
    
    Set an exit wish to this application.
    
    Specified by:
    
    setExitRequest in interface IApplication
    
    Parameters:
    
    request - the requested wish to exit
    
    Returns:
    
    this instance
  - getExitRequest
```
public IExitRequest getExitRequest()
```
    Specified by:
    
    getExitRequest in interface IApplication
    
    Returns:
    
    an exit wish or null if none is defined
  - getEnv
```
public ISettingsMap getEnv()
```
    Specified by:
    
    getEnv in interface IApplication
    
    Returns:
    
    the application environment map
  - setEnv
```
public IApplication setEnv(String name,
                           String value)
```
    Description copied from interface: IApplication
    
    Set an environment variable. Whatever you add here is added to a map of environment variables that will be transmitted to the target runtime environment.
    
    Specified by:
    
    setEnv in interface IApplication
    
    Returns:
    
    this application
  - setApplicationUUID
```
public IApplication setApplicationUUID(String uuid)
```
    Description copied from interface: IApplication
    
    Set the unique identifier to this application.
    
    Specified by:
    
    setApplicationUUID in interface IApplication
    
    Returns:
    
    this instance
  - getUUID
```
public String getUUID()
```
    Description copied from interface: IApplication
    
    The unique application identifier is attributed by the owner entity (book or channel). If not set an empty string is returned.
    
    Specified by:
    
    getUUID in interface IApplication
    
    Returns:
    
    the unique application identifier.
  - getApplyResolverOn
```
public List<String> getApplyResolverOn()
```
    Specified by:
    
    getApplyResolverOn in interface IApplication
    
    Returns:
    
    list of files with their runtime relative to shiva workdir on which resolver should be applied
  - audit
```
public void audit()
           throws ConfigurationException
```
    Description copied from interface: IApplication
    
    Audit an application. This checks the correct settings of the application and throw an exception if there is any issue.
    
    Specified by:
    
    audit in interface IApplication
    
    Throws:
    
    ConfigurationException
  - auditFile
```
protected void auditFile(String path,
                         boolean isDict)
                  throws ConfigurationException
```
    Audit a settings file. If the isDict parameter is true it is decoded as json/yaml/hjson as well.
    
    Parameters:
    
    path - the file path
    
    isDict - true to decode it as a dictionary
    
    Throws:
    
    ConfigurationException - if tehre is some issue
  - auditFileByPrefix
```
protected void auditFileByPrefix(String path,
                                 boolean isDict)
                          throws ConfigurationException
```
    Throws:
    
    ConfigurationException
  - getExitSettingsOrDefault
```
public ISettingsMap getExitSettingsOrDefault(ISettingsMap defaultExitCondition)
                                      throws ConfigurationException
```
    Description copied from interface: IApplication
    Applications, as defined in a book structure, can specify an optional exit settings. These settings express when the application should request an exit to the exit platform service. For example whenever enough data has been acked.
    In channel structure it is not allowed, the applications are either periodic or ever running, but have never their exit managed by the platform.
```
 
       exit:
       {
        type: default
        condition: {
          failure:
          {
            acks_greater_or_equal_to: 0
            inactive_for_more_than: 5s
          }
          success:
          {
            fails_greater_or_equal_to: 0
          }
        }
 
 
```
    Specified by:
    
    getExitSettingsOrDefault in interface IApplication
    
    Parameters:
    
    defaultExitCondition - the ones to return if none is found
    
    Returns:
    
    the exit settings
    
    Throws:
    
    ConfigurationException - if a channel express one, or if it is invalid

Class ApplicationImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

entity

map

Constructor Detail

ApplicationImpl

Method Detail

getSettingsMap

getEntity

getShortName

getFullName

getTenant

getTenantName

getType

getType

isStormApplication

isSparkStreamingApplication

isShivaApplication

isOneShot

getCluster

getReloadAction

getShivaTags

getShivaArgs

getShivaResources

getShivaCronSchedule

getVersion

getShivaCommand

getPredecessors

toString

setExitRequest

getExitRequest

getEnv

setEnv

setApplicationUUID

getUUID

getApplyResolverOn

audit

auditFile

auditFileByPrefix

getExitSettingsOrDefault