nifi-nar-bundles/nifi-scripting-bundle/nifi-scripting-processors/src/main/java/org/apache/nifi/processors/script/ScriptEngineConfigurator.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.processors.script;


import org.apache.nifi.logging.ComponentLog;

import javax.script.ScriptEngine;
import javax.script.ScriptException;
import java.net.URL;

/**
 * This interface describes callback methods used by the ExecuteScript/InvokeScript processors to perform
 * engine-specific tasks at various points in the engine lifecycle.
 */
public interface ScriptEngineConfigurator {

    String getScriptEngineName();

    URL[] getModuleURLsForClasspath(String[] modulePaths, ComponentLog log);

    Object init(ScriptEngine engine, String scriptBody, String[] modulePaths) throws ScriptException;

    Object eval(ScriptEngine engine, String scriptBody, String[] modulePaths) throws ScriptException;

    default void reset() {
    }
}