svn commit: r1790432 - /jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeXml.java

[fs...@apache.org]

Author: fschumacher
Date: Thu Apr  6 17:10:23 2017
New Revision: 1790432

URL: http://svn.apache.org/viewvc?rev=1790432&view=rev
Log:
Add the missing part of pr #288, which is the new function itself.

Contributed by Michael Osipov.

Bugzill Id: 60883

Added:
    jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeXml.java

Added: jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeXml.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeXml.java?rev=1790432&view=auto
==============================================================================
--- jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeXml.java (added)
+++ jmeter/trunk/src/functions/org/apache/jmeter/functions/EscapeXml.java Thu Apr  6 17:10:23 2017
@@ -0,0 +1,89 @@
+/*
+ * 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.jmeter.functions;
+
+import java.util.Collection;
+import java.util.LinkedList;
+import java.util.List;
+
+import org.apache.commons.lang3.StringEscapeUtils;
+import org.apache.jmeter.engine.util.CompoundVariable;
+import org.apache.jmeter.samplers.SampleResult;
+import org.apache.jmeter.samplers.Sampler;
+import org.apache.jmeter.util.JMeterUtils;
+
+/**
+ * <p>Function which escapes the characters in a <code>String</code> using XML 1.0 entities.</p>
+ *
+ * <p>
+ * For example:
+ * </p>
+ * <p><code>"bread" &amp; 'butter'</code></p>
+ * becomes:
+ * <p>
+ * <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;apos;butter&amp;apos;</code>.
+ * </p>
+ *
+ *
+ * @see StringEscapeUtils#escapeXml10(String) (Commons Lang)
+ * @since 3.2
+ */
+public class EscapeXml extends AbstractFunction {
+
+    private static final List<String> desc = new LinkedList<String>();
+
+    private static final String KEY = "__escapeXml"; //$NON-NLS-1$
+
+    static {
+        desc.add(JMeterUtils.getResString("escape_xml_string")); //$NON-NLS-1$
+    }
+
+    private Object[] values;
+
+    public EscapeXml() {
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String execute(SampleResult previousResult, Sampler currentSampler)
+            throws InvalidVariableException {
+
+        String rawString = ((CompoundVariable) values[0]).execute();
+        return StringEscapeUtils.escapeXml10(rawString);
+
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException {
+        checkParameterCount(parameters, 1);
+        values = parameters.toArray();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getReferenceKey() {
+        return KEY;
+    }
+
+    /** {@inheritDoc} */
+    public List<String> getArgumentDesc() {
+        return desc;
+    }
+}