Package org.netxms.client.log

Class Log

java.lang.Object

org.netxms.client.log.Log

public class Log
extends Object

Log handle for accessing log on management server

Author:

Victor Kirhenshtein

Constructor Summary

Constructors

Constructor	Description
Log(NXCSession session, org.netxms.base.NXCPMessage msg, String name)	Create log object from server's reply to CMD_LOG_OPEN.

Method Summary

Modifier and Type	Method	Description
void	close()	Close log
protected void	finalize()
LogColumn	getColumn(String columnName)	Get column object by column name.
String	getColumnDescription(String columnName)	Get description for given column name.
Collection<LogColumn>	getColumns()	Get column information
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.
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,
           org.netxms.base.NXCPMessage msg,
           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 String getName()

Get log name.

Returns:

Log name

getColumns

public Collection<LogColumn> getColumns()

Get column information

Returns:

the columns

getColumnDescription

public String getColumnDescription(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(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 IOException,
                  NXCException

Send query to server

Parameters:

filter - Log filter

Throws:

IOException

NXCException

retrieveData

public Table retrieveData(long startRow,
                          long rowCount)
                   throws 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:

IOException

NXCException

retrieveData

public Table retrieveData(long startRow,
                          long rowCount,
                          boolean refresh)
                   throws 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:

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 IOException,
                  NXCException

Close log

Throws:

IOException - if socket I/O error occurs

NXCException - if NetXMS server returns an error or operation was timed out

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object