001/*-
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.model.api.annotation;
021
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * This annotation should be added to any {@link ca.uhn.fhir.model.api.IModelJson}
029 * model fields
030 * that contain a password or other credentials. Data in such a field should not be
031 * serialized back to users.
032 *
033 * Note that there is not yet any global automatic processing for this annotation.
034 * Perhaps in the future.
035 */
036@Retention(RetentionPolicy.RUNTIME)
037@Target(ElementType.FIELD)
038public @interface PasswordField {}