001/*
002 * Copyright (c) 2016-2017 Chris K Wensel <chris@wensel.net>. All Rights Reserved.
003 * Copyright (c) 2007-2017 Xplenty, Inc. All Rights Reserved.
004 *
005 * Project and contact information: http://www.cascading.org/
006 *
007 * This file is part of the Cascading project.
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 */
021
022package cascading.management.annotation;
023
024import java.lang.annotation.ElementType;
025import java.lang.annotation.Retention;
026import java.lang.annotation.RetentionPolicy;
027import java.lang.annotation.Target;
028
029/**
030 * PropertySanitizer is an annotation to be used in conjunction with a Property annotation to sanitize values containing
031 * sensitive information.
032 * <p>
033 * For example, if a Property contains an URL, user names, password, API keys etc, one can supply a or a custom class
034 * implementing the {@link Sanitizer} interface to remove or replace any sensitive data.
035 * <p>
036 * The Sanitizer implementation has the option to provide a different value for each level of
037 * {@link cascading.management.annotation.Visibility}.
038 * <p>
039 * For example, if the raw value is an URL, the {@code PUBLIC} sanitized value may just include the URL path. The
040 * {@code PROTECTED} value may retain the query string, and the {@code PRIVATE} value may retain the scheme and
041 * domain name of the server.
042 * <p>
043 * If a Sanitizer returns {@code null}, no value will be available for that visibility.
044 */
045@Retention(RetentionPolicy.RUNTIME)
046@Target({ElementType.METHOD, ElementType.FIELD})
047public @interface PropertySanitizer
048  {
049  String value();
050  }