Package io.streamthoughts.azkarra.api

Interface AzkarraContext

All Superinterfaces:

ComponentRegistry, ConfigurableComponentFactory

All Known Implementing Classes:

DefaultAzkarraContext

public interface AzkarraContext
extends ConfigurableComponentFactory, ComponentRegistry

The AzkarraContext.

Method Summary

Modifier and Type	Method	Description
AzkarraContext	addConfiguration(Conf configuration)	Adds the specified Conf to the configuration of this AzkarraContext.
AzkarraContext	addExecutionEnvironment(StreamsExecutionEnvironment<?> environment)	Adds the StreamsExecutionEnvironment to this context.
AzkarraContext	addListener(AzkarraContextListener listener)	Registers a new listener instance to this context.
Optional<ApplicationId>	addTopology(Class<? extends TopologyProvider> type, Executed executed)	Adds a topology to the default environment of this context.
Optional<ApplicationId>	addTopology(Class<? extends TopologyProvider> type, String environment, Executed executed)	Adds a topology to a specified environment.
Optional<ApplicationId>	addTopology(String type, Executed executed)	Adds a topology to the default environment of this context.
Optional<ApplicationId>	addTopology(String type, String environment, Executed executed)	Adds a topology to a specified environment.
Optional<ApplicationId>	addTopology(String type, String version, String environment, Executed executed)	Adds a topology to a specified environment.
List<StreamsExecutionEnvironment<?>>	getAllEnvironments()	Gets all StreamsExecutionEnvironment registered to this context.
ComponentFactory	getComponentFactory()	Gets the internal ComponentFactory.
Conf	getConfiguration()	Returns the global context streamsConfig of this AzkarraContext instance.
StreamsExecutionEnvironment<?>	getDefaultEnvironment()	Gets the default StreamsExecutionEnvironment.
StreamsExecutionEnvironment<?>	getEnvironmentForName(String envName)	Gets the StreamsExecutionEnvironment for the specified name.
Set<TopologyDescriptor>	getTopologyDescriptors()	Gets all topologies registered into this AzkarraContext even those ones which are not enable.
Set<TopologyDescriptor>	getTopologyDescriptors(StreamsExecutionEnvironment<?> env)	Gets all topologies registered into this AzkarraContext which are available for the given environment.
Set<TopologyDescriptor>	getTopologyDescriptors(String environmentName)	Gets all topologies registered into this AzkarraContext which are available for the given environment.
AzkarraContext	setConfiguration(Conf configuration)	Sets the default configuration to be used for this AzkarraContext.
AzkarraContext	setRegisterShutdownHook(boolean registerShutdownHook)	Sets if the created AzkarraContext should have a shutdown hook registered.
void	start()	Starts this AzkarraContext instance.
default void	stop()	Stops this AzkarraContext instance.
void	stop(boolean cleanUp)	Stops this AzkarraContext instance.

Methods inherited from interface io.streamthoughts.azkarra.api.components.ComponentRegistry

registerComponent, registerComponent, registerComponent, registerComponent, registerSingleton, registerSingleton, registerSingleton, registerSingleton, registerSingleton

Methods inherited from interface io.streamthoughts.azkarra.api.components.ConfigurableComponentFactory

getAllComponents, getAllComponents, getAllComponents, getAllComponents, getComponent, getComponent, getComponent, getComponent

Method Detail

getComponentFactory

ComponentFactory getComponentFactory()

Gets the internal ComponentFactory.

Specified by:

getComponentFactory in interface ConfigurableComponentFactory

Returns:

the ComponentFactory instance to be used.

addListener

AzkarraContext addListener(AzkarraContextListener listener)

Registers a new listener instance to this context.

Parameters:

listener - the AzkarraContextListener instance to register.

Returns:

this AzkarraContext instance.

setRegisterShutdownHook

AzkarraContext 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

Returns:

this AzkarraContext instance.

getConfiguration

Conf getConfiguration()

Returns the global context streamsConfig of this AzkarraContext instance.

Specified by:

getConfiguration in interface ConfigurableComponentFactory

Returns:

a Conf instance.

setConfiguration

AzkarraContext setConfiguration(Conf configuration)

Sets the default configuration to be used for this AzkarraContext.

Parameters:

configuration - the Conf instance.

