ConfigurationResult.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.web;

/**
 * Represents a request to configure. The implementations execute method will
 * perform the configuration action. It will return type T which will be
 * encapsulated in a ConfigurationSnapshot.
 *
 * @param <T> type of request
 */
public interface ConfigurationResult<T> {

    /**
     * Returns whether the configuration represents a newly created resource.
     *
     * @return If the configuration represents a newly created resource
     */
    boolean isNew();

    /**
     * Returns the resulting configuration.
     *
     * @return The resulting configuration
     */
    T getConfiguration();
}