be.yami.web

Class UserSession<E extends UserRequest>

java.lang.Object

be.yami.web.UserSession<E>

Type Parameters:

E - The type of user requests contained in the session.

All Implemented Interfaces:

Sequence<E>, Iterable<E>

Direct Known Subclasses:

ApacheUserSession

public class UserSession<E extends UserRequest>
extends Object
implements Sequence<E>

Represents a sequence of UserRequests. Each request follow the previous one in time.

Author:

Xavier Devroey - xavier.devroey@unamur.be

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	endTime The end time of the sequence.
protected Date	startTime The start time of the sequence.

Constructor Summary

Constructors

Constructor and Description
UserSession(String userId) Creates a new session for the user identified by the given id.

Method Summary

Modifier and Type	Method and Description
void	enqueue(E request) Add a new request to the session.
Date	getEndTime() Returns the end time of the sequence.
Date	getStartTime() Returns the start time of the sequence.
String	getUserId() Returns the id of the user who issued this request.
Iterator<E>	iterator()
void	setUserId(String userId) Set the id of the user who issued this request.
int	size() Returns the number of requests in the session.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

startTime

protected Date startTime

The start time of the sequence. Corresponds to the time of the first request of the sequence.

endTime

protected Date endTime

The end time of the sequence. Corresponds to the time of the last request of the sequence.

Constructor Detail

UserSession

public UserSession(String userId)

Creates a new session for the user identified by the given id.

Parameters:

userId - The id of the user issuing the requests of the session.

Method Detail

getUserId

public String getUserId()

Returns the id of the user who issued this request.

Returns:

The id of the user who issued this request.

setUserId

public void setUserId(String userId)

Set the id of the user who issued this request.

Parameters:

userId - The new user's id.

getStartTime

public Date getStartTime()

Returns the start time of the sequence. Corresponds to the time of the first request of the sequence.

Returns:

The start time of the sequence.

getEndTime

public Date getEndTime()

Returns the end time of the sequence. Corresponds to the time of the last request of the sequence.

Returns:

The end time of the sequence.

size

public int size()

Returns the number of requests in the session.

Specified by:

size in interface Sequence<E extends UserRequest>

Returns:

The number of requests in the session.

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E extends UserRequest>

enqueue

public void enqueue(E request)

Add a new request to the session. Requests have to be added using chronological order in the session.

Parameters:

request - The request to add. Has to be later than the last request added to the session (request.getTime() > this.getEndTime() ).