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

All Superinterfaces:

java.rmi.Remote, RemoteConfigAppender

public interface RemoteConfigSysLogAppender
extends RemoteConfigAppender

The RemoteConfigSysLogAppender takes charge of managing Unix syslog appender specific properties.

Since:

V8.1

Field Summary

static java.lang.String[]	FACILITIES
static java.lang.String	FACILITY_AUTH
static java.lang.String	FACILITY_AUTHPRIV
static java.lang.String	FACILITY_CRON
static java.lang.String	FACILITY_DAEMON
static java.lang.String	FACILITY_FTP
static java.lang.String	FACILITY_KERN define all the facilities provided by unix OS.
static java.lang.String	FACILITY_LOCAL0
static java.lang.String	FACILITY_LOCAL1
static java.lang.String	FACILITY_LOCAL2
static java.lang.String	FACILITY_LOCAL3
static java.lang.String	FACILITY_LOCAL4
static java.lang.String	FACILITY_LOCAL5
static java.lang.String	FACILITY_LOCAL6
static java.lang.String	FACILITY_LOCAL7
static java.lang.String	FACILITY_LPR
static java.lang.String	FACILITY_MAIL
static java.lang.String	FACILITY_NEWS
static java.lang.String	FACILITY_SYSLOG
static java.lang.String	FACILITY_USER
static java.lang.String	FACILITY_UUCP

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	getFacility() get the syslog appender facility.
java.lang.String	getHost() set the syslog appender host.
java.lang.String	getLayout() get the layout of the unix syslog appender.
java.lang.String	getPatternConversion() get the pattern conversion of the unix syslog appender.
boolean	isPrintFacility() judge whether to print the syslog's facility.
void	setFacility(java.lang.String facility) set the syslog appender facility.
void	setHost(java.lang.String host) set the syslog appender host.
void	setLayout(java.lang.String layout) Set the layout of the unix syslog appender.
void	setPatternConversion(java.lang.String pattern) set the appender's pattern conversion.
void	setPrintFacility(boolean printFacility) set the syslog appender's facility printing value.

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

getName, getThreshold, isSelected, setSelected, setThreshold

Field Detail

FACILITY_KERN

static final java.lang.String FACILITY_KERN

define all the facilities provided by unix OS.

See Also:

Constant Field Values

FACILITY_USER

static final java.lang.String FACILITY_USER

See Also:

Constant Field Values

FACILITY_MAIL

static final java.lang.String FACILITY_MAIL

See Also:

Constant Field Values

FACILITY_DAEMON

static final java.lang.String FACILITY_DAEMON

See Also:

Constant Field Values

FACILITY_AUTH

static final java.lang.String FACILITY_AUTH

See Also:

Constant Field Values

FACILITY_SYSLOG

static final java.lang.String FACILITY_SYSLOG

See Also:

Constant Field Values

FACILITY_LPR

static final java.lang.String FACILITY_LPR

See Also:

Constant Field Values

FACILITY_NEWS

static final java.lang.String FACILITY_NEWS

See Also:

Constant Field Values

FACILITY_UUCP

static final java.lang.String FACILITY_UUCP

See Also:

Constant Field Values

FACILITY_CRON

static final java.lang.String FACILITY_CRON

See Also:

Constant Field Values

FACILITY_AUTHPRIV

static final java.lang.String FACILITY_AUTHPRIV

See Also:

Constant Field Values

FACILITY_FTP

static final java.lang.String FACILITY_FTP

See Also:

Constant Field Values

FACILITY_LOCAL0

static final java.lang.String FACILITY_LOCAL0

See Also:

Constant Field Values

FACILITY_LOCAL1

static final java.lang.String FACILITY_LOCAL1

See Also:

Constant Field Values

FACILITY_LOCAL2

static final java.lang.String FACILITY_LOCAL2

See Also:

Constant Field Values

FACILITY_LOCAL3

static final java.lang.String FACILITY_LOCAL3

See Also:

Constant Field Values

FACILITY_LOCAL4

static final java.lang.String FACILITY_LOCAL4

See Also:

Constant Field Values

FACILITY_LOCAL5

static final java.lang.String FACILITY_LOCAL5

See Also:

Constant Field Values

FACILITY_LOCAL6

static final java.lang.String FACILITY_LOCAL6

See Also:

Constant Field Values

FACILITY_LOCAL7

static final java.lang.String FACILITY_LOCAL7

See Also:

Constant Field Values

FACILITIES

static final java.lang.String[] FACILITIES

Method Detail

getLayout

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

get the layout of the unix syslog appender. note: the Syslog 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 unix syslog 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 unix syslog 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.

getHost

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

set the syslog appender host.

Returns:

the syslog appender host.

Throws:

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

setHost

void setHost(java.lang.String host)
             throws java.rmi.RemoteException

set the syslog appender host.

Parameters:

host, - the syslog appender host.

Throws:

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

getFacility

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

get the syslog appender facility. note: the UNix Syslog appender can only provide the following possible facilities:

        "KERN"
        "USER"
        "MAIL"
        "DAEMON"
        "AUTH"
        "SYSLOG"
        "LPR"
        "NEWS"
        "UUCP"
        "CRON"
        "AUTHPRIV"
        "FTP"
        "LOCAL0"
        "LOCAL1"
        "LOCAL2"
        "LOCAL3"
        "LOCAL4"
        "LOCAL5"
        "LOCAL6"
        "LOCAL7"
 

Returns:

the syslog appender facility.

Throws:

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

setFacility

void setFacility(java.lang.String facility)
                 throws java.rmi.RemoteException

set the syslog appender facility.

Parameters:

facility, - the syslog appender facility.

Throws:

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

isPrintFacility

boolean isPrintFacility()
                        throws java.rmi.RemoteException

judge whether to print the syslog's facility.

Returns:

true if print the facility, else false.

Throws:

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

setPrintFacility

void setPrintFacility(boolean printFacility)
                      throws java.rmi.RemoteException

set the syslog appender's facility printing value.

Parameters:

printFacility, - the boolean value of the syslog appender facility.

Throws:

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