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 024/** 025 * Sanitizer is an interface to be used in conjunction with {@link PropertySanitizer}. 026 * <p> 027 * The Sanitizer implementation has the option to provide a different value for each level of 028 * {@link cascading.management.annotation.Visibility}. 029 * <p> 030 * For example, if the raw value is an URL, the {@code PUBLIC} sanitized value may just include the URL path. The 031 * {@code PROTECTED} value may retain the query string, and the {@code PRIVATE} value may retain the scheme and 032 * domain name of the server. 033 * <p> 034 * If a Sanitizer returns {@code null}, no value will be available for that requested visibility. 035 * <p> 036 * Implementations of this interface must provide a default no-args Constructor. 037 */ 038public interface Sanitizer 039 { 040 /** 041 * Applies the custom sanitization to the given value for the given visibility. 042 * 043 * @param visibility The visibility of the property value. 044 * @param value The value to sanitize. 045 * @return A sanitized version of the value. 046 */ 047 String apply( Visibility visibility, Object value ); 048 }