org.apache.nifi.flowanalysis.FlowAnalysisRuleContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nifi-api Show documentation
The newest version!
/*
 * 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.flowanalysis;

import org.apache.nifi.components.PropertyDescriptor;
import org.apache.nifi.components.state.StateManager;
import org.apache.nifi.context.PropertyContext;

import java.util.Map;

/**
 * This interface provides a bridge between the NiFi Framework and a
 * {@link FlowAnalysisRule}. This context allows a FlowAnalysisRule to access
 * configuration supplied by the user.
 */
public interface FlowAnalysisRuleContext extends PropertyContext {
    /**
     * @return the name of the rule that is being triggered
     */
    String getRuleName();

    /**
     * @return a Map of all known {@link PropertyDescriptor}s to their
     * configured properties. This Map will contain a null for any
     * Property that has not been configured by the user, even if the
     * PropertyDescriptor has a default value
     */
    Map getProperties();

    /**
     * @return the StateManager that can be used to store and retrieve state for this component
     */
    StateManager getStateManager();

    /**
     * @return a FlowAnalysisContext that can be used to access flow- or other analysis-related information
     */
    FlowAnalysisContext getFlowAnalysisContext();
}