org.apache.samza.context

Interface Context

public interface Context

A holder for all framework and application defined contexts at runtime.

Method Summary

Modifier and Type	Method and Description
ApplicationContainerContext	getApplicationContainerContext() Gets the application-defined context for the current container.
ApplicationTaskContext	getApplicationTaskContext() Gets the application-defined task context for the current task.
ContainerContext	getContainerContext() Gets the framework-provided context for the current container.
ExternalContext	getExternalContext() Gets the ExternalContext that was created outside of the application.
JobContext	getJobContext() Gets the framework-provided context for the job.
TaskContext	getTaskContext() Gets the framework-provided context for the current task.

Method Detail

getJobContext

JobContext getJobContext()

Gets the framework-provided context for the job.

Returns:

the framework-provided job context

getContainerContext

ContainerContext getContainerContext()

Gets the framework-provided context for the current container. This context is shared by all tasks within the container.

Use getApplicationContainerContext() to get the application-defined container context.

Returns:

the framework-provided container context

getTaskContext

TaskContext getTaskContext()

Gets the framework-provided context for the current task.

Use getApplicationTaskContext() to get the application-defined task context.

Returns:

the framework-provided task context

getApplicationContainerContext

ApplicationContainerContext getApplicationContainerContext()

Gets the application-defined context for the current container. This context is shared by all tasks within the container.

Use ApplicationDescriptor.withApplicationContainerContextFactory(org.apache.samza.context.ApplicationContainerContextFactory<?>) to provide a factory for this context. Cast the returned context to the concrete implementation type to use it.

Use getContainerContext() to get the framework-provided container context.

Returns:

the application-defined container context

Throws:

java.lang.IllegalStateException - if no ApplicationContainerContextFactory was was provided for the application

getApplicationTaskContext

ApplicationTaskContext getApplicationTaskContext()

Gets the application-defined task context for the current task. This context is unique to this task.

Use ApplicationDescriptor.withApplicationTaskContextFactory(org.apache.samza.context.ApplicationTaskContextFactory<?>) to provide a factory for this context. Cast the returned context to the concrete implementation type to use it.

Use getTaskContext() to get the framework-provided task context.

Returns:

the application-defined task context

Throws:

java.lang.IllegalStateException - if no ApplicationTaskContextFactory was provided for the application

getExternalContext

ExternalContext getExternalContext()

Gets the ExternalContext that was created outside of the application.

Use ApplicationRunner.run(ExternalContext) to provide this context.

Returns:

the external context provided for the application