|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.dqp.spi.basic.FileCommandLogger
public class FileCommandLogger
Command logger service provider which logs to a file. The filename must be
supplied as a DQP property, see LOG_FILE_NAME_PROPERTY
.
This implementation is intended purely as an example. It is not intended for a heavy, enterprise load. It is built using an internal java.io.BufferedWriter. Each log entry will be on a new line, and the BufferedWriter is flushed after each line is written. Timestamps are included for each log entry.
Field Summary | |
---|---|
static java.lang.String |
LOG_FILE_NAME_PROPERTY
The property name of the log filename property; name and value must be supplied in DQP properties. |
Constructor Summary | |
---|---|
FileCommandLogger()
|
Method Summary | |
---|---|
void |
close()
This method causes the internal java.io.BufferedWriter to be closed. |
void |
dataSourceCommandEnd(long timestamp,
java.lang.String requestID,
long sourceCommandID,
java.lang.String subTransactionID,
java.lang.String modelName,
java.lang.String connectorBindingName,
java.lang.String sessionID,
java.lang.String principal,
int finalRowCount,
boolean isCancelled,
boolean errorOccurred,
ExecutionContext context)
Logs an entry for data source command ending. |
void |
dataSourceCommandStart(long timestamp,
java.lang.String requestID,
long sourceCommandID,
java.lang.String subTransactionID,
java.lang.String modelName,
java.lang.String connectorBindingName,
java.lang.String sessionID,
java.lang.String principal,
java.lang.String sql,
ExecutionContext context)
Logs an entry for data source command starting. |
void |
initialize(java.util.Properties props)
Initialize this command logger. |
void |
transactionEnd(long timestamp,
java.lang.String transactionID,
java.lang.String sessionID,
java.lang.String principal,
java.lang.String vdbName,
java.lang.String vdbVersion,
boolean isCommit)
Logs an entry for transaction ending. |
void |
transactionStart(long timestamp,
java.lang.String transactionID,
java.lang.String sessionID,
java.lang.String principal,
java.lang.String vdbName,
java.lang.String vdbVersion)
Logs an entry for transaction starting. |
void |
userCommandEnd(long timestamp,
java.lang.String requestID,
java.lang.String transactionID,
java.lang.String sessionID,
java.lang.String principal,
java.lang.String vdbName,
java.lang.String vdbVersion,
int finalRowCount,
boolean isCancelled,
boolean errorOccurred)
Logs an entry for user command ending. |
void |
userCommandStart(long timestamp,
java.lang.String requestID,
java.lang.String transactionID,
java.lang.String sessionID,
java.lang.String applicationName,
java.lang.String principal,
java.lang.String vdbName,
java.lang.String vdbVersion,
java.lang.String sql)
Logs an entry for user command starting. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String LOG_FILE_NAME_PROPERTY
Constructor Detail |
---|
public FileCommandLogger()
Method Detail |
---|
public void initialize(java.util.Properties props)
LOG_FILE_NAME_PROPERTY
property. After this method is called, a java.io.BufferedWriter will be opened to
the file. Any exception in opening the BufferedWriter will be printed to
System.out.
initialize
in interface CommandLoggerSPI
props
- Initialialization propertiesLOG_FILE_NAME_PROPERTY
,
CommandLoggerSPI.initialize(java.util.Properties)
public void close()
close
in interface CommandLoggerSPI
CommandLoggerSPI.close()
public void userCommandStart(long timestamp, java.lang.String requestID, java.lang.String transactionID, java.lang.String sessionID, java.lang.String applicationName, java.lang.String principal, java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String sql)
userCommandStart
in interface CommandLoggerSPI
timestamp
- time in milliseconds marking the start of the commandrequestID
- Unique command ID.transactionID
- Unique transaction ID (optional, may be null)sessionID
- Session ID.applicationName
- name of the user applicationprincipal
- User name.vdbName
- VDB name.vdbVersion
- VDB version.sql
- SQL for the command.com.metamatrix.dqp.spi.CommandLoggerSPI#userCommandStart(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void userCommandEnd(long timestamp, java.lang.String requestID, java.lang.String transactionID, java.lang.String sessionID, java.lang.String principal, java.lang.String vdbName, java.lang.String vdbVersion, int finalRowCount, boolean isCancelled, boolean errorOccurred)
userCommandEnd
in interface CommandLoggerSPI
timestamp
- time in milliseconds marking the end of the command.requestID
- Unique command ID.transactionID
- Unique transaction ID (optional, may be null)sessionID
- Session ID.principal
- User name.vdbName
- VDB name.vdbVersion
- VDB version.finalRowCount
- total rows returned to the user.isCancelled
- true if command was requested to be cancelled, false otherwise.errorOccurred
- true if error occurred, false if status is okay.com.metamatrix.dqp.spi.CommandLoggerSPI#userCommandEnd(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)
public void dataSourceCommandStart(long timestamp, java.lang.String requestID, long sourceCommandID, java.lang.String subTransactionID, java.lang.String modelName, java.lang.String connectorBindingName, java.lang.String sessionID, java.lang.String principal, java.lang.String sql, ExecutionContext context)
dataSourceCommandStart
in interface CommandLoggerSPI
timestamp
- time in milliseconds marking the start of the source command.requestID
- Unique command ID.sourceCommandID
- unique ID of source command, which is also the
ID of the plan node representing that source command.subTransactionID
- Unique subtransaction ID (optional, may be null).modelName
- Name of model.connectorBindingName
- Connector binding name.sessionID
- Session ID.principal
- User name.sql
- SQL for the command.com.metamatrix.dqp.spi.CommandLoggerSPI#dataSourceCommandStart(java.lang.String, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void dataSourceCommandEnd(long timestamp, java.lang.String requestID, long sourceCommandID, java.lang.String subTransactionID, java.lang.String modelName, java.lang.String connectorBindingName, java.lang.String sessionID, java.lang.String principal, int finalRowCount, boolean isCancelled, boolean errorOccurred, ExecutionContext context)
dataSourceCommandEnd
in interface CommandLoggerSPI
timestamp
- time in milliseconds marking the end of the source command.requestID
- Unique command ID.sourceCommandID
- unique ID of source command, which is also the
ID of the plan node representing that source command.subTransactionID
- Unique subtransaction ID (optional, may be null).modelName
- Name of model.connectorBindingName
- Connector binding name.sessionID
- Session ID.principal
- User name.finalRowCount
- Final row count.isCancelled
- true if command was requested to be cancelled, false otherwise.errorOccurred
- true if error occurred, false if status is okay.com.metamatrix.dqp.spi.CommandLoggerSPI#dataSourceCommandEnd(java.lang.String, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, boolean, boolean)
public void transactionStart(long timestamp, java.lang.String transactionID, java.lang.String sessionID, java.lang.String principal, java.lang.String vdbName, java.lang.String vdbVersion)
com.metamatrix.dqp.spi.CommandLoggerSPI#transactionStart(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public void transactionEnd(long timestamp, java.lang.String transactionID, java.lang.String sessionID, java.lang.String principal, java.lang.String vdbName, java.lang.String vdbVersion, boolean isCommit)
com.metamatrix.dqp.spi.CommandLoggerSPI#transactionEnd(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |