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