org.dlese.dpc.logging

Class ClfLogRecord

java.lang.Object

org.dlese.dpc.logging.ClfLogRecord

public class ClfLogRecord
extends java.lang.Object

Represents a single log record created by ClfLogger. Log files may be parsed by calling ClfLogRecord.parse.

Field Summary

Fields

Modifier and Type	Field and Description
int	contentLength The content length of the document returned to the client.
java.lang.String	dleseId If full: DLESE ID of the record returned.
java.lang.String	identity id.
int	numDbRecords Total number of records in the database
int	numSearchResults Number of search results for search requests; 0 otherwise
int	rankNum If search: rank of first result in the displayed page.
java.lang.String	referrer The referrer, but long ago was misspelled it as the "referer" HTTP request header.
java.lang.String	remoteHost Remote host IP number.
java.lang.String	remoteUser The username as which the user has authenticated via password protection.
java.util.Date	requestDateUtc The date and time of request, UTC (GMT) time.
java.lang.String	requestString The request line as it came from the client.
java.lang.String	requestType The DLESE request type: search/full/other.
java.lang.String	serverName The name of the server that received the request.
int	serverPort The port number of the server that received the request.
java.lang.String	userAgent The User_Agent HTTP request header, in quotes.
java.lang.String	xmlString An arbitrary string, generally XML.

Constructor Summary

Constructors

Constructor and Description
ClfLogRecord()

Method Summary

Modifier and Type	Method and Description
static ClfLogRecord	parse(java.lang.String inline, int linenum) Creates a ClfLogRecord by parsing the specified input line.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

remoteHost

public java.lang.String remoteHost

Remote host IP number.

identity

public java.lang.String identity

id. See rfc1413 (obsoletes rfc931) remote logname of the user. Unreliable, seldom used. Usually appears as "-".

remoteUser

public java.lang.String remoteUser

The username as which the user has authenticated via password protection.

requestDateUtc

public java.util.Date requestDateUtc

The date and time of request, UTC (GMT) time. Note: this is the time when the server wrote the log record, not the time extracted from the possibly bogus date header.

requestString

public java.lang.String requestString

The request line as it came from the client. Note: this is reconstructed using HttpServletRequest calls, so there may be slight differences in formatting from the original request string.
Example: "GET /testldap/tldap HTTP/1.1"

contentLength

public int contentLength

The content length of the document returned to the client.

referrer

public java.lang.String referrer

The referrer, but long ago was misspelled it as the "referer" HTTP request header. If unavailable, it appears quoted as "-", not as -.

userAgent

public java.lang.String userAgent

The User_Agent HTTP request header, in quotes. If unavailable, it appears quoted as "-", not as -.

serverName

public java.lang.String serverName

The name of the server that received the request.

serverPort

public int serverPort

The port number of the server that received the request.

requestType

public java.lang.String requestType

The DLESE request type: search/full/other.

numSearchResults

public int numSearchResults

Number of search results for search requests; 0 otherwise

numDbRecords

public int numDbRecords

Total number of records in the database

rankNum

public int rankNum

If search: rank of first result in the displayed page. If full: rank of this result.

dleseId

public java.lang.String dleseId

If full: DLESE ID of the record returned. Otherwise: "-"

xmlString

public java.lang.String xmlString

An arbitrary string, generally XML.

Constructor Detail

ClfLogRecord

public ClfLogRecord()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static ClfLogRecord parse(java.lang.String inline,
                                 int linenum)
                          throws LogException

Creates a ClfLogRecord by parsing the specified input line. Sample use:

        int linenum = 0;
        BufferedReader rdr = new BufferedReader( new FileReader( inname));
        while (true) {
            String inline = rdr.readLine();
            if (inline == null) break;
            linenum++;
            ClfLogRecord rec = ClfLogRecord.parse( inline, linenum);
            System.out.println("\nrecord " + linenum + ":\n" + rec);
        }
        rdr.close();
 

Throws:

LogException