org.netxms.client.log
Class Log

java.lang.Object
  extended by org.netxms.client.log.Log

public class Log
extends java.lang.Object

Log handle for accessing log on management server

Author:
Victor Kirhenshtein

Constructor Summary
Log(NXCSession session, NXCPMessage msg, java.lang.String name)
          Create log object from server's reply to CMD_LOG_OPEN.
 
Method Summary
 void close()
          Close log
protected  void finalize()
           
 LogColumn getColumn(java.lang.String columnName)
          Get column object by column name.
 java.lang.String getColumnDescription(java.lang.String columnName)
          Get description for given column name.
 java.util.Collection<LogColumn> getColumns()
          Get column information
 java.lang.String getName()
          Get log name.
 long getNumRecords()
          Get number of records available on server after successful query() call.
 void query(LogFilter filter)
          Send query to server
 Table retrieveData(long startRow, long rowCount)
          Retrieve log data from server.
 Table retrieveData(long startRow, long rowCount, boolean refresh)
          Retrieve log data from server.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Log

public Log(NXCSession session,
           NXCPMessage msg,
           java.lang.String name)
Create log object from server's reply to CMD_LOG_OPEN.

Parameters:
session - Client session
msg - NXCP message with server's reply
Method Detail

getName

public java.lang.String getName()
Get log name.

Returns:
Log name

getColumns

public java.util.Collection<LogColumn> getColumns()
Get column information

Returns:
the columns

getColumnDescription

public java.lang.String getColumnDescription(java.lang.String columnName)
Get description for given column name.

Parameters:
columnName - Column name
Returns:
Column description or null if column with given name does not exist

getColumn

public LogColumn getColumn(java.lang.String columnName)
Get column object by column name.

Parameters:
columnName - Column name
Returns:
Column object or null if column with given name does not exist

query

public void query(LogFilter filter)
           throws java.io.IOException,
                  NXCException
Send query to server

Parameters:
filter - Log filter
Throws:
java.io.IOException
NXCException

retrieveData

public Table retrieveData(long startRow,
                          long rowCount)
                   throws java.io.IOException,
                          NXCException
Retrieve log data from server. You must first call query() to prepare data on server.

Parameters:
startRow - start row to retrieve
rowCount - number of rows to retrieve
Returns:
data set
Throws:
java.io.IOException
NXCException

retrieveData

public Table retrieveData(long startRow,
                          long rowCount,
                          boolean refresh)
                   throws java.io.IOException,
                          NXCException
Retrieve log data from server. You must first call query() to prepare data on server.

Parameters:
startRow - start row to retrieve
rowCount - number of rows to retrieve
refresh - if set to true, server will reload data from database instead of using cache
Returns:
data set
Throws:
java.io.IOException
NXCException

getNumRecords

public long getNumRecords()
Get number of records available on server after successful query() call.

Returns:
Number of log records available

close

public void close()
           throws java.io.IOException,
                  NXCException
Close log

Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2013. All Rights Reserved.