You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jmeter-dev@jakarta.apache.org by se...@apache.org on 2004/01/16 19:36:21 UTC
cvs commit: jakarta-jmeter/src/functions/org/apache/jmeter/functions LogFunction.java
sebb 2004/01/16 10:36:21
Added: src/functions/org/apache/jmeter/functions LogFunction.java
Log:
Function to put a message in the log file
Revision Changes Path
1.1 jakarta-jmeter/src/functions/org/apache/jmeter/functions/LogFunction.java
Index: LogFunction.java
===================================================================
/*
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2004 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache JMeter" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* "Apache JMeter", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jmeter.functions;
import java.io.Serializable;
import java.util.Collection;
import java.util.LinkedList;
import java.util.List;
import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
import org.apache.log.Priority;
/**
* Function to log a message
*
* Parameters:
* - string
* - log level (optional; defaults to INFO; or DEBUG if unrecognised)
* - throwable message (optional)
*
* Returns:
* - the input string
*
* @author sebb AT apache DOT org
* @version $Revision: 1.1 $ Updated: $Date: 2004/01/16 18:36:21 $
*/
public class LogFunction extends AbstractFunction implements Serializable
{
private static Logger log = LoggingManager.getLoggerForClass();
private static final List desc = new LinkedList();
private static final String KEY = "__log";
// Number of parameters expected - used to reject invalid calls
private static final int MIN_PARAMETER_COUNT = 1;
private static final int MAX_PARAMETER_COUNT = 3;
static {
desc.add("String to be logged");
desc.add("Log level (default INFO)");
desc.add("Throwable text (optional)");
}
private static final String DEFAULT_PRIORITY = "INFO"; //$NON-NLS-1$
private Object[] values;
public LogFunction()
{
}
public Object clone()
{
return new LogFunction();
}
public synchronized String execute(
SampleResult previousResult,
Sampler currentSampler)
throws InvalidVariableException
{
String stringToLog = ((CompoundVariable) values[0]).execute();
String priorityString;
if (values.length > 1){ // We have a default
priorityString= ((CompoundVariable) values[1]).execute();
if (priorityString.length()==0) priorityString= DEFAULT_PRIORITY;
} else {
priorityString = DEFAULT_PRIORITY;
}
Throwable t=null;
if (values.length > 2){ // Throwable wanted
t = new Throwable(((CompoundVariable) values[2]).execute());
}
// N.B. if the string is not recognised, DEBUG is assumed
Priority p = Priority.getPriorityForName(priorityString);
log.log(p,stringToLog,t);
return stringToLog;
}
public void setParameters(Collection parameters)
throws InvalidVariableException
{
values = parameters.toArray();
if ((values.length < MIN_PARAMETER_COUNT)
|| (values.length > MAX_PARAMETER_COUNT))
{
throw new InvalidVariableException(
"Parameter Count not between "
+ MIN_PARAMETER_COUNT
+ " & "
+ MAX_PARAMETER_COUNT);
}
}
public String getReferenceKey()
{
return KEY;
}
public List getArgumentDesc()
{
return desc;
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org