org.apache.samza.context

Interface ApplicationContainerContextFactory<T extends ApplicationContainerContext>

Type Parameters:

T - concrete type of ApplicationContainerContext created by this factory

All Superinterfaces:

java.io.Serializable

@InterfaceStability.Evolving
public interface ApplicationContainerContextFactory<T extends ApplicationContainerContext>
extends java.io.Serializable

The factory for creating ApplicationContainerContext instances for a SamzaApplication during container initialization.

Use ApplicationDescriptor.withApplicationContainerContextFactory(org.apache.samza.context.ApplicationContainerContextFactory<?>) to provide the ApplicationContainerContextFactory. Use Context.getApplicationContainerContext() to get the created ApplicationContainerContext instance for the current container.

The ApplicationContainerContextFactory implementation must be Serializable.

Method Summary

Modifier and Type	Method and Description
default T	create(ExternalContext externalContext, JobContext jobContext, ContainerContext containerContext) Creates an instance of the application-defined ApplicationContainerContext.
default T	create(JobContext jobContext, ContainerContext containerContext) Deprecated.

Method Detail

create

default T create(ExternalContext externalContext,
                 JobContext jobContext,
                 ContainerContext containerContext)

Creates an instance of the application-defined ApplicationContainerContext.

Applications should implement this to provide a context for container initialization.

Parameters:

externalContext - external context provided for the application; null if it was not provided

jobContext - framework-provided job context

containerContext - framework-provided container context

Returns:

a new instance of the application-defined ApplicationContainerContext

create

@Deprecated
default T create(JobContext jobContext,
                             ContainerContext containerContext)

Deprecated.

New implementations should not implement this directly. Implement create(ExternalContext, JobContext, ContainerContext) instead.

This is the same as create(ExternalContext, JobContext, ContainerContext), except it does not provide access to external context.

This is being left here for backwards compatibility.

Parameters:

jobContext - framework-provided job context

containerContext - framework-provided container context

Returns:

a new instance of the application-defined ApplicationContainerContext Deprecated: Applications should implement create(ExternalContext, JobContext, ContainerContext) directly. This is being left here for backwards compatibility.