jet.server.api.rmi.admin.cfg.logger
Interface RemoteConfigNTLogAppender

All Superinterfaces:

java.rmi.Remote, RemoteConfigAppender

public interface RemoteConfigNTLogAppender
extends RemoteConfigAppender

The RemoteConfigNTLogAppender takes charge of managing NTEvent log appender specific properties.

Since:

V8.1

Field Summary

Fields inherited from interface jet.server.api.rmi.admin.cfg.logger.RemoteConfigAppender

DST_CONSOLE, DST_DAILY_ROLLING_FILE, DST_FILE, DST_LF5, DST_NTLOG, DST_ROLLING_FILE, DST_SOCKET, DST_SYSLOG, DST_TELNET, LAYOUT_HTML, LAYOUT_PATTERN, LAYOUT_SIMPLE, LAYOUT_TTCC, LAYOUT_XML, LAYOUTS, THRESHOLD_ALL, THRESHOLD_DEBUG, THRESHOLD_ERROR, THRESHOLD_FATAL, THRESHOLD_INFO, THRESHOLD_OFF, THRESHOLD_WARN, THRESHOLDS

Method Summary

java.lang.String	getLayout() get the layout of the console appender.
java.lang.String	getPatternConversion() get the pattern conversion of the console appender.
java.lang.String	getSource() get the NT eventlog's source name.
void	setLayout(java.lang.String layout) Set the layout of the console appender.
void	setPatternConversion(java.lang.String pattern) set the appender's pattern conversion.
void	setSource(java.lang.String source) set the NT eventlog's source name.

Methods inherited from interface jet.server.api.rmi.admin.cfg.logger.RemoteConfigAppender

getName, getThreshold, isSelected, setSelected, setThreshold

Method Detail

getLayout

java.lang.String getLayout()
                           throws java.rmi.RemoteException

get the layout of the console appender. note: the NTEvent log can only support the following possible layouts:

        "Pattern"
        "HTML"
        "XML"
        "TTCC"
        "Simple"
 

Returns:

the layout value.

Throws:

java.rmi.RemoteException - will be thrown if error occurs.

setLayout

void setLayout(java.lang.String layout)
               throws java.rmi.RemoteException

Set the layout of the console appender.

Parameters:

layout, - new layout value.

Throws:

java.rmi.RemoteException - will be thrown if error occurs.

getPatternConversion

java.lang.String getPatternConversion()
                                      throws java.rmi.RemoteException

get the pattern conversion of the console appender.

Returns:

the pattern conversion, or null if the appender specified layout doesn't require the pattern conversion.

Throws:

java.rmi.RemoteException - will be thrown if error occurs.

setPatternConversion

void setPatternConversion(java.lang.String pattern)
                          throws java.rmi.RemoteException

set the appender's pattern conversion. setLayout should be firstly invoked before attempting to invoke this method.

Parameters:

pattern, - the pattern conversion value.

Throws:

java.rmi.RemoteException - will be thrown if error occurs.

getSource

java.lang.String getSource()
                           throws java.rmi.RemoteException

get the NT eventlog's source name.

Returns:

the NT eventlog's source name.

Throws:

java.rmi.RemoteException - will be thrown if error occurs.

setSource

void setSource(java.lang.String source)
               throws java.rmi.RemoteException

set the NT eventlog's source name.

Parameters:

source, - the NT eventlog's source name.

Throws:

java.rmi.RemoteException - will be thrown if error occurs.