Package com.nt.udc.ndk.node
Interface LoggerIfc
- All Known Implementing Classes:
AggregatorNode,Asn1FileEINode,CommonProcessorNode,DCNode,DiscardingProcessorNode,DupRemoverNode,EINode,EmptyPartitionedDCNode,FFOINode,FileEINode,FileEnhancerNode,FlatFileEINode,FlexibleAggregatorNode,FtpFileEINode,FtpFileEnhancerNode,GeneralNPLProcessorNode,GenericUdpEINode,GenevaOINode,HCDeduplicatorEP,IPDREIFileNode,IPDREINode,JDBCEINode,JDBCOINode,LDAPEnhancerNode,Logger,MXAggregatorNode,NAREINode,NAROINode,NARSelectorNode,NARXMLOINode,NMinusOneRecordNode,NPLProcessorNode,NPLProcessorNodeMT,OIFtpNode,OINode,PartitionedDCNode,PortalOINode,ProcessorNode,RadiusOINode,SequenceProcessorNode,SoapXmlEINode,Sol42EINode,XMLEIFileNode,XMLEINode,XMLOIFileNode
public interface LoggerIfc
Provides the ability to write messages to the node's log file.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Method Summary
Modifier and TypeMethodDescriptionvoidClears all log messages currently stored against a logger.voidclearStatus(String faultCategory, String specificFault) Clears all log messages with a given fault category, and specific fault type.booleanbooleanvoidlogCritical(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Critical Error message (which is indicated with a red alarm) with the given text.voidvoidDeprecated.voidLogs an informational message (no alarm is generated)voidlogMajor(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Major Error message (which is indicated with a Orange alarm) with the given text.voidlogMinor(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Minor Error message (which is indicated with a yellow alarm) with the given text.voidLogs a trace message (no alarm is generated).voidlogWarning(String message, boolean autoClear, Exception exception) Deprecated.voidlogWarning(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Warning message (which is indicated with a blue alarm) with the given text.
-
Field Details
-
FC_INITIALIZATION
- See Also:
-
FC_CONFIGURATION
- See Also:
-
FC_CONNECTIVITY
- See Also:
-
FC_INVALIDDATA
- See Also:
-
FC_RESOURCES
- See Also:
-
FC_INTERNALERROR
- See Also:
-
FC_SECURITY
- See Also:
-
FC_NODE_CONTROL
- See Also:
-
FC_SERVER_CONTROL
- See Also:
-
FC_UNDEFINED
- See Also:
-
SF_CONF_CHANGE_ERROR
- See Also:
-
SF_CONF_CONFIG_FAIL
- See Also:
-
SF_CONF_INV_NODE_CONF
- See Also:
-
SF_CONF_INV_FTP_CONF
- See Also:
-
SF_CONF_INV_PARAM
- See Also:
-
SF_CONF_INV_PARAM_VAL
- See Also:
-
SF_CONF_INV_REM_DIR
- See Also:
-
SF_CONF_MISSING_PARM
- See Also:
-
SF_CONF_MISSING_PARM2
- See Also:
-
SF_CONF_NM_CONF_ERROR
- See Also:
-
SF_CONF_NO_CONFIG
- See Also:
-
SF_CONF_NO_FTP_INT
- See Also:
-
SF_CONF_NODE_CREATION
- See Also:
-
SF_CONF_NODE_START
- See Also:
-
SF_CONF_NPL_CRITICAL
- See Also:
-
SF_CONF_NPL_ERROR
- See Also:
-
SF_CONF_READ_ERROR
- See Also:
-
SF_CONF_READ_PROPS
- See Also:
-
SF_CONF_SAVE_ERROR
- See Also:
-
SF_CONF_SOCKET_INIT
- See Also:
-
SF_CONF_ERR_NODE_CONF
- See Also:
-
SF_CONF_VER_VALIDATION
- See Also:
-
SF_CONN_INTERFACING_CON_ERR
- See Also:
-
SF_CONN_DEGRADED_ERR
- See Also:
-
SF_CONN_ERROR_TACHYON_USAGE
- See Also:
-
SF_CONN_FAILED_TO_RECEIVE_RESPONSE
- See Also:
-
SF_CONN_INVALID_TACHYON_RECORD
- See Also:
-
SF_CONN_DB_CON_ERR
- See Also:
-
SF_CONN_DB_CON_LOST
- See Also:
-
SF_CONN_ECE_CON_ERR
- See Also:
-
SF_CONN_ERR_NODEINFO
- See Also:
-
SF_CONN_ERR_RCV_DATA
- See Also:
-
SF_CONN_ERR_SEND_ACK
- See Also:
-
SF_CONN_FILE_READ_ERR
- See Also:
-
SF_CONN_FTP_ERROR
- See Also:
-
SF_CONN_FTP_ERROR2
- See Also:
-
SF_CONN_FTP_LOGIN
- See Also:
-
SF_CONN_LDAP_CONNECT
- See Also:
-
SF_CONN_LOST_NM
- See Also:
-
SF_CONN_NM_API_ERR
- See Also:
-
SF_CONN_SNMP_SESS_OPEN_FAIL
- See Also:
-
SF_CONN_POLL_ERR
- See Also:
-
SF_CONN_PDU_NULL
- See Also:
-
SF_CONN_TIMED_OUT
- See Also:
-
SF_DATA_JDBC_DRIVER_ERR
- See Also:
-
SF_DATA_AGGR_ERROR
- See Also:
-
SF_DATA_ATTR_CREATE
- See Also:
-
SF_DATA_ATTR_PARSE
- See Also:
-
SF_DATA_ATTR_SHIFT
- See Also:
-
SF_DATA_CANT_ACK
- See Also:
-
SF_DATA_CANT_ENCODE
- See Also:
-
SF_DATA_CONV_STR_TO_N
- See Also:
-
SF_DATA_CONV_TO_STR
- See Also:
-
SF_DATA_CONVERT_ATTR
- See Also:
-
SF_DATA_DATA_MISSING
- See Also:
-
SF_DATA_ENCODE_ERR
- See Also:
-
SF_DATA_ERR_CREATE
- See Also:
-
SF_DATA_ERR_SEND_ACK
- See Also:
-
SF_DATA_ERROR_IN_NPL
- See Also:
-
SF_DATA_ERROR_ON_ACK
- See Also:
-
SF_DATA_FILE_DATA
- See Also:
-
SF_DATA_FILE_PROC_ERR
- See Also:
-
SF_DATA_FORMAT_ERROR
- See Also:
-
SF_DATA_IE_INVALID
- See Also:
-
SF_DATA_IE_MISSING
- See Also:
-
SF_DATA_INPUT_INVALID
- See Also:
-
SF_DATA_INV_RECORD
- See Also:
-
SF_DATA_KEY_CREATE
- See Also:
-
SF_DATA_MISSING_ATTRS
- See Also:
-
SF_DATA_MSG_TOO_SMALL
- See Also:
-
SF_DATA_MSG_TYPE
- See Also:
-
SF_DATA_NAR_IS_NULL
- See Also:
-
SF_DATA_NO_DATA_FILE
- See Also:
-
SF_DATA_NO_OPT_IE
- See Also:
-
SF_DATA_REC_INCOMP
- See Also:
-
SF_DATA_RECORD_PROC
- See Also:
-
SF_DATA_RECORD_SAVE
- See Also:
-
SF_DATA_SRC_READ_ERR
- See Also:
-
SF_DATA_UNEXP_NAR
- See Also:
-
SF_DATA_UNEXPECTED
- See Also:
-
SF_DATA_VAL_NOT_FOUND
- See Also:
-
SF_DATA_WRONG_DECODER
- See Also:
-
SF_DATA_CANNOT_ENCODE
- See Also:
-
SF_DATA_DATA_EXPIRED
- See Also:
-
SF_DATA_DATA_PROC_ERR
- See Also:
-
SF_DATA_INV_ATTR_NPL
- See Also:
-
SF_DATA_INV_TRAF_VOL
- See Also:
-
SF_DATA_UNABLE_COMPLETE
- See Also:
-
SF_DATA_INV_ATT_TYPE
- See Also:
-
SF_INIT_DB_CON_ERR
- See Also:
-
SF_INIT_DIR_CON_ERR
- See Also:
-
SF_INIT_IO_ERR
- See Also:
-
SF_INIT_NODE_CONFIG
- See Also:
-
SF_INIT_NODE_CREATION
- See Also:
-
SF_INIT_NODE_INIT
- See Also:
-
SF_INIT_NODE_START
- See Also:
-
SF_INIT_REG_ERROR
- See Also:
-
SF_INIT_RULE_LOAD_ERR
- See Also:
-
SF_INIT_SOCKET_CREATE
- See Also:
-
SF_INIT_SOCKET_INIT
- See Also:
-
SF_INIT_LDM
- See Also:
-
SF_INIT_RDM
- See Also:
-
SF_INIT_LDM_RUN
- See Also:
-
SF_INIT_RDM_RUN
- See Also:
-
SF_INT_ERR_ETRACE
- See Also:
-
SF_INT_ERR_EXCEPTION
- See Also:
-
SF_INT_ERR_EXPIRE_ERR
- See Also:
-
SF_INT_ERR_PROC_ERR
- See Also:
-
SF_INT_ERR_FIELD_NULL
- See Also:
-
SF_INT_ERR_SHUTDOWN
- See Also:
-
SF_NC_ERR_IN_NODE
- See Also:
-
SF_NC_ERR_MNG_SERVER
- See Also:
-
SF_NC_ERR_NODE_STATE
- See Also:
-
SF_NC_ERR_PROC_DATA
- See Also:
-
SF_NC_ERR_RESTARTING
- See Also:
-
SF_NC_ERR_STARTING
- See Also:
-
SF_NC_ERR_STOPPING
- See Also:
-
SF_NC_ERR_UNHEALTHY
- See Also:
-
SF_NC_NODE_CONF_ERROR
- See Also:
-
SF_NC_NODE_SHUTDOWN
- See Also:
-
SF_RES_CPU_MAJOR
- See Also:
-
SF_RES_CPU_MINOR
- See Also:
-
SF_RES_CPU_USAGE_ERR
- See Also:
-
SF_RES_DISK_USAGE
- See Also:
-
SF_RES_DISK_CRITICAL
- See Also:
-
SF_RES_DISK_MINOR
- See Also:
-
SF_RES_DISK_STATUS
- See Also:
-
SF_RES_ERR_DATA_READ
- See Also:
-
SF_RES_ERR_DATA_REM
- See Also:
-
SF_RES_ERR_DB_CLOSE
- See Also:
-
SF_RES_ERR_DB_OP
- See Also:
-
SF_RES_ERR_DIR_CLOSE
- See Also:
-
SF_RES_ERR_DIR_CREATE
- See Also:
-
SF_RES_ERR_DIR_DELETE
- See Also:
-
SF_RES_ERR_DIR_PROC
- See Also:
-
SF_RES_ERR_DIR_READ
- See Also:
-
SF_RES_ERR_DIR_WRITE
- See Also:
-
SF_RES_ERR_DEL_ENTRY
- See Also:
-
SF_RES_ERR_ENT_CREATE
- See Also:
-
SF_RES_ERR_FILE_CLOSE
- See Also:
-
SF_RES_ERR_FILE_CREAT
- See Also:
-
SF_RES_ERR_FILE_DEL
- See Also:
-
SF_RES_ERR_FILE_MOVE
- See Also:
-
SF_RES_ERR_FILE_NAME
- See Also:
-
SF_RES_ERR_FILE_OPEN
- See Also:
-
SF_RES_ERR_FILE_PROC
- See Also:
-
SF_RES_ERR_FILE_READ
- See Also:
-
SF_RES_ERR_FILE_REN
- See Also:
-
SF_RES_ERR_FILE_WRITE
- See Also:
-
SF_RES_ERR_IN_TRANS
- See Also:
-
SF_RES_ERR_INST_CLASS
- See Also:
-
SF_RES_ERR_INST_REC
- See Also:
-
SF_RES_ERR_IO_ERR
- See Also:
-
SF_RES_ERR_OPEN_TRANS
- See Also:
-
SF_RES_ERR_READ_DU
- See Also:
-
SF_RES_ERR_SOCK_CLOSE
- See Also:
-
SF_RES_ERR_SOCK_CREAT
- See Also:
-
SF_RES_ERR_SOCK_OPEN
- See Also:
-
SF_RES_ERR_SOCK_WRITE
- See Also:
-
SF_RES_ERR_TABLE_OPEN
- See Also:
-
SF_RES_ERR_TABLE_ACC
- See Also:
-
SF_RES_ERR_TABLE_CLOS
- See Also:
-
SF_RES_ERR_USING_Q
- See Also:
-
SF_RES_NO_LICENSE
- See Also:
-
SF_RES_IS_NULL
- See Also:
-
SF_RES_NODE_STATE_W
- See Also:
-
SF_RES_NODE_STATE_R
- See Also:
-
SF_RES_ERR_TIMER_SCHED
- See Also:
-
SF_RES_ERR_DIR_OPEN
- See Also:
-
SF_RES_MEM_MAJOR
- See Also:
-
SF_RES_MEM_WARNING
- See Also:
-
SF_SEC_NO_USER_AUTH
- See Also:
-
SF_SEC_USER_AUTH_FAIL
- See Also:
-
SF_SEC_USER_CFG_FAIL
- See Also:
-
SF_SRV_CNTRL
- See Also:
-
SF_UND_INTERRUPTED
- See Also:
-
SF_UND_SHUTDOWN_ERR
- See Also:
-
-
Method Details
-
logInfo
Logs an informational message (no alarm is generated)- Parameters:
message- Desired text for the error message to be written into the log file.exception- The exception which causes this alarm
-
logDebug
-
isDebugEnabled
boolean isDebugEnabled() -
isInfoEnabled
boolean isInfoEnabled() -
logTrace
Logs a trace message (no alarm is generated). This message will only be written out if the debugLevel is set appropriately via the node's configuration at runtime.- Parameters:
message- Desired text for the error message to be written into the log file.exception- The exception which causes this exception
-
logCritical
void logCritical(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Critical Error message (which is indicated with a red alarm) with the given text. The Critical severity level indicates that a service affecting condition has occurred and an immediate corrective action is required. Such a severity can be reported, for example, when a managed object becomes totally out of service and its capability must be restored.- Parameters:
faultCategory- A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal ErrorspecificFault- A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).additionalFaultText- Any desirable additional text. The variable information.exception- exception which causes this critical issue.
-
logMajor
void logMajor(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Major Error message (which is indicated with a Orange alarm) with the given text. The Major severity level indicates that a service affecting condition has developed and an urgent corrective action is required. Such a severity can be reported, for example, when there is a severe degradation in the capability of the managed object and its full capability must be restored.- Parameters:
faultCategory- A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal ErrorspecificFault- A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).additionalFaultText- Any desirable additional text. The variable information.exception- Exception which causes this major issue.
-
logMinor
void logMinor(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Minor Error message (which is indicated with a yellow alarm) with the given text. The Minor severity level indicates the existence of a non-service affecting fault condition and that corrective action should be taken in order to prevent a more serious (for example, service affecting) fault. Such a severity can be reported, for example, when the detected alarm condition is not currently degrading the capacity of the managed object.- Parameters:
faultCategory- A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal ErrorspecificFault- A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).additionalFaultText- Any desirable additional text. The variable information.exception- Exception which causes this minor issue
-
logWarning
void logWarning(String faultCategory, String specificFault, String additionalFaultText, Exception exception) Logs a Warning message (which is indicated with a blue alarm) with the given text. The Warning severity level indicates the detection of a potential or impending service affecting fault, before any significant effects have been felt. Action should be taken to further diagnose (if necessary) and correct the problem in order to prevent it from becoming a more serious service affecting fault.- Parameters:
faultCategory- A general category of the error. One of Initialization, Configuration, Connectivity Invalid data, Resources, Internal ErrorspecificFault- A clearly worded description of this fault condition, with NO variable component (i.e. node names, port numbers, time stamps, etc.).additionalFaultText- Any desirable additional text. The variable information.exception- Exception which causes this warning
-
clearStatus
Clears all log messages with a given fault category, and specific fault type. -
clearStatus
void clearStatus()Clears all log messages currently stored against a logger. -
logError
Deprecated.Do NOT use this method for Release 3.3 or later. Logs an Error message (which is indicated with a red alarm) with the given text and clearing capabilities.- Parameters:
message- Desired text for the error message to be written into the log file.autoClear- Indicates whether this condition can be automatically cleared by the system. Iffalse, the alarm must be manually cleared by the user.exception- The exception which causes this alarm.- See Also:
-
logWarning
Deprecated.Do NOT use this method for Release 3.3 or later. Logs a Warning message (which is indicated with a yellow alarm) with the given text and clearing capabilities- Parameters:
message- Desired text for the error message to be written into the log file.autoClear- Indicates whether this condition can be automatically cleared by the system. Iffalse, the alarm must be manually cleared by the user.exception- The exception which causes this alarm- See Also:
-