io.cdap.cdap.api.app

Interface Application<T extends Config>

Type Parameters:

T - Config class that represents the configuration of the Application.

All Known Implementing Classes:

AbstractApplication

public interface Application<T extends Config>

Defines a CDAP Application.

Method Summary

Modifier and Type	Method and Description
void	configure(ApplicationConfigurer configurer, ApplicationContext<T> context) Configures the Application.
default boolean	isUpdateSupported() Returns if application supports config update or not.
default ApplicationUpdateResult<T>	updateConfig(ApplicationUpdateContext applicationUpdateContext) Updates application configuration based on config and update actions inside applicationUpdateContext.

Method Detail

configure

void configure(ApplicationConfigurer configurer,
               ApplicationContext<T> context)

Configures the Application.

Parameters:

configurer - Collects the Application configuration

context - Used to access the environment, application configuration, and application (deployment) arguments

isUpdateSupported

default boolean isUpdateSupported()

Returns if application supports config update or not.

updateConfig

default ApplicationUpdateResult<T> updateConfig(ApplicationUpdateContext applicationUpdateContext)
                                         throws Exception

Updates application configuration based on config and update actions inside applicationUpdateContext.

Parameters:

applicationUpdateContext - Used to access methods helpful for operations like upgrading plugin version for config.

Returns:

ApplicationUpdateResult object for the config update operation.

Throws:

UnsupportedOperationException - if application does not support config update operation.

Exception - if there was an exception during update of app config. This exception will often wrap the actual exception.