Returns:

this AzkarraContext instance.

addConfiguration

AzkarraContext addConfiguration(Conf configuration)

Adds the specified Conf to the configuration of this AzkarraContext.

Parameters:

configuration - the Conf instance to be used.

Returns:

this AzkarraContext instance.

addExecutionEnvironment

AzkarraContext addExecutionEnvironment(StreamsExecutionEnvironment<?> environment)
                                throws AlreadyExistsException

Adds the StreamsExecutionEnvironment to this context.

Parameters:

environment - the StreamsExecutionEnvironment instance.

Returns:

this AzkarraContext instance.

Throws:

AlreadyExistsException - if a StreamsExecutionEnvironment is already registered for the given name.

addTopology

Optional<ApplicationId> addTopology(String type,
                                    Executed executed)

Adds a topology to the default environment of this context.

Parameters:

type - the fully qualified class name or alias of the target TopologyProvider.

executed - the Executed instance.

Returns:

the ApplicationId instance if the environment is already started, otherwise null.

addTopology

Optional<ApplicationId> addTopology(Class<? extends TopologyProvider> type,
                                    Executed executed)

Adds a topology to the default environment of this context.

Parameters:

type - the TopologyProvider class to add.

executed - the Executed instance.

Returns:

the ApplicationId instance if the environment is already started, otherwise null.

addTopology

Optional<ApplicationId> addTopology(Class<? extends TopologyProvider> type,
                                    String environment,
                                    Executed executed)

Adds a topology to a specified environment.

Parameters:

type - the TopologyProvider class to add.

environment - the environment name.

executed - the Executed instance.

Returns:

the ApplicationId instance if the environment is already started, otherwise null..

addTopology

Optional<ApplicationId> addTopology(String type,
                                    String environment,
                                    Executed executed)

Adds a topology to a specified environment.

Parameters:

type - the fully qualified class name or alias of the target TopologyProvider.

environment - the environment name.

executed - the Executed instance.

Returns:

the ContainerId instance if the environment is already started, otherwise null.

addTopology

Optional<ApplicationId> addTopology(String type,
                                    String version,
                                    String environment,
                                    Executed executed)

Adds a topology to a specified environment.

Parameters:

type - the fully qualified class name or alias of the target TopologyProvider.

version - the topology version.

environment - the environment name.

executed - the Executed instance.

Returns:

the ContainerId instance if the environment is already started, otherwise null.

getTopologyDescriptors

Set<TopologyDescriptor> getTopologyDescriptors()

Gets all topologies registered into this AzkarraContext even those ones which are not enable.

Returns:

a set of TopologyDescriptor.

getTopologyDescriptors

Set<TopologyDescriptor> getTopologyDescriptors(String environmentName)

Gets all topologies registered into this AzkarraContext which are available for the given environment.

Parameters:

environmentName - the StreamsExecutionEnvironment

Returns:

a set of TopologyDescriptor.

getTopologyDescriptors

Set<TopologyDescriptor> getTopologyDescriptors(StreamsExecutionEnvironment<?> env)

Gets all topologies registered into this AzkarraContext which are available for the given environment.

Parameters:

env - the StreamsExecutionEnvironment

Returns:

a set of TopologyDescriptor.

getAllEnvironments

List<StreamsExecutionEnvironment<?>> getAllEnvironments()

Gets all StreamsExecutionEnvironment registered to this context.

Returns:

a list of StreamsExecutionEnvironment instance.

getEnvironmentForName

StreamsExecutionEnvironment<?> getEnvironmentForName(String envName)

Gets the StreamsExecutionEnvironment for the specified name.

Parameters:

envName - the environment name.

Returns:

a StreamsExecutionEnvironment instance with the specified name.

getDefaultEnvironment

StreamsExecutionEnvironment<?> getDefaultEnvironment()

Gets the default StreamsExecutionEnvironment. This method can return null while the context is not started.

Returns:

a StreamsExecutionEnvironment instance.

start

void start()

Starts this AzkarraContext instance.

stop

void stop(boolean cleanUp)

Stops this AzkarraContext instance.

Parameters:

cleanUp - if local states of each KafkaStreams instance must be cleanup.

See Also:

.

stop

default void stop()

Stops this AzkarraContext instance.