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

Interface RemoteConfigNTLogAppender

All Superinterfaces:

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

Modifier and Type	Method and Description
String	getLayout() Gets the layout of the console appender.
String	getPatternConversion() Gets the pattern conversion of the console appender.
String	getSource() Gets the NT eventlog's source name.
void	setLayout(String layout) Sets the layout of the console appender.
void	setPatternConversion(String pattern) Sets the appender's pattern conversion.
void	setSource(String source) Sets 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

String getLayout()
          throws RemoteException

Gets 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:

RemoteException - if communication-related error occurs during RMI call execution.

setLayout

void setLayout(String layout)
        throws RemoteException

Sets the layout of the console appender.

Parameters:

layout - the new layout value.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getPatternConversion

String getPatternConversion()
                     throws RemoteException

Gets 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:

RemoteException - if communication-related error occurs during RMI call execution.

setPatternConversion

void setPatternConversion(String pattern)
                   throws RemoteException

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

Parameters:

pattern - the pattern conversion value.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

getSource

String getSource()
          throws RemoteException

Gets the NT eventlog's source name.

Returns:

the NT eventlog's source name.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.

setSource

void setSource(String source)
        throws RemoteException

Sets the NT eventlog's source name.

Parameters:

source - the NT eventlog's source name.

Throws:

RemoteException - if communication-related error occurs during RMI call execution.