org.sakaiproject.service.framework.session
Interface UsageSession

All Superinterfaces:
Comparable
All Known Implementing Classes:
UsageSessionServiceAdaptor.BaseUsageSession

public interface UsageSession
extends Comparable

UsageSession models an end user's session.

Version:
$Revision: 632 $
Author:
University of Michigan, Sakai Software Development Team

Field Summary
static String MAC_CM
           
static String MAC_IE
          String constants for major browser types
static String MAC_MZ
           
static String MAC_NN
           
static String MAC_SF
           
static String UNKNOWN
           
static String WIN_IE
           
static String WIN_MZ
           
static String WIN_NN
           
 
Method Summary
 String getBrowserId()
          Access a short string describing the class of browser used in this session.
 Time getEnd()
          Access the end time of the session.
 String getId()
          Access the unique id for this session.
 String getIpAddress()
          Access the IP Address from which this session originated.
 String getServer()
          Access the server id which is hosting this session.
 Time getStart()
          Access the start time of the session
 String getUserAgent()
          Access the User Agent string describing the browser used in this session.
 String getUserId()
          Access the user object for this session.
 boolean isClosed()
          Is this session closed?
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

MAC_IE

public static final String MAC_IE
String constants for major browser types

See Also:
Constant Field Values

MAC_NN

public static final String MAC_NN
See Also:
Constant Field Values

MAC_CM

public static final String MAC_CM
See Also:
Constant Field Values

MAC_SF

public static final String MAC_SF
See Also:
Constant Field Values

MAC_MZ

public static final String MAC_MZ
See Also:
Constant Field Values

WIN_IE

public static final String WIN_IE
See Also:
Constant Field Values

WIN_NN

public static final String WIN_NN
See Also:
Constant Field Values

WIN_MZ

public static final String WIN_MZ
See Also:
Constant Field Values

UNKNOWN

public static final String UNKNOWN
See Also:
Constant Field Values
Method Detail

getId

public String getId()
Access the unique id for this session.

Returns:
the unique id for this session.

getServer

public String getServer()
Access the server id which is hosting this session.

Returns:
the server id which is hosting this session.

getUserId

public String getUserId()
Access the user object for this session.

Returns:
the user object for this session.

getIpAddress

public String getIpAddress()
Access the IP Address from which this session originated.

Returns:
the IP Address from which this session originated.

getUserAgent

public String getUserAgent()
Access the User Agent string describing the browser used in this session.

Returns:
the User Agent string describing the browser used in this session.

getBrowserId

public String getBrowserId()
Access a short string describing the class of browser used in this session.

Returns:
the short ID describing the browser used in this session.

isClosed

public boolean isClosed()
Is this session closed?

Returns:
true if the session is closed, false if open.

getStart

public Time getStart()
Access the start time of the session

Returns:
The time the session started.

getEnd

public Time getEnd()
Access the end time of the session.

Returns:
The time the session ended. If still going, this will .equals() the getStart() value.