samza-api/src/main/java/org/apache/samza/context/ContainerContext.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.samza.context;

import org.apache.samza.job.model.ContainerModel;
import org.apache.samza.job.model.TaskModel;
import org.apache.samza.metrics.MetricsRegistry;


/**
 * The framework-provided context for the current container.
 * <p>
 * Use {@link ApplicationContainerContext} for the application-defined context for the current container.
 */
public interface ContainerContext {

  /**
   * Gets the {@link ContainerModel} for this container, which contains this container's id and its {@link TaskModel}.
   *
   * @return the {@link ContainerModel} for this container
   */
  ContainerModel getContainerModel();

  /**
   * Gets the {@link MetricsRegistry} for this container, which can be used to register metrics that are
   * reported per container.
   *
   * @return the {@link MetricsRegistry} for this container
   */
  MetricsRegistry getContainerMetricsRegistry();
}