be.yami.web.apache

Class ApacheUserSessionBuilder

java.lang.Object

be.yami.SequenceBuilder<ApacheUserSession,ApacheUserRequest>

be.yami.web.apache.ApacheUserSessionBuilder

public class ApacheUserSessionBuilder
extends SequenceBuilder<ApacheUserSession,ApacheUserRequest>

This class is used to process Apache user sessions from an Apache web log. The default usage of this class is:

 SequenceProcessor<ApacheUserSession> listener;
 EntryFilter<ApacheUserRequest> includeFilter;
 EntryFilter<ApacheUserRequest> excludeFilter;
 // ...
 newInstance().logFormat(ApacheLogFormatPatternBuilder.COMMON_LOG_FORMAT)
                .sessionTimeout(ApacheUserSessionBuilder.DEFAULT_TIMEOUT)
                .include(includeFilter)
                .exclude(excludeFilter)
                .addListener(listener)
                .buildSessions(new FileInputStream("apache-web.log"));
 

Author:

Xavier Devroey - xavier.devroey@unamur.be

See Also:

ApacheUserSession, ApacheLogFormatPatternBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT The default timeout for the sessions.

Method Summary

Modifier and Type	Method and Description
void	buildSessions(InputStream input) Build the sequences from the different entry of the InputStream.
ApacheUserSessionBuilder	logFormat(String logFormat) Specify the log format to use.
static ApacheUserSessionBuilder	newInstance() Returns a new instance of this class.
ApacheUserSessionBuilder	sessionTimeout(long timeout) Set the timeout to consider for the user sessions.

Methods inherited from class be.yami.SequenceBuilder

addListener, exclude, include, isAcceptedEntry, sequenceCompleted

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

The default timeout for the sessions.

See Also:

Constant Field Values

Method Detail

newInstance

public static ApacheUserSessionBuilder newInstance()

Returns a new instance of this class.

Returns:

A fresh instance of this class.

logFormat

public ApacheUserSessionBuilder logFormat(String logFormat)

Specify the log format to use. Default value is ApacheLogFormatPatternBuilder.COMMON_LOG_FORMAT.

Parameters:

logFormat - The new log format to use.

Returns:

This object.

sessionTimeout

public ApacheUserSessionBuilder sessionTimeout(long timeout)

Set the timeout to consider for the user sessions. Default is ApacheUserSessionBuilder.DEFAULT_TIMEOUT

Parameters:

timeout - The new timeout.

Returns:

This object.

buildSessions

public void buildSessions(InputStream input)
                   throws SessionBuildException

Description copied from class: SequenceBuilder

Build the sequences from the different entry of the InputStream. Each time a sequence is built, the listeners are notified. All the entries in the builded sequence satisfy isAcceptedEntry(Entry).

Specified by:

buildSessions in class SequenceBuilder<ApacheUserSession,ApacheUserRequest>

Parameters:

input - The InputStream to read.

Throws:

SessionBuildException - If an exception occurs during the building of the sessions.