org.apache.samza.context

Interface ApplicationTaskContextFactory<T extends ApplicationTaskContext>

Type Parameters:

T - concrete type of ApplicationTaskContext created by this factory

All Superinterfaces:

java.io.Serializable

@InterfaceStability.Evolving
public interface ApplicationTaskContextFactory<T extends ApplicationTaskContext>
extends java.io.Serializable

The factory for creating ApplicationTaskContext instances for a SamzaApplicationduring task initialization.

Use ApplicationDescriptor.withApplicationTaskContextFactory(org.apache.samza.context.ApplicationTaskContextFactory<?>) to provide the ApplicationTaskContextFactory. Use Context.getApplicationTaskContext() to get the created ApplicationTaskContext instance for the current task.

The ApplicationTaskContextFactory implementation must be Serializable.

Method Summary

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

Method Detail

create

default T create(ExternalContext externalContext,
                 JobContext jobContext,
                 ContainerContext containerContext,
                 TaskContext taskContext,
                 ApplicationContainerContext applicationContainerContext)

Creates an instance of the application-defined ApplicationTaskContext.

Applications should implement this to provide a context for task 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

taskContext - framework-provided task context

applicationContainerContext - application-defined container context; null if it was not provided

Returns:

a new instance of the application-defined ApplicationTaskContext

create

@Deprecated
default T create(JobContext jobContext,
                             ContainerContext containerContext,
                             TaskContext taskContext,
                             ApplicationContainerContext applicationContainerContext)

Deprecated.

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

This is the same as create(ExternalContext, JobContext, ContainerContext, TaskContext, ApplicationContainerContext), 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

taskContext - framework-provided task context

applicationContainerContext - application-defined container context; null if it was not provided

Returns:

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