Package org.netxms.client.log
Class Log
java.lang.Object
org.netxms.client.log.Log
Log handle for accessing log on management server
-
Constructor Summary
ConstructorDescriptionLog
(NXCSession session, NXCPMessage msg, String name) Create log object from server's reply to CMD_LOG_OPEN. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Close logGet column object by column name.getColumnDescription
(String columnName) Get description for given column name.int
getColumnIndex
(String columnName) Get index of given columnGet column informationgetName()
Get log name.long
Get number of records available on server after successful query() call.int
Get index of column holding ID of related NetXMS object.Get name of column holding ID of related NetXMS object.getRecordDetails
(long recordId) Get details for specific log record.int
Get index of column holding unique record ID.Get name of column holding unique record ID.boolean
Check if this log has additional fields with detailed information.void
Send query to serverretrieveData
(long startRow, long rowCount) Retrieve log data from server.retrieveData
(long startRow, long rowCount, boolean refresh) Retrieve log data from server.toString()
-
Constructor Details
-
Log
Create log object from server's reply to CMD_LOG_OPEN.- Parameters:
session
- Client sessionmsg
- NXCP message with server's replyname
- log name
-
-
Method Details
-
getName
Get log name.- Returns:
- Log name
-
hasDetailFields
public boolean hasDetailFields()Check if this log has additional fields with detailed information.- Returns:
- true if this log has additional fields with detailed information
-
getColumns
Get column information- Returns:
- the columns
-
getColumnDescription
Get description for given column name.- Parameters:
columnName
- Column name- Returns:
- Column description or null if column with given name does not exist
-
getColumn
Get column object by column name.- Parameters:
columnName
- Column name- Returns:
- Column object or null if column with given name does not exist
-
getColumnIndex
Get index of given column- Parameters:
columnName
- column name- Returns:
- index of given column or -1 if such column does not exist
-
getRecordIdColumnName
Get name of column holding unique record ID.- Returns:
- name of column holding unique record ID
-
getRecordIdColumnIndex
public int getRecordIdColumnIndex()Get index of column holding unique record ID.- Returns:
- index of column holding unique record ID
-
getObjectIdColumnName
Get name of column holding ID of related NetXMS object.- Returns:
- name of column holding ID of related NetXMS object or null
-
getObjectIdColumnIndex
public int getObjectIdColumnIndex()Get index of column holding ID of related NetXMS object.- Returns:
- index of column holding ID of related NetXMS object or -1 if this log does not have related objects
-
query
Send query to server- Parameters:
filter
- Log filter- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
retrieveData
Retrieve log data from server. You must first call query() to prepare data on server.- Parameters:
startRow
- start row to retrieverowCount
- number of rows to retrieve- Returns:
- data set
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
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 retrieverowCount
- number of rows to retrieverefresh
- if set to true, server will reload data from database instead of using cache- Returns:
- data set
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
getNumRecords
public long getNumRecords()Get number of records available on server after successful query() call.- Returns:
- Number of log records available
-
getRecordDetails
Get details for specific log record. Details object will contain values for all columns marked as "details column".- Parameters:
recordId
- log record ID- Returns:
- log record details or null if this log does not have additional fields with detailed information
- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
close
Close log- Throws:
IOException
- if socket I/O error occursNXCException
- if NetXMS server returns an error or operation was timed out
-
toString
-