Save This Page
Home » jakarta-jmeter-2.3.4_src » org.apache.jmeter.functions » [javadoc | source]
    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *   http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    * 
   17    */
   18   
   19   package org.apache.jmeter.functions;
   20   
   21   import java.util.Collection;
   22   import java.util.LinkedList;
   23   import java.util.List;
   24   
   25   import org.apache.commons.lang.StringEscapeUtils;
   26   import org.apache.jmeter.engine.util.CompoundVariable;
   27   import org.apache.jmeter.samplers.SampleResult;
   28   import org.apache.jmeter.samplers.Sampler;
   29   import org.apache.jmeter.util.JMeterUtils;
   30   
   31   /**
   32    * <p>Function which escapes the characters in a <code>String</code> using HTML entities.</p>
   33    *
   34    * <p>
   35    * For example:
   36    * </p> 
   37    * <p><code>"bread" & "butter"</code></p>
   38    * becomes:
   39    * <p>
   40    * <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>.
   41    * </p>
   42    *
   43    * <p>Supports all known HTML 4.0 entities.
   44    * Note that the commonly used apostrophe escape character (&amp;apos;)
   45    * is not a legal entity and so is not supported). </p>
   46    * 
   47    * @see StringEscapeUtils#escapeHtml(String) (Commons Lang)
   48    */
   49   public class EscapeHtml extends AbstractFunction {
   50   
   51       private static final List desc = new LinkedList();
   52   
   53       private static final String KEY = "__escapeHtml"; //$NON-NLS-1$
   54   
   55       static {
   56           desc.add(JMeterUtils.getResString("escape_html_string")); //$NON-NLS-1$
   57       }
   58   
   59       private Object[] values;
   60   
   61       public EscapeHtml() {
   62       }
   63   
   64       public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
   65               throws InvalidVariableException {
   66   
   67           String rawString = ((CompoundVariable) values[0]).execute();
   68           return StringEscapeUtils.escapeHtml(rawString);
   69   
   70       }
   71   
   72       public synchronized void setParameters(Collection parameters) throws InvalidVariableException {
   73           checkParameterCount(parameters, 1);
   74           values = parameters.toArray();
   75       }
   76   
   77       public String getReferenceKey() {
   78           return KEY;
   79       }
   80   
   81       public List getArgumentDesc() {
   82           return desc;
   83       }
   84   }

Save This Page
Home » jakarta-jmeter-2.3.4_src » org.apache.jmeter.functions » [javadoc | source]