Package io.streamthoughts.azkarra.runtime.context

Class DefaultAzkarraContext

java.lang.Object

io.streamthoughts.azkarra.runtime.context.DefaultAzkarraContext

All Implemented Interfaces:

AzkarraContext, ComponentRegistry, ConfigurableComponentFactory

public class DefaultAzkarraContext
extends Object
implements AzkarraContext

The AzkarraContext.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ENV_NAME

Method Summary

Modifier and Type	Method	Description
AzkarraContext	addConfiguration(Conf configuration)	Adds the specified Conf to the configuration of this AzkarraContext.
AzkarraContext	addExecutionEnvironment(StreamsExecutionEnvironment<?> env)	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.
static DefaultAzkarraContext	create()	Static helper that can be used to creates a new AzkarraContext instance using a default ComponentRegistry and a empty configuration.
static DefaultAzkarraContext	create(ComponentFactory factory)	Static helper that can be used to creates a new AzkarraContext instance using the specified ComponentRegistry and a empty configuration.
static DefaultAzkarraContext	create(Conf configuration)	Static helper that can be used to creates a new AzkarraContext instance using a default ComponentRegistry and the specified configuration.
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 name)	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.
<T> void	registerComponent(String componentName, Class<T> componentClass, ComponentDescriptorModifier... modifiers)	Registers the component supplier for the specified type and name.
<T> void	registerComponent(String componentName, Class<T> componentClass, Supplier<T> supplier, ComponentDescriptorModifier... modifiers)	Registers the component supplier for the specified type and name.
<T> void	registerSingleton(String componentName, Class<T> componentClass, ComponentDescriptorModifier... modifiers)	Registers a singleton no-arg constructor component supplier for the specified type.
<T> void	registerSingleton(String componentName, Class<T> componentClass, Supplier<T> singleton, ComponentDescriptorModifier... modifiers)	Registers the component supplier for the specified type and name.
<T> void	registerSingleton(T singleton)	Register the specified shared instance.
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	setState(State state)
void	start()	Starts this AzkarraContext instance.
void	stop(boolean cleanUp)	Stops this AzkarraContext instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.streamthoughts.azkarra.api.AzkarraContext

stop

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

registerComponent, registerComponent, registerSingleton, registerSingleton

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

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

Field Detail

DEFAULT_ENV_NAME

public static final String DEFAULT_ENV_NAME

See Also:

Constant Field Values

Method Detail

create

public static DefaultAzkarraContext create()

Static helper that can be used to creates a new AzkarraContext instance using a default ComponentRegistry and a empty configuration.

Returns:

a new AzkarraContext instance.

create

public static DefaultAzkarraContext create(ComponentFactory factory)

Static helper that can be used to creates a new AzkarraContext instance using the specified ComponentRegistry and a empty configuration.

Returns:

a new AzkarraContext instance.

create

public static DefaultAzkarraContext create(Conf configuration)

Static helper that can be used to creates a new AzkarraContext instance using a default ComponentRegistry and the specified configuration.

Returns:

a new AzkarraContext instance.

getComponentFactory

public ComponentFactory getComponentFactory()

Gets the internal ComponentFactory.

Specified by:

getComponentFactory in interface AzkarraContext

Specified by:

getComponentFactory in interface ConfigurableComponentFactory

Returns:

the ComponentFactory instance to be used.

addListener

public AzkarraContext addListener(AzkarraContextListener listener)

Registers a new listener instance to this context.

Specified by:

addListener in interface AzkarraContext

Parameters:

listener - the AzkarraContextListener instance to register.

Returns:

this AzkarraContext instance.

setRegisterShutdownHook

public 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.

Specified by:

setRegisterShutdownHook in interface AzkarraContext

Parameters:

registerShutdownHook - if the shutdown hook should be registered

Returns:

this AzkarraContext instance.

getConfiguration

public Conf getConfiguration()

Returns the global context streamsConfig of this AzkarraContext instance.

Specified by:

getConfiguration in interface AzkarraContext

Specified by:

getConfiguration in interface ConfigurableComponentFactory

Returns:

a Conf instance.

setConfiguration

public AzkarraContext setConfiguration(Conf configuration)

Sets the default configuration to be used for this AzkarraContext.

Specified by:

setConfiguration in interface AzkarraContext

Parameters:

configuration - the Conf instance.

Returns:

this AzkarraContext instance.

addConfiguration

public AzkarraContext addConfiguration(Conf configuration)

Adds the specified Conf to the configuration of this AzkarraContext.

Specified by:

addConfiguration in interface AzkarraContext

Parameters:

configuration - the Conf instance to be used.

Returns:

this AzkarraContext instance.

addExecutionEnvironment

public AzkarraContext addExecutionEnvironment(StreamsExecutionEnvironment<?> env)
                                       throws AlreadyExistsException

Adds the StreamsExecutionEnvironment to this context.

Specified by:

addExecutionEnvironment in interface AzkarraContext

Parameters:

env - the StreamsExecutionEnvironment instance.

Returns:

this AzkarraContext instance.

Throws:

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

addTopology

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

Adds a topology to the default environment of this context.

Specified by:

addTopology in interface AzkarraContext

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

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

Adds a topology to the default environment of this context.

Specified by:

addTopology in interface AzkarraContext

Parameters:

type - the TopologyProvider class to add.

executed - the Executed instance.

Returns:

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

addTopology

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

Adds a topology to a specified environment.

Specified by:

addTopology in interface AzkarraContext

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

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

Adds a topology to a specified environment.

Specified by:

addTopology in interface AzkarraContext

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

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

Adds a topology to a specified environment.

Specified by:

addTopology in interface AzkarraContext

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.

setState

public void setState(State state)

getTopologyDescriptors

public Set<TopologyDescriptor> getTopologyDescriptors()

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

Specified by:

getTopologyDescriptors in interface AzkarraContext

Returns:

a set of TopologyDescriptor.

getTopologyDescriptors

public Set<TopologyDescriptor> getTopologyDescriptors(String environmentName)

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

Specified by:

getTopologyDescriptors in interface AzkarraContext

Parameters:

environmentName - the StreamsExecutionEnvironment

Returns:

a set of TopologyDescriptor.

getTopologyDescriptors

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

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

Specified by:

getTopologyDescriptors in interface AzkarraContext

Parameters:

env - the StreamsExecutionEnvironment

Returns:

a set of TopologyDescriptor.

getAllEnvironments

public List<StreamsExecutionEnvironment<?>> getAllEnvironments()

Gets all StreamsExecutionEnvironment registered to this context.

Specified by:

getAllEnvironments in interface AzkarraContext

Returns:

a list of StreamsExecutionEnvironment instance.

getEnvironmentForName

public StreamsExecutionEnvironment<?> getEnvironmentForName(String name)

Gets the StreamsExecutionEnvironment for the specified name.

Specified by:

getEnvironmentForName in interface AzkarraContext

Parameters:

name - the environment name.

Returns:

a StreamsExecutionEnvironment instance with the specified name.

getDefaultEnvironment

public StreamsExecutionEnvironment<?> getDefaultEnvironment()

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

Specified by:

getDefaultEnvironment in interface AzkarraContext

Returns:

a StreamsExecutionEnvironment instance.

start

public void start()

Starts this AzkarraContext instance.

Specified by:

start in interface AzkarraContext

stop

public void stop(boolean cleanUp)

Stops this AzkarraContext instance.

Specified by:

stop in interface AzkarraContext

Parameters:

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

See Also:

.

registerComponent

public <T> void registerComponent(String componentName,
                                  Class<T> componentClass,
                                  Supplier<T> supplier,
                                  ComponentDescriptorModifier... modifiers)

Registers the component supplier for the specified type and name.

Specified by:

registerComponent in interface ComponentRegistry

Type Parameters:

T - the component-type.

Parameters:

componentName - the name of the component.

componentClass - the class-type of the component.

supplier - the supplier of the component.

modifiers - the component descriptor modifiers.

registerComponent

public <T> void registerComponent(String componentName,
                                  Class<T> componentClass,
                                  ComponentDescriptorModifier... modifiers)

Registers the component supplier for the specified type and name.

Specified by:

registerComponent in interface ComponentRegistry

Type Parameters:

T - the component-type.

Parameters:

componentName - the name of the component.

componentClass - the class-type of the component.

registerSingleton

public <T> void registerSingleton(String componentName,
                                  Class<T> componentClass,
                                  Supplier<T> singleton,
                                  ComponentDescriptorModifier... modifiers)

Registers the component supplier for the specified type and name. The given supplier will be used for creating a shared instance of type ComponentRegistry.

Specified by:

registerSingleton in interface ComponentRegistry

Type Parameters:

T - the component-type.

Parameters:

componentName - the name of the component.

componentClass - the class-type of the component.

singleton - the supplier of the component.

registerSingleton

public <T> void registerSingleton(String componentName,
                                  Class<T> componentClass,
                                  ComponentDescriptorModifier... modifiers)

Registers a singleton no-arg constructor component supplier for the specified type.

Specified by:

registerSingleton in interface ComponentRegistry

Type Parameters:

T - the component-type.

Parameters:

componentName - the name of the component.

componentClass - the class-type of the component.

registerSingleton

public <T> void registerSingleton(T singleton)

Register the specified shared instance.

Specified by:

registerSingleton in interface ComponentRegistry

Type Parameters:

T - the component-type.

Parameters:

singleton - the singleton component instance.