Package io.streamthoughts.azkarra.streams

Class AzkarraApplication

java.lang.Object

io.streamthoughts.azkarra.streams.AzkarraApplication

public class AzkarraApplication
extends Object

AzkarraApplication is the high-level class which can be used to deploy a simple server for managing multiple KafkaStreams instances.

See Also:

AzkarraContext, AzkarraContextListener, AzkarraContextAware, StreamsExecutionEnvironment, StreamsExecutionEnvironmentAware, A simple application might look like this:

Field Summary

Fields

Modifier and Type	Field	Description
static String	AZKARRA_ROOT_CONFIG_KEY

Constructor Summary

Constructors

Constructor	Description
AzkarraApplication(Class<?>... sources)	Creates a new AzkarraApplication instance.

Method Summary

Modifier and Type	Method	Description
AzkarraApplication	addConfigEntryLoader(ApplicationConfigEntryLoader configEntryLoader)	Adds a new ApplicationConfigEntryLoader to be used for reading the application configuration.
AzkarraApplication	addConfiguration(Conf configuration)	Adds the specified Conf to the configuration of this AzkarraApplication.
AzkarraApplication	addSource(Class<?> source)	Adds a class source which must be used for initializing this AzkarraApplication.
AzkarraApplication	addSources(Class<?>... sources)	Adds a class sources which must be used for initializing this AzkarraApplication.
Conf	getConfiguration()	Gets the configuration for this AzkarraApplication.
AzkarraContext	getContext()	Gets the AzkarraContext.
Class<?>	getMainApplicationClass()	Gets the Class containing the main method.
static AzkarraContext	run()
static AzkarraContext	run(Class<?>[] sources, String[] args)
static AzkarraContext	run(Class<?> sources, String[] args)
AzkarraContext	run(String[] args)	Runs this AzkarraApplication.
AzkarraApplication	setAutoStart(boolean enable)	Sets if all registered topologies must be automatically added to the default environment and started when this AzkarraApplication is started.
AzkarraApplication	setAutoStart(boolean enable, String targetEnv)	Sets if all registered topologies must be automatically added to the specified environment and started when this AzkarraApplication is started.
AzkarraApplication	setBanner(Banner banner)	Sets the Banner to print when this AzkarraContext is started.
AzkarraApplication	setBannerMode(Banner.Mode mode)	Sets the mode used to print the Banner instance when this AzkarraContext is started.
AzkarraApplication	setConfiguration(Conf configuration)	Sets the AzkarraApplication configuration.
AzkarraApplication	setContext(AzkarraContext context)	Sets the AzkarraContext that must be used for this AzkarraApplication.
AzkarraApplication	setEnableComponentScan(boolean enableComponentScan)	Sets if the classpath must be scanned for searching components.
AzkarraApplication	setHttpServerConf(Conf httpServerConf)	Sets the HTTP server configuration.
AzkarraApplication	setHttpServerEnable(boolean httpServerEnable)	Sets whether the HTTP server should be enable.
AzkarraApplication	setRegisterShutdownHook(boolean registerShutdownHook)	Sets if the created AzkarraContext should have a shutdown hook registered.
static String	withAzkarraPrefix(String key)	Helper method to prefix a key property with the root property prefix (i.e "azkarra".

Methods inherited from class java.lang.Object

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

Field Detail

AZKARRA_ROOT_CONFIG_KEY

public static final String AZKARRA_ROOT_CONFIG_KEY

See Also:

Constant Field Values

Constructor Detail

AzkarraApplication

public AzkarraApplication(Class<?>... sources)

Creates a new AzkarraApplication instance.

Parameters:

sources - the classes which are used for auto-configuring the application.

Method Detail

withAzkarraPrefix

public static String withAzkarraPrefix(String key)

Helper method to prefix a key property with the root property prefix (i.e "azkarra".

Parameters:

key - the key propery to prefix.

Returns:

the prefixed key.

run

public static AzkarraContext run()

run

public static AzkarraContext run(Class<?> sources,
                                 String[] args)

run

public static AzkarraContext run(Class<?>[] sources,
                                 String[] args)

setHttpServerEnable

public AzkarraApplication setHttpServerEnable(boolean httpServerEnable)

Sets whether the HTTP server should be enable.

Parameters:

httpServerEnable - set to true to enable the server.

setHttpServerConf

public AzkarraApplication setHttpServerConf(Conf httpServerConf)

Sets the HTTP server configuration.

Parameters:

httpServerConf - the http server configuration.

Returns:

this AzkarraApplication instance.

setEnableComponentScan

public AzkarraApplication setEnableComponentScan(boolean enableComponentScan)

Sets if the classpath must be scanned for searching components.

Parameters:

enableComponentScan - enable/disable component scan.

Returns:

this AzkarraApplication instance.

setRegisterShutdownHook

public AzkarraApplication setRegisterShutdownHook(boolean registerShutdownHook)

Sets if the created AzkarraContext should have a shutdown hook registered. Defaults to true to ensure that JVM shutdowns are handled gracefully.

Parameters:

registerShutdownHook - if the shutdown hook should be registered.

setBannerMode

public AzkarraApplication setBannerMode(Banner.Mode mode)

Sets the mode used to print the Banner instance when this AzkarraContext is started.

Parameters:

mode - the Banner.Mode to use.

Returns:

this AzkarraApplication instance.

setBanner

public AzkarraApplication setBanner(Banner banner)

Sets the Banner to print when this AzkarraContext is started.

Parameters:

banner - the Banner instance to print.

Returns:

this AzkarraApplication instance.

setAutoStart

public AzkarraApplication setAutoStart(boolean enable)

Sets if all registered topologies must be automatically added to the default environment and started when this AzkarraApplication is started. Note : This is important to not enable auto-start if some topologies are already registered to environments either programmatically or through configuration, otherwise topologies can start twice.

Parameters:

enable - if the topologies should be started.

Returns:

this AzkarraApplication instance.

setAutoStart

public AzkarraApplication setAutoStart(boolean enable,
                                       String targetEnv)

Sets if all registered topologies must be automatically added to the specified environment and started when this AzkarraApplication is started. Note : This is important to not enable auto-start if some topologies are already registered to environments either programmatically or through configuration, otherwise topologies can start twice.

Parameters:

enable - if the topologies should be started.

targetEnv - the target environment for all topologies.

Returns:

this AzkarraApplication instance.

addConfiguration

public AzkarraApplication addConfiguration(Conf configuration)

Adds the specified Conf to the configuration of this AzkarraApplication.

Parameters:

configuration - the Conf instance to be used.

Returns:

this AzkarraApplication instance.

setConfiguration

public AzkarraApplication setConfiguration(Conf configuration)

Sets the AzkarraApplication configuration.

Parameters:

configuration - the Conf instance to be used.

Returns:

this AzkarraApplication instance.

addConfigEntryLoader

public AzkarraApplication addConfigEntryLoader(ApplicationConfigEntryLoader configEntryLoader)

Adds a new ApplicationConfigEntryLoader to be used for reading the application configuration.

Parameters:

configEntryLoader - the ApplicationConfigEntryLoader to be added.

Returns:

this AzkarraApplication instance.

getConfiguration

public Conf getConfiguration()

Gets the configuration for this AzkarraApplication.

Returns:

the Conf instance.

run

public AzkarraContext run(String[] args)

Runs this AzkarraApplication.

addSource

public AzkarraApplication addSource(Class<?> source)

Adds a class source which must be used for initializing this AzkarraApplication.

Parameters:

source - the {@link class} to be add.

Returns:

this AzkarraApplication instance.

addSources

public AzkarraApplication addSources(Class<?>... sources)

Adds a class sources which must be used for initializing this AzkarraApplication.

Parameters:

sources - the list of {@link class} to be add.

Returns:

this AzkarraApplication instance.

setContext

public AzkarraApplication setContext(AzkarraContext context)

Sets the AzkarraContext that must be used for this AzkarraApplication.

Parameters:

context - the AzkarraContext to be used.

Returns:

this AzkarraApplication instance.

getContext

public AzkarraContext getContext()

Gets the AzkarraContext.

Returns:

a AzkarraContext context, or null if not initialized.

getMainApplicationClass

public Class<?> getMainApplicationClass()

Gets the Class containing the main method.

Returns:

the main application Class.