001    /*
002     * Copyright (c) 2007-2014 Concurrent, Inc. All Rights Reserved.
003     *
004     * Project and contact information: http://www.cascading.org/
005     *
006     * This file is part of the Cascading project.
007     *
008     * Licensed under the Apache License, Version 2.0 (the "License");
009     * you may not use this file except in compliance with the License.
010     * You may obtain a copy of the License at
011     *
012     *     http://www.apache.org/licenses/LICENSE-2.0
013     *
014     * Unless required by applicable law or agreed to in writing, software
015     * distributed under the License is distributed on an "AS IS" BASIS,
016     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017     * See the License for the specific language governing permissions and
018     * limitations under the License.
019     */
020    
021    package cascading.management.annotation;
022    
023    import java.lang.annotation.ElementType;
024    import java.lang.annotation.Retention;
025    import java.lang.annotation.RetentionPolicy;
026    import java.lang.annotation.Target;
027    
028    /**
029     * PropertySanitizer is an annotation to be used in conjunction with a Property annotation to sanitize values containing
030     * sensitive information.
031     * <p/>
032     * For example, if a Property contains an URL, user names, password, API keys etc, one can supply a or a custom class
033     * implementing the {@link Sanitizer} interface to remove or replace any sensitive data.
034     * <p/>
035     * The Sanitizer implementation has the option to provide a different value for each level of
036     * {@link cascading.management.annotation.Visibility}.
037     * <p/>
038     * For example, if the raw value is an URL, the {@code PUBLIC} sanitized value may just include the URL path. The
039     * {@code PROTECTED} value may retain the query string, and the {@code PRIVATE} value may retain the scheme and
040     * domain name of the server.
041     * <p/>
042     * If a Sanitizer returns {@code null}, no value will be available for that visibility.
043     */
044    @Retention(RetentionPolicy.RUNTIME)
045    @Target({ElementType.METHOD, ElementType.FIELD})
046    public @interface PropertySanitizer
047      {
048      String value();
049      }