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 Property for specify target system err for console appender.
static java.lang.String	TARGET_OUT Property for specifying the target system out for console appender.
static java.lang.String[]	TARGETS All targets supported by the console appender contain TARGET_OUT,TARGET_ERR .

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

Property for specifying the target system out for console appender.

See Also:

Constant Field Values

TARGET_ERR

static final java.lang.String TARGET_ERR

Property for specify target system err for console appender.

See Also:

Constant Field Values

TARGETS

static final java.lang.String[] TARGETS

All targets supported by the console appender contain TARGET_OUT,TARGET_ERR .

Method Detail

getLayout

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

Gets 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 - if communication-related error occurs during RMI call execution.

setLayout

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

Sets the layout of the telnet appender.

Parameters:

layout - the new layout value.

Throws:

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

getPatternConversion

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

Gets 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 - if communication-related error occurs during RMI call execution.

setPatternConversion

void setPatternConversion(java.lang.String pattern)
                          throws java.rmi.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:

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

getTarget

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

Gets 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 - if communication-related error occurs during RMI call execution.

setTarget

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

Sets the console appender's target.

Parameters:

target - the target of the console appender.

Throws:

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