001    /*
002     * Copyright (c) 2007-2015 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     * PropertyRegexSanitizer is an annotation to be used in conjunction with a Property annotation to sanitize values containing
030     * sensitive information with a given regular expression.
031     * <p/>
032     * For example, if a Property contains an URL, user names, password, API keys etc, one can supply a regular expression
033     * (regex) to remove the sensitive parts.
034     * <p/>
035     * Unlike the {@link cascading.management.annotation.PropertySanitizer} annotation, the regular expression is applied
036     * once and the result is stored as the value for the declared {@link cascading.management.annotation.Visibility}
037     * for the property. See PropertySanitizer if different values should be returned for each Visibility type.
038     */
039    @Retention(RetentionPolicy.RUNTIME)
040    @Target({ElementType.METHOD, ElementType.FIELD})
041    public @interface PropertyRegexSanitizer
042      {
043      String value();
044      }