src/main/java/org/apache/cassandra/sidecar/config/CassandraInputValidationConfiguration.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.cassandra.sidecar.config;

import java.util.Set;

/**
 * Encapsulate configuration values for validation properties used for Cassandra inputs
 */
public interface CassandraInputValidationConfiguration
{
    /**
     * @return a set of forbidden keyspaces
     */
    Set<String> forbiddenKeyspaces();

    /**
     * @return a regular expression for an allowed pattern for name of keyspaces and tables defined by the grammar in
     * <a href="https://cassandra.apache.org/doc/4.1/cassandra/cql/ddl.html#common-definitions">Cassandra CQL common
     * definitions</a>
     */
    String allowedPatternForName();

    /**
     * @return a regular expression for an allowed pattern for <i>quoted</i> names of keyspace and tables defined by
     * the grammar in <a href="https://cassandra.apache.org/doc/4.1/cassandra/cql/ddl.html#common-definitions">
     * Cassandra CQL common definitions</a>
     */
    String allowedPatternForQuotedName();

    /**
     * @return a regular expression for an allowed pattern for component names
     */
    String allowedPatternForComponentName();

    /**
     * @return a regular expression to an allowed pattern for a subset of component names
     */
    String allowedPatternForRestrictedComponentName();
}