public class OliDiskLogger extends AbstractMessageLogger
The file created will be XML within XML. See the power point document for the DTD for details.
CLOSE_ROOT_NODE, ENCODING_ISO_8859_1, ENCODING_UTF8, INFO_TYPE, PROD_URL, QA_URL
Constructor and Description |
---|
OliDiskLogger(edu.cmu.oli.log.client.DiskLogger diskLogger,
java.lang.String encoding)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the file stream.
|
static OliDiskLogger |
create(java.lang.String fileName)
Create the message logger.
|
static OliDiskLogger |
create(java.lang.String fileName,
java.lang.String encoding)
Create the message logger.
|
static java.lang.String |
getDefaultFilename()
Return the default filename.
|
boolean |
log(Message message)
Logs a message to the previously given file.
|
boolean |
log(Message message,
java.util.Date timeStamp)
Logs a message with a new time stamp.
|
boolean |
log(java.lang.String authToken,
Message message)
Logs a message with an authentication token.
|
boolean |
log(java.lang.String authToken,
Message message,
java.util.Date timeStamp)
Logs a message with a new time stamp, and an authentication token.
|
void |
logSession(java.lang.String userName,
java.lang.String sessionId)
Log a SessionLog record.
|
getCloseXml, getOpenXml, getOpenXmlSchemaType
public OliDiskLogger(edu.cmu.oli.log.client.DiskLogger diskLogger, java.lang.String encoding)
diskLogger
- the OLI disk loggerencoding
- the encoding to be indicated at the top of the XMLpublic static OliDiskLogger create(java.lang.String fileName)
fileName
- the file namepublic static OliDiskLogger create(java.lang.String fileName, java.lang.String encoding)
fileName
- the file nameencoding
- the encoding to be indicated at the top of the XMLpublic boolean log(Message message)
message
- the message to log to the filepublic boolean log(java.lang.String authToken, Message message)
message
- the message to logauthToken
- the authentication token needed for authenticated logging (OLI servers)public boolean log(Message message, java.util.Date timeStamp)
message
- the message to logtimeStamp
- the new time stamp to usepublic boolean log(java.lang.String authToken, Message message, java.util.Date timeStamp)
message
- the message to logtimeStamp
- the new time stamp to useauthToken
- the authentication token needed for authenticated logging (OLI servers)public void logSession(java.lang.String userName, java.lang.String sessionId)
userName
- the user namesessionId
- the session idSessionLog
public void close()
public static java.lang.String getDefaultFilename()
Copyright (c) 2015 - Pittsburgh Science of Learning Center