001/*
002 * (C) Copyright 2017 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Funsho David
018 *
019 */
020
021package org.nuxeo.ecm.core.filter;
022
023import org.nuxeo.ecm.core.api.DocumentModel;
024
025/**
026 * This service filters disallowed characters in strings and document properties.
027 * <p>
028 * Disallowed characters are control characters that could prevent XML validation or in some cases database writes.
029 *
030 * @since 9.1
031 */
032public interface CharacterFilteringService {
033
034    /**
035     * Removes all disallowed characters from the input value.
036     *
037     * @param value the value to filter
038     * @return the filtered value
039     */
040    String filter(String value);
041
042    /**
043     * Removes all disallowed characters from the dirty document properties.
044     *
045     * @param docModel the document to filter
046     */
047    void filter(DocumentModel docModel);
048
049}