001/*
002 * Copyright 2015-2022 Transmogrify LLC, 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.pyranid;
018
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.Optional;
023
024/**
025 * Wraps a bound parameter value so Pyranid can mask it in diagnostics while still binding the underlying value normally.
026 * <p>
027 * This is display-only: it does not change what is bound to the database. Pyranid's own diagnostic rendering reads
028 * {@link #getMask()} directly and does not rely on an implementation's {@link Object#toString()} method.
029 * <p>
030 * Implementations should be threadsafe.
031 *
032 * @author <a href="https://www.revetkn.com">Mark Allen</a>
033 * @since 4.4.0
034 */
035@ThreadSafe
036public interface SecureParameter {
037        /**
038         * Gets the value to bind.
039         *
040         * @return the value to bind, or {@link Optional#empty()} if the value is {@code null}
041         */
042        @NonNull
043        Optional<Object> getValue();
044
045        /**
046         * Gets the safe display value Pyranid should render in diagnostics.
047         *
048         * @return the safe display value
049         */
050        @NonNull
051        String getMask();
052}