| java.lang.Object
 org.apache.jmeter.protocol.http.util.accesslog.TCLogParser
All known Subclasses: org.apache.jmeter.protocol.http.util.accesslog.SharedTCLogParser,
| TCLogParser | | public class TCLogParser implements LogParser(Code) | | Description:
Currently the parser only handles GET/POST requests. It's easy enough to add
support for other request methods by changing checkMethod. The is a complete
rewrite of a tool I wrote for myself earlier. The older algorithm was basic
and did not provide the same level of flexibility I want, so I wrote a new
one using a totally new algorithm. This implementation reads one line at a
time using BufferedReader. When it gets to the end of the file and the
sampler needs to get more requests, the parser will re-initialize the
BufferedReader. The implementation uses StringTokenizer to create tokens.
The parse algorithm is the following:
- cleans the entry by looking for backslash "\"
- looks to see if GET or POST is in the line
- tokenizes using quotes "
- finds the token with the request method
- gets the string of the token and tokenizes it using space
- finds the first token beginning with slash character
- tokenizes the string using question mark "?"
- get the path from the first token
- returns the second token and checks it for parameters
- tokenizes the string using ampersand "&"
- parses each token to name/value pairs
Extending this class is fairly simple. Most access logs use the same format
starting from the request method. Therefore, changing the implementation of
cleanURL(string) method should be sufficient to support new log formats.
Tomcat uses common log format, so any webserver that uses the format should
work with this parser. Servers that are known to use non standard formats are
IIS and Netscape.
|
| FILTER | | protected Filter FILTER(Code) | | Handles to supporting classes
|
| URL_PATH | | protected String URL_PATH(Code) | | The path to the access log file
|
| decode | | protected boolean decode(Code) | | by default, we probably should decode the parameter values
|
| useFILE | | protected boolean useFILE(Code) | | |
| TCLogParser | | public TCLogParser()(Code) | | |
| TCLogParser | | public TCLogParser(String source)(Code) | |
Parameters:
source - |
| checkMethod | | public boolean checkMethod(String text)(Code) | | The method checks for POST and GET methods currently. The other methods
aren't supported yet.
Parameters:
text - if method is supported |
| checkParamFormat | | public boolean checkParamFormat(String text)(Code) | | Checks the string to see if it contains "&" and "=". If it does, return
true, so that it can be parsed.
Parameters:
text - boolean |
| checkURL | | public boolean checkURL(String url)(Code) | | Checks the string to make sure it has /path/file?name=value format. If
the string doesn't have "?", it will return false.
Parameters:
url - boolean |
| cleanURL | | public String cleanURL(String entry)(Code) | | The method cleans the URL using the following algorithm.
- check for double quotes
- check the request method
- tokenize using double quotes
- find first token containing request method
- tokenize string using space
- find first token that begins with "/"
Example Tomcat log entry:
127.0.0.1 - - [08/Jan/2003:07:03:54 -0500] "GET /addrbook/ HTTP/1.1" 200
1981
Parameters:
entry - cleaned url |
| close | | public void close()(Code) | | |
| convertStringToJMRequest | | public void convertStringToJMRequest(String text, TestElement el)(Code) | | Convert a single line into XML
Parameters:
text - |
| convertStringtoNVPair | | public NVPair[] convertStringtoNVPair(String stringparams)(Code) | | Parse the string parameters into NVPair[] array. Once they are parsed, it
is returned. The method uses parseOneParameter(string) to convert each
pair.
Parameters:
stringparams - |
| decodeParameterValue | | public boolean decodeParameterValue()(Code) | | decode the parameter values is to true by default
if paramter values should be decoded |
| openFile | | public File openFile(String filename)(Code) | | Creates a new File object.
Parameters:
filename - |
| parse | | public int parse(TestElement el, int parseCount)(Code) | | parse the entire file.
boolean success/failure |
| parse | | protected int parse(BufferedReader breader, TestElement el, int parseCount)(Code) | | The method is responsible for reading each line, and breaking out of the
while loop if a set number of lines is given.
Parameters:
breader - |
| parseAndConfigure | | public int parseAndConfigure(int count, TestElement el)(Code) | | parse a set number of lines from the access log. Keep in mind the number
of lines parsed will depend the filter and number of lines in the log.
The method returns the actual lines parsed.
Parameters:
count - lines parsed |
| parseLine | | protected int parseLine(String line, TestElement el)(Code) | | parseLine calls the other parse methods to parse the given text.
Parameters:
line - |
| parseOneParameter | | protected NVPair parseOneParameter(String parameter)(Code) | | Method expects name and value to be separated by an equal sign "=". The
method uses StringTokenizer to make a NVPair object. If there happens to
be more than one "=" sign, the others are ignored. The chance of a string
containing more than one is unlikely and would not conform to HTTP spec.
I should double check the protocol spec to make sure this is accurate.
Parameters:
parameter - to be parsed NVPair |
| parseParameters | | protected Vector parseParameters(String parameters)(Code) | | Method uses StringTokenizer to convert the string into single pairs. The
string should conform to HTTP protocol spec, which means the name/value
pairs are separated by the ampersand symbol "&". Some one could write the
querystrings by hand, but that would be round about and go against the
purpose of this utility.
Parameters:
parameters - Vector |
| setDecodeParameterValues | | public void setDecodeParameterValues(boolean decodeparams)(Code) | | by default decode is set to true. if the parameters shouldn't be
decoded, call the method with false
Parameters:
decodeparams - |
| setFilter | | public void setFilter(Filter filter)(Code) | | Use the filter to include/exclude files in the access logs. This is
provided as a convienance and reduce the need to spend hours cleaning up
log files.
Parameters:
filter - |
| setSourceFile | | public void setSourceFile(String source)(Code) | | Sets the source file.
Parameters:
source - |
| setUseParsedFile | | public void setUseParsedFile(boolean file)(Code) | | Calls this method to set whether or not to use the path in the log. We
may want to provide the ability to filter the log file later on. By
default, the parser uses the file in the log.
Parameters:
file - |
| stripFile | | public String stripFile(String url, TestElement el)(Code) | | Tokenize the URL into two tokens. If the URL has more than one "?", the
parse may fail. Only the first two tokens are used. The first token is
automatically parsed and set at URL_PATH.
Parameters:
url - String parameters |
| tokenize | | public StringTokenizer tokenize(String line, String delim)(Code) | | Parses the line using java.util.StringTokenizer.
Parameters:
line - line to be parsed
Parameters:
delim - delimiter StringTokenizer |
|
|