JsonConfig.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.tika.config;

/**
 * Interface for objects that provide JSON configuration strings.
 * <p>
 * This interface allows JSON configuration to be passed in a type-safe way
 * and works seamlessly with records:
 * <pre>
 * record ConfigHolder(String json) implements JsonConfig {}
 * </pre>
 *
 * @since Apache Tika 4.0
 */
public interface JsonConfig {

    /**
     * Returns the JSON configuration string.
     *
     * @return the JSON configuration
     */
    String json();

    /**
     * Operator-authored (config file, presets), as opposed to per-request input. Untrusted
     * config may not set an {@link OperatorOnly} property.
     */
    default boolean trusted() {
        return false;
    }

    /** Operator-authored JSON, e.g. built by the caller's own code rather than a request. */
    static JsonConfig trusted(String json) {
        return new JsonConfig() {
            @Override
            public String json() {
                return json;
            }

            @Override
            public boolean trusted() {
                return true;
            }
        };
    }
}