This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.xss-2.0.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-xss.git
commit 3ee1147dccca52d9c82472047800e2e9583368b9 Author: Karl Pauls <[email protected]> AuthorDate: Fri Apr 28 09:24:51 2017 +0000 Remove the JSONUtil class altogether as we don't want to migrate it to the new javax.json (SLING-6685). git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/xss@1793024 13f79535-47bb-0310-9956-ffa450edef68 --- src/main/java/org/apache/sling/xss/JSONUtil.java | 146 ----------------------- 1 file changed, 146 deletions(-) diff --git a/src/main/java/org/apache/sling/xss/JSONUtil.java b/src/main/java/org/apache/sling/xss/JSONUtil.java deleted file mode 100644 index 0065027..0000000 --- a/src/main/java/org/apache/sling/xss/JSONUtil.java +++ /dev/null @@ -1,146 +0,0 @@ -/******************************************************************************* - * Licensed to the Apache Software Foundation (ASF) under one or - * more contributor license agreements. See the NOTICE file - * distributed with this work for additional information regarding - * copyright ownership. The ASF licenses this file to you under the - * Apache License, Version 2.0 (the "License"); you may not use - * this file except in compliance with the License. You may obtain - * a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 Unless required by - * applicable law or agreed to in writing, software distributed - * under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions - * and limitations under the License. - ******************************************************************************/ -package org.apache.sling.xss; - -import javax.json.JsonObjectBuilder; -import javax.json.stream.JsonGenerator; - -/** - * JSON utilities - * <p> - * Support for handling xss protected values with JSON objects and JSON writers. - */ -public final class JSONUtil { - - /** - * Key suffix for XSS protected properties - */ - public static final String KEY_SUFFIX_XSS = "_xss"; - - // no instantiation - private JSONUtil() { - } - - /** - * Puts a xss protected value into a JSON object. - * The value is put under the provided key. - * - * @param object JSON object - * @param key Key to write - * @param value Value to write - * @param xss XSS protection filter - * @throws JsonException If value could not be put into the object - * @throws NullPointerException If xss protection filter is <code>null</code> - */ - public static void putProtected(final JsonObjectBuilder object, final String key, final String value, final XSSFilter xss) { - final String xssValue = xss.filter(ProtectionContext.PLAIN_HTML_CONTENT, value); - object.add(key, xssValue); - } - - /** - * Puts a value into a JSON object - * In addition, the xss protected value is put under the provided key appended by {@link #KEY_SUFFIX_XSS} - * - * @param object JSON object - * @param key Key to write - * @param value Value to write - * @param xss XSS protection filter - * @throws JsonException If value could not be put into the object - * @throws NullPointerException If xss protection filter is <code>null</code> - */ - public static void putWithProtected(final JsonObjectBuilder object, final String key, final String value, final XSSFilter xss) { - putProtected(object, key + KEY_SUFFIX_XSS, value, xss); - object.add(key, value); - } - - /** - * Writes a xss protected value into a JSON writer. - * The value is written under the provided key. - * - * @param writer JSON writer - * @param key Key to write - * @param value Value to write - * @param xss XSS protection filter - * @throws JSONException If value could not be written - * @throws NullPointerException If xss protection filter is <code>null</code> - */ - public static void writeProtected(final JsonGenerator writer, final String key, final String value, final XSSFilter xss) { - final String xssValue = xss.filter(ProtectionContext.PLAIN_HTML_CONTENT, value); - writer.write(key, xssValue); - } - - /** - * Writes a xss protected value array into a JSON writer. - * The values are written under the provided key. - * - * @param writer The JSON writer. - * @param key Key to use. - * @param values The value arrays. - * @param xss The XSS protection filter. - * @throws JsonException If value could not be written - * @throws NullPointerException If xss protection filter is <code>null</code> - */ - public static void writeProtected(JsonGenerator writer, String key, - String[] values, XSSFilter xss) { - writer.writeStartArray(key); - for (String value : values) { - String xssValue = xss.filter(ProtectionContext.PLAIN_HTML_CONTENT, value); - writer.write(xssValue); - } - writer.writeEnd(); - } - - /** - * Writes a value into a JSON write - * In addition, the xss protected value is written with the provided key appended by {@link #KEY_SUFFIX_XSS} - * - * @param writer JSON writer - * @param key Key to write - * @param value Value to write - * @param xss XSS protection filter - * @throws JSONException If value could not be written - * @throws NullPointerException If xss protection filter is <code>null</code> - */ - public static void writeWithProtected(final JsonGenerator writer, final String key, final String value, final XSSFilter xss) { - writeProtected(writer, key + KEY_SUFFIX_XSS, value, xss); - writer.write(key, value); - } - - /** - * Writes a value array into a JSON write. - * In addition, the xss protected values are written with the provided key - * appended by {@link #KEY_SUFFIX_XSS} - * - * @param writer The JSON writer to use. - * @param key The key to write. - * @param values The value array. - * @param xss The xss protection filter. - * @throws JSONException If value could not be written - * @throws NullPointerException If xss protection filter is <code>null</code> - */ - public static void writeWithProtected(JsonGenerator writer, String key, - String[] values, XSSFilter xss) { - - writeProtected(writer, key + KEY_SUFFIX_XSS, values, xss); - // and the non-xss array variant - writer.writeStartArray(key); - for (String value : values) { - writer.write(value); - } - writer.writeEnd(); - } -} -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
