ProcessorInitializationContext.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.nifi.processor;

import org.apache.nifi.controller.ControllerServiceLookup;
import org.apache.nifi.controller.NodeTypeProvider;
import org.apache.nifi.kerberos.KerberosContext;
import org.apache.nifi.logging.ComponentLog;

/**
 * <p>
 * The <code>ProcessorInitializationContext</code> provides
 * {@link org.apache.nifi.processor.Processor Processor}s access to objects that
 * may be of use throughout the life of the Processor.
 * </p>
 */
public interface ProcessorInitializationContext extends KerberosContext {

    /**
     * @return the unique identifier for this processor
     */
    String getIdentifier();

    /**
     * @return a {@link ComponentLog} that is tied to this processor that can be
     * used to log events
     */
    ComponentLog getLogger();

    /**
     * @return the {@link ControllerServiceLookup} which can be used to obtain
     * Controller Services
     */
    ControllerServiceLookup getControllerServiceLookup();

    /**
     * @return the {@link NodeTypeProvider} which can be used to detect the node
     * type of this NiFi instance.
     */
    NodeTypeProvider getNodeTypeProvider();
}