IApplication (Punch Common Core Library 6.4.5 API)

All Known Implementing Classes:

ApplicationImpl, ShivaApplicationImpl, StormApplicationImpl
```
public interface IApplication
```
The IApplication interface lets you access a given topology resources.

Author:

dimi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`audit()` Audit an application.
`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()`
`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 string)` 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.

- Method Detail
  - getShortName
```
String getShortName()
```
    Returns:
    
    the name of this job. This is the name as defined in the job section.
  - getType
```
EClusterType getType()
              throws ConfigurationException
```
    Returns:
    
    the type of the cluster in charge of this application
    
    Throws:
    
    ConfigurationException
  - getCluster
```
String getCluster()
           throws ConfigurationException
```
    Returns:
    
    the name of the cluster
    
    Throws:
    
    ConfigurationException
  - getSettingsMap
```
ISettingsMap getSettingsMap()
```
    Returns:
    
    this application settings map
  - getEntity
```
IEntity getEntity()
```
    Returns:
    
    this application channel
  - getTenant
```
ITenant getTenant()
```
    Returns:
    
    this application tenant
  - getReloadAction
```
String getReloadAction()
```
    Returns:
    
    the reload action associated to this application.
  - isStormApplication
```
boolean isStormApplication()
                    throws ConfigurationException
```
    Returns:
    
    true if the job is a storm topology
    
    Throws:
    
    ConfigurationException - is the application has a wrong runtime or type settings
  - isSparkStreamingApplication
```
boolean isSparkStreamingApplication()
                             throws ConfigurationException
```
    Returns:
    
    true if the job is a spark streaming
    
    Throws:
    
    ConfigurationException - is the application has a wrong runtime or type settings
  - isShivaApplication
```
boolean isShivaApplication()
                    throws ConfigurationException
```
    Returns:
    
    true if this is a shiva job
    
    Throws:
    
    ConfigurationException - is the application has a wrong runtime or type settings
  - isOneShot
```
boolean isOneShot()
```
    Returns:
    
    true if this shiva job must be executed only once
  - getFullName
```
String getFullName()
            throws ConfigurationException
```
    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.
    
    Returns:
    
    a per tenant unique name, useful to be used as a persistent key.
    
    Throws:
    
    ConfigurationException
  - getTenantName
```
String getTenantName()
```
    Returns:
    
    the owning tenant name
  - getShivaTags
```
List<String> getShivaTags()
```
    Returns:
    
    the list of shiva tags. It returns an empty list if none is declared.
  - getApplyResolverOn
```
List<String> getApplyResolverOn()
```
    Returns:
    
    list of files with their runtime relative to shiva workdir on which resolver should be applied
  - getShivaCommand
```
String getShivaCommand()
```
    Returns:
    
    the command name to execute, it must be binary path
  - getShivaArgs
```
List<String> getShivaArgs()
```
    Returns:
    
    the list of shiva argument. An empty list if none is there.
  - getShivaResources
```
List<String> getShivaResources()
```
    Returns:
    
    the list of shiva resources files or directories. An empty list if nothing found.
  - getShivaCronSchedule
```
String getShivaCronSchedule()
```
    Returns:
    
    the shiva quartz cron schedule
  - getExitSettingsOrDefault
```
ISettingsMap getExitSettingsOrDefault(ISettingsMap defaultExitCondition)
                               throws ConfigurationException
```
    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
          }
        }
 
 
```
    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
  - getVersion
```
String getVersion()
```
    Returns:
    
    the version associated to the job, "0.0" if none is defined.
  - getPredecessors
```
List<String> getPredecessors()
```
  - setExitRequest
```
IApplication setExitRequest(IExitRequest request)
```
    Set an exit wish to this application.
    
    Parameters:
    
    request - the requested wish to exit
    
    Returns:
    
    this instance
  - getExitRequest
```
IExitRequest getExitRequest()
```
    Returns:
    
    an exit wish or null if none is defined
  - getEnv
```
ISettingsMap getEnv()
```
    Returns:
    
    the application environment map
  - setEnv
```
IApplication setEnv(String name,
                    String value)
```
    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.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    this application
  - getUUID
```
String getUUID()
```
    The unique application identifier is attributed by the owner entity (book or channel). If not set an empty string is returned.
    
    Returns:
    
    the unique application identifier.
  - setApplicationUUID
```
IApplication setApplicationUUID(String string)
```
    Set the unique identifier to this application.
    
    Parameters:
    
    string -
    
    Returns:
    
    this instance
  - audit
```
void audit()
    throws ConfigurationException
```
    Audit an application. This checks the correct settings of the application and throw an exception if there is any issue.
    
    Throws:
    
    ConfigurationException

Interface IApplication

Method Summary

Method Detail

getShortName

getType

getCluster

getSettingsMap

getEntity

getTenant

getReloadAction

isStormApplication

isSparkStreamingApplication

isShivaApplication

isOneShot

getFullName

getTenantName

getShivaTags

getApplyResolverOn

getShivaCommand

getShivaArgs

getShivaResources

getShivaCronSchedule

getExitSettingsOrDefault

getVersion

getPredecessors

setExitRequest

getExitRequest

getEnv

setEnv

getUUID

setApplicationUUID

audit