com.opencloud.rhino.logging

Interface LoggingManagementMBean

public interface LoggingManagementMBean

The LoggingManagementMBean interface provides methods to modify Rhino's log configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME The name of this MBean, equal to the string "Logging".
static String	OBJECT_NAME The JMX Object Name of this MBean.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAppenderRef(String logKey, String appenderRef) Adds an appender for a log key.
void	createAppender(String appenderName, String appenderClassName, String appenderProps) Creates a custom appender.
void	createAppender(String appenderName, String appenderClassName, String appenderProps, String processName) Deprecated. Use createAppender(String, String, String)
void	createFileAppender(String appenderName, String filename) Creates a rolling log file appender.
void	createFileAppender(String appenderName, String filename, String processName) Deprecated. Use createFileAppender(String, String)
void	createFileAppender(String appenderName, String filename, String maxfilesize, Integer maxbackups) Creates a rolling log file appender.
void	createFileAppender(String appenderName, String filename, String maxfilesize, Integer maxbackups, String processName) Deprecated. Use createFileAppender(String, String, String, Integer)
void	createLogNotificationAppender(String appenderName, String threshold) Create a LogNotification appender.
void	createSocketAppender(String appenderName, String remoteHost, int port) Creates a log4j socket appender.
void	createSocketAppender(String appenderName, String remoteHost, int port, String processName) Deprecated. Use createSocketAppender(String, String, int)
void	createSyslogAppender(String appenderName, String syslogHost, String facility) Create a syslog appender.
void	createSyslogAppender(String appenderName, String syslogHost, String facility, String processName) Deprecated. Use createSyslogAppender(String, String, String)
boolean	getAdditivity(String logKey) Return the additivity of a logger.
int	getAlarmLogPeriod() Returns the interval between periodic active alarm logs.
TabularData	getAppenderProperties(String appenderName) Returns the configuration properties for the given appender.
String[]	getAppenderRefs(String logKey) Returns an array of the names of all appenders referenced by a given logger.
String[]	getAppenders() Return a list of all configured appenders.
String	getAppenderType(String appenderName) Returns the appender type for the given appender.
boolean	getColourConsole() Determines whether ANSI colour sequences for log messages has been enabled.
String	getCustomAppenderClassName(String appenderName) Returns the class name for the given appender.
CompositeData	getCustomAppenderInfo(String appenderName) Returns information for the given custom appender.
String	getEffectiveLogLevel(String logKey) Return the effective (inherited) log level of a logger.
CompositeData	getFileAppenderInfo(String appenderName) Returns information for the given file appender.
String[]	getLogKeys() Returns an array of all known log keys.
String	getLogLevel(String logKey) Returns the loggers log level.
boolean	getShowNDC() Determine whether the nested diagnostic context output is currently enabled.
boolean	getShowThread() Determines whether output of thread names for log messages is enabled.
CompositeData	getSocketAppenderInfo(String appenderName) Returns information for the given socket appender.
CompositeData	getSyslogAppenderInfo(String appenderName) Returns information for the given syslog appender.
String	getThreshold(String appenderName) Returns the log filter level for the given appender, or null if no threshold is set.
boolean	isExists(String logKey) Tests whether a logger for the given log key currently exists.
void	removeAppender(String appenderName) Deletes an appender.
void	removeAppenderRef(String logKey, String appenderRef) Removes an appender for a log key.
void	rollover(String appenderName) Backup and truncate an existing file appender.
void	rolloverAllLogFiles() Backup and truncate all existing file appenders
void	setAdditivity(String logKey, boolean additivity) Sets whether the log key inherits the log filter level of its parent logger.
void	setAlarmLogPeriod(int period) Sets the interval between periodic active alarm logs.
void	setColourConsole(boolean colourConsole) Enables ANSI colour sequences in log messages.
void	setLogLevel(String logKey, String level) Set the log filter level for a log key.
void	setShowNDC(boolean showNDC) Enables output of the nested diagnostic context.
void	setShowThread(boolean showThread) Enables output of the thread name responsible for creating a log message.
void	setThreshold(String appenderName, String threshold) Sets the log filter level for an appender.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

The name of this MBean, equal to the string "Logging".

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

The JMX Object Name of this MBean.

See Also:

Constant Field Values

Method Detail

setLogLevel

void setLogLevel(String logKey,
               String level)
                 throws com.opencloud.util.exception.ValidationException,
                        ConfigurationException

Set the log filter level for a log key.

Parameters:

logKey - the log key of the log.

level - the desired log level, or null to clear a previously set log level.

Throws:

com.opencloud.util.exception.ValidationException

ConfigurationException

setAdditivity

void setAdditivity(String logKey,
                 boolean additivity)
                   throws ConfigurationException,
                          com.opencloud.util.exception.ValidationException

Sets whether the log key inherits the log filter level of its parent logger.

Parameters:

logKey - the log key of the logger

additivity - set to true/enabled or false/disabled

Throws:

ConfigurationException

com.opencloud.util.exception.ValidationException

addAppenderRef

void addAppenderRef(String logKey,
                  String appenderRef)
                    throws UnknownAppenderException,
                           com.opencloud.util.exception.ValidationException,
                           ConfigurationException

Adds an appender for a log key.

Parameters:

logKey - the log key of the logger

appenderRef - the name of the existing appender

Throws:

UnknownAppenderException

com.opencloud.util.exception.ValidationException

ConfigurationException

removeAppenderRef

void removeAppenderRef(String logKey,
                     String appenderRef)
                       throws UnknownAppenderException,
                              ConfigurationException

Removes an appender for a log key.

Parameters:

logKey - A parameter

appenderRef - A parameter

Throws:

UnknownAppenderException - An exception

ConfigurationException - An exception

createAppender

void createAppender(String appenderName,
                  String appenderClassName,
                  String appenderProps)
                    throws ConfigurationException

Creates a custom appender.

Parameters:

appenderName - the name this appender is referenced by

appenderClassName - the java class name which provides the logging

appenderProps - comma separated list of name=value

Throws:

ConfigurationException - An exception

createAppender

@Deprecated
void createAppender(String appenderName,
                             String appenderClassName,
                             String appenderProps,
                             String processName)
                    throws ConfigurationException

Deprecated. Use createAppender(String, String, String)

Creates a custom appender.

Parameters:

appenderName - the name this appender is referenced by

appenderClassName - the java class name which provides the logging

appenderProps - comma separated list of name=value

processName - This argument is ignored

Throws:

ConfigurationException - An exception

removeAppender

void removeAppender(String appenderName)
                    throws UnknownAppenderException,
                           ConfigurationException

Deletes an appender.

Parameters:

appenderName - the name of the appender to delete

Throws:

UnknownAppenderException - An exception

ConfigurationException - An exception

setShowNDC

void setShowNDC(boolean showNDC)
                throws ConfigurationException

Enables output of the nested diagnostic context.

Parameters:

showNDC - set to true/enabled or false/disabled

Throws:

ConfigurationException - An exception

getShowNDC

boolean getShowNDC()
                   throws ConfigurationException

Determine whether the nested diagnostic context output is currently enabled.

Returns:

true if the nested diagnostic context is being shown.

Throws:

ConfigurationException - An exception

setShowThread

void setShowThread(boolean showThread)
                   throws ConfigurationException

Enables output of the thread name responsible for creating a log message.

Parameters:

showThread - set to true/enabled or false/disabled

Throws:

ConfigurationException - An exception

getShowThread

boolean getShowThread()
                      throws ConfigurationException

Determines whether output of thread names for log messages is enabled.

Returns:

true if the thread name is being shown.

Throws:

ConfigurationException - An exception

setColourConsole

void setColourConsole(boolean colourConsole)
                      throws ConfigurationException

Enables ANSI colour sequences in log messages.

Parameters:

colourConsole - set to true/enabled or false/disabled

Throws:

ConfigurationException - An exception

getColourConsole

boolean getColourConsole()
                         throws ConfigurationException

Determines whether ANSI colour sequences for log messages has been enabled.

Returns:

true if color is enabled.

Throws:

ConfigurationException - An exception

setThreshold

void setThreshold(String appenderName,
                String threshold)
                  throws com.opencloud.util.exception.ValidationException,
                         ConfigurationException

Sets the log filter level for an appender. Log messages logged at a level below the threshold will not be output. Setting the threshold to null will unset any previously set appender threshold.

Parameters:

appenderName - the name of the appender to reference

threshold - the log level, or null to unset the threshold

Throws:

com.opencloud.util.exception.ValidationException - An exception

ConfigurationException - An exception

createFileAppender

void createFileAppender(String appenderName,
                      String filename)
                        throws ConfigurationException

Creates a rolling log file appender. The maximum file size and backup count will be set to Rhino defaults.

Parameters:

appenderName - the name the appender is referenced by

filename - the target of the appenders log messages

Throws:

ConfigurationException - An exception

createFileAppender

@Deprecated
void createFileAppender(String appenderName,
                                 String filename,
                                 String processName)
                        throws ConfigurationException

Deprecated. Use createFileAppender(String, String)

Creates a rolling log file appender. The maximum file size and backup count will be set to Rhino defaults.

Parameters:

appenderName - the name the appender is referenced by

filename - the target of the appenders log messages

processName - This argument is ignored

Throws:

ConfigurationException - An exception

createFileAppender

void createFileAppender(String appenderName,
                      String filename,
                      String maxfilesize,
                      Integer maxbackups)
                        throws ConfigurationException

Creates a rolling log file appender.

Parameters:

appenderName - the name the appender is referenced by

filename - the target of the appenders log messages

maxfilesize - the maximum size before rollover

maxbackups - the maximum number of rollovers

Throws:

ConfigurationException - An exception

createFileAppender

@Deprecated
void createFileAppender(String appenderName,
                                 String filename,
                                 String maxfilesize,
                                 Integer maxbackups,
                                 String processName)
                        throws ConfigurationException

Deprecated. Use createFileAppender(String, String, String, Integer)

Creates a rolling log file appender.

Parameters:

appenderName - the name the appender is referenced by

filename - the target of the appenders log messages

maxfilesize - the maximum size before rollover

maxbackups - the maximum number of rollovers

processName - This argument is ignored

Throws:

ConfigurationException - An exception

createSocketAppender

void createSocketAppender(String appenderName,
                        String remoteHost,
                        int port)
                          throws ConfigurationException

Creates a log4j socket appender.

Parameters:

appenderName - the name the appender is referenced by

remoteHost - the host to connect to

port - the port to connect to

Throws:

ConfigurationException - An exception

createSocketAppender

@Deprecated
void createSocketAppender(String appenderName,
                                   String remoteHost,
                                   int port,
                                   String processName)
                          throws ConfigurationException

Deprecated. Use createSocketAppender(String, String, int)

Creates a log4j socket appender.

Parameters:

appenderName - the name the appender is referenced by

remoteHost - the host to connect to

port - the port to connect to

processName - This argument is ignored

Throws:

ConfigurationException - An exception

createSyslogAppender

void createSyslogAppender(String appenderName,
                        String syslogHost,
                        String facility)
                          throws ConfigurationException

Create a syslog appender.

Parameters:

appenderName - the name the appender is referenced by

syslogHost - the syslog host

facility - the syslog facility log message target

Throws:

ConfigurationException - An exception

createSyslogAppender

@Deprecated
void createSyslogAppender(String appenderName,
                                   String syslogHost,
                                   String facility,
                                   String processName)
                          throws ConfigurationException

Deprecated. Use createSyslogAppender(String, String, String)

Create a syslog appender.

Parameters:

appenderName - the name the appender is referenced by

syslogHost - the syslog host

facility - the syslog facility log message target

processName - This argument is ignored

Throws:

ConfigurationException - An exception

createLogNotificationAppender

void createLogNotificationAppender(String appenderName,
                                 String threshold)
                                   throws ConfigurationException

Create a LogNotification appender.

Parameters:

appenderName - the name the appender is referenced by

Throws:

ConfigurationException - An exception

rollover

void rollover(String appenderName)
              throws UnknownAppenderException

Backup and truncate an existing file appender.

Parameters:

appenderName - the name of the appender

Throws:

UnknownAppenderException - An exception

rolloverAllLogFiles

void rolloverAllLogFiles()

Backup and truncate all existing file appenders

getAdditivity

boolean getAdditivity(String logKey)

Return the additivity of a logger.

Parameters:

logKey - the log key of the logger

Returns:

true/enabled or false/disabled

getEffectiveLogLevel

String getEffectiveLogLevel(String logKey)

Return the effective (inherited) log level of a logger.

Parameters:

logKey - the log key of the logger

Returns:

true/enabled or false/disabled

getLogLevel

String getLogLevel(String logKey)

Returns the loggers log level. This does not take inherited levels into account and the return value may be null.

Parameters:

logKey - the log key of the logger

Returns:

the log cut off filter level

getLogKeys

String[] getLogKeys()

Returns an array of all known log keys. This does not include the implicit log key 'root'.

Returns:

the log keys

getAppenderRefs

String[] getAppenderRefs(String logKey)
                         throws ConfigurationException

Returns an array of the names of all appenders referenced by a given logger.

Parameters:

logKey - the log key of the logger

Returns:

the appenders names

Throws:

ConfigurationException

isExists

boolean isExists(String logKey)

Tests whether a logger for the given log key currently exists.

Parameters:

logKey - the log key of the logger

Returns:

true or false

getAppenders

String[] getAppenders()
                      throws ConfigurationException

Return a list of all configured appenders.

Returns:

the appenders

Throws:

ConfigurationException

getAppenderType

String getAppenderType(String appenderName)
                       throws UnknownAppenderException,
                              ConfigurationException

Returns the appender type for the given appender. The returned String is one the name of one of the constants defined in AppenderType, and is always non-null. Further information for specific types is available via these methods: getCustomAppenderClassName(java.lang.String), getFileAppenderInfo(java.lang.String), getSocketAppenderInfo(java.lang.String), and getSyslogAppenderInfo(java.lang.String).

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

ConfigurationException

getCustomAppenderClassName

String getCustomAppenderClassName(String appenderName)
                                  throws UnknownAppenderException,
                                         com.opencloud.util.exception.ValidationException,
                                         ConfigurationException

Returns the class name for the given appender.

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

com.opencloud.util.exception.ValidationException - If a validation error occurs, for example if the given appender isn't of the correct type

ConfigurationException

getCustomAppenderInfo

CompositeData getCustomAppenderInfo(String appenderName)
                                    throws UnknownAppenderException,
                                           com.opencloud.util.exception.ValidationException,
                                           ConfigurationException

Returns information for the given custom appender. The returned CompositeData contains one java.lang.String column: "class-name", representing the class name of the appender.

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

com.opencloud.util.exception.ValidationException - If a validation error occurs, for example if the given appender isn't of the correct type

ConfigurationException

getFileAppenderInfo

CompositeData getFileAppenderInfo(String appenderName)
                                  throws UnknownAppenderException,
                                         com.opencloud.util.exception.ValidationException,
                                         ConfigurationException

Returns information for the given file appender. The returned CompositeData contains three columns: a java.lang.String column "filename", a java.lang.String column "maximum-file-size", and a java.lang.Integer column "maximum-backup-files".

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

com.opencloud.util.exception.ValidationException - If a validation error occurs, for example if the given appender isn't of the correct type

ConfigurationException

getSocketAppenderInfo

CompositeData getSocketAppenderInfo(String appenderName)
                                    throws UnknownAppenderException,
                                           com.opencloud.util.exception.ValidationException,
                                           ConfigurationException

Returns information for the given socket appender. The returned CompositeData contains two columns: a java.lang.String column "remote-host", and a java.lang.Integer column "port".

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

com.opencloud.util.exception.ValidationException - If a validation error occurs, for example if the given appender isn't of the correct type

ConfigurationException

getSyslogAppenderInfo

CompositeData getSyslogAppenderInfo(String appenderName)
                                    throws UnknownAppenderException,
                                           com.opencloud.util.exception.ValidationException,
                                           ConfigurationException

Returns information for the given syslog appender. The returned CompositeData contains two java.lang.String columns: "syslog-host", and "facility".

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

com.opencloud.util.exception.ValidationException - If a validation error occurs, for example if the given appender isn't of the correct type

ConfigurationException

getAppenderProperties

TabularData getAppenderProperties(String appenderName)
                                  throws UnknownAppenderException,
                                         ConfigurationException

Returns the configuration properties for the given appender. The returned TabularData contains two java.lang.String columns: "name" and "value", with one entry for each property.

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

ConfigurationException

getThreshold

String getThreshold(String appenderName)
                    throws UnknownAppenderException,
                           ConfigurationException

Returns the log filter level for the given appender, or null if no threshold is set. Log messages logged at a level below the threshold will not be output.

Parameters:

appenderName - the name of the appender to reference

Throws:

UnknownAppenderException - If the given appender doesn't exist

ConfigurationException

setAlarmLogPeriod

void setAlarmLogPeriod(int period)
                       throws IllegalArgumentException,
                              ConfigurationException

Sets the interval between periodic active alarm logs. Setting the period to 0 will disable periodic alarm logging.

Parameters:

period - the interval between active alarm logging in seconds

Throws:

IllegalArgumentException - If the given period is less than 0 seconds.

ConfigurationException

getAlarmLogPeriod

int getAlarmLogPeriod()
                      throws ConfigurationException

Returns the interval between periodic active alarm logs.

Throws:

ConfigurationException