Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.stats
Class NNTPReadStatSession

java.lang.Object
  extended by com.jivesoftware.base.stats.ReadStatSession
      extended by com.jivesoftware.forum.stats.NNTPReadStatSession
All Implemented Interfaces:
java.io.Serializable

public class NNTPReadStatSession
extends ReadStatSession

Encapsulates a series of NNTP read stat occurrences.

It is assumed the NNTP session is created when the client connects and ends when the client disconnects.

See Also:
Serialized Form

Constructor Summary
NNTPReadStatSession()
           
NNTPReadStatSession(java.lang.String visitorID, java.util.Date creationDate, java.util.Date endDate, java.lang.String ip, java.lang.String country)
           
NNTPReadStatSession(java.lang.String visitorID, java.util.Date creationDate, java.lang.String ip, java.lang.String country)
           
 
Method Summary
 long getBytesReceived()
          Returns the total bytes transferred during the session or -1 if it is unknown.
 long getBytesSent()
          Returns the total bytes sent during the session or -1 if it is unknown.
 java.lang.String getCountry()
          The country code (2 letter standard code, ie US, UK, FR, DE, etc) or null if it is unknown.
 java.util.Date getEndDate()
          Returns the date the NNTP read stat session ended (this would be when the client disconnects).
 java.lang.String getIP()
          Returns the IP this session was created under or null if the IP could not be determined.
 void setEndDate(java.util.Date endDate)
           
 void updateBytesReceived(long newBytesReceived)
          Updates the total bytes transferred in this session.
 void updateBytesSent(long newBytesSent)
          Updates the total bytes sent in this session.
 
Methods inherited from class com.jivesoftware.base.stats.ReadStatSession
getCreationDate, getSessionID, getVisitorID, setSessionID, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NNTPReadStatSession

public NNTPReadStatSession()

NNTPReadStatSession

public NNTPReadStatSession(java.lang.String visitorID,
                           java.util.Date creationDate,
                           java.lang.String ip,
                           java.lang.String country)

NNTPReadStatSession

public NNTPReadStatSession(java.lang.String visitorID,
                           java.util.Date creationDate,
                           java.util.Date endDate,
                           java.lang.String ip,
                           java.lang.String country)
Method Detail

getEndDate

public java.util.Date getEndDate()
Returns the date the NNTP read stat session ended (this would be when the client disconnects).

Returns:
the date the NNTP read stat session ended.

setEndDate

public void setEndDate(java.util.Date endDate)

getBytesReceived

public long getBytesReceived()
Returns the total bytes transferred during the session or -1 if it is unknown.

Returns:
the total bytes transferred during the session or -1 if it is unknown.

getIP

public java.lang.String getIP()
Returns the IP this session was created under or null if the IP could not be determined.

Returns:
the IP associated with this session or null if the IP is unknown.

getCountry

public java.lang.String getCountry()
The country code (2 letter standard code, ie US, UK, FR, DE, etc) or null if it is unknown.

Returns:
the 2 letter country code or null if it can not be determined.

updateBytesReceived

public void updateBytesReceived(long newBytesReceived)
Updates the total bytes transferred in this session.

Parameters:
newBytesReceived - the new amount of bytes transferred.

getBytesSent

public long getBytesSent()
Returns the total bytes sent during the session or -1 if it is unknown.

Returns:
the total bytes sent during the session or -1 if it is unknown.

updateBytesSent

public void updateBytesSent(long newBytesSent)
Updates the total bytes sent in this session.

Parameters:
newBytesSent - the new amount of bytes sent.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.