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

All Superinterfaces:

java.rmi.Remote, RemoteConfigAppender

public interface RemoteConfigConsoleAppender
extends RemoteConfigAppender

The RemoteConfigConsoleAppender takes charge of managing console appender specific properties.

Since:

V8.1

Field Summary

static java.lang.String	TARGET_ERR
static java.lang.String	TARGET_OUT define all targets supported by the console appender.
static java.lang.String[]	TARGETS

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 telnet appender.
java.lang.String	getPatternConversion() get the pattern conversion of the telnet appender.
java.lang.String	getTarget() get the console appender target.
void	setLayout(java.lang.String layout) Set the layout of the telnet appender.
void	setPatternConversion(java.lang.String pattern) set the appender's pattern conversion.
void	setTarget(java.lang.String target) set the console appender's target.

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

getName, getThreshold, isSelected, setSelected, setThreshold

Field Detail

TARGET_OUT

static final java.lang.String TARGET_OUT

define all targets supported by the console appender.

See Also:

Constant Field Values

TARGET_ERR

static final java.lang.String TARGET_ERR

See Also:

Constant Field Values

TARGETS

static final java.lang.String[] TARGETS

Method Detail

getLayout

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

get the layout of the telnet appender. note: the console appender 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 telnet 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 telnet 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.

getTarget

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

get the console appender target. note: the console appender can only support the following possible targets:

        "System.out"
        "System.err"
 

Returns:

the console target.

Throws:

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

setTarget

void setTarget(java.lang.String target)
               throws java.rmi.RemoteException

set the console appender's target.

Parameters:

target, - the target of the console appender.

Throws:

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