001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.commons.secret;
018
019import org.apache.juneau.commons.settings.*;
020
021/**
022 * Marker specialization of {@link PropertySource} whose values are sensitive and must be redacted anywhere they
023 * would otherwise be surfaced — a {@code toString()}, a settings dump, or a log line.
024 *
025 * <p>
026 * This marker is the seam that keeps the opt-in {@link SecretStorePropertySource} bridge from leaking bridged
027 * secrets: a dump/log path that iterates {@link PropertySource}s should test
028 * {@code src instanceof SensitivePropertySource} and redact rather than print resolved values.  The marker is scoped
029 * to the bridge on purpose &mdash; it is not forced across all of {@code Settings}.
030 *
031 * @since 10.0.0
032 */
033public interface SensitivePropertySource extends PropertySource {}