/*
 * 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.components.state;

/**
 * A Scope represents how a NiFi component's state is to be stored and retrieved when running in a cluster.
 */
public enum Scope {

    /**
     * State is to be treated as "global" across the cluster. I.e., the same component on all nodes will
     * have access to the same state.
     */
    CLUSTER,

    /**
     * State is to be treated local to the node. I.e., the same component will have different state on each
     * node in the cluster.
     */
    LOCAL;

    @Override
    public String toString() {
        return name();
    }
}
