c3b1cf3990db0069abce08202f8bcd742ba32652
[samza.git] / samza-api / src / main / java / org / apache / samza / operators / ContextManager.java
1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.samza.operators;
20
21 import org.apache.samza.annotation.InterfaceStability;
22 import org.apache.samza.config.Config;
23 import org.apache.samza.task.TaskContext;
24
25
26 /**
27 * Interface class defining methods to initialize and finalize the context used by the transformation functions.
28 */
29 @InterfaceStability.Unstable
30 public interface ContextManager {
31 /**
32 * The initialization method to create shared context for the whole task in Samza. Default to NO-OP
33 *
34 * @param config the configuration object for the task
35 * @param context the {@link TaskContext} object
36 * @return User-defined task-wide context object
37 */
38 default TaskContext initTaskContext(Config config, TaskContext context) {
39 return context;
40 }
41
42 /**
43 * The finalize method to allow users to close resource initialized in {@link #initTaskContext} method. Default to NO-OP.
44 *
45 */
46 default void finalizeTaskContext() { }
47 }