com.haulmont.cuba.web.jmx

Interface JmxRemoteLoggingAPI

All Known Implementing Classes:

JmxRemoteLoggingBean

public interface JmxRemoteLoggingAPI

Interface to provide JMX bridge to log control functionality for local and remote JMX interfaces

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JmxRemoteLoggingAPI.LoggingHostInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAppenders(JmxInstance instance) Get current appenders.
java.lang.String	getAppenderThreshold(JmxInstance instance, java.lang.String appenderName) Reads current threshold of the appender.
java.util.List<java.lang.String>	getAvailableContexts(JmxInstance instance)
JmxRemoteLoggingAPI.LoggingHostInfo	getHostInfo(JmxInstance instance)
java.lang.String	getLogFileLink(JmxInstance instance, java.lang.String fileName) Get URL for log file downloading.
java.lang.String	getLogFileLink(JmxInstance instance, java.lang.String remoteContext, java.lang.String fileName) Get URL for log file downloading.
java.util.List<java.lang.String>	getLogFileNames(JmxInstance instance) Returns the list of titles of logs.
long	getLogFileSize(JmxInstance instance, java.lang.String fileName) Get size for log file downloading.
java.lang.String	getLoggerLevel(JmxInstance instance, java.lang.String loggerName) Reads current level of the logger.
java.util.List<java.lang.String>	getLoggerNames(JmxInstance instance) Get current loggers names.
java.util.Map<java.lang.String,java.lang.String>	getLoggersLevels(JmxInstance instance)
java.lang.String	getTail(JmxInstance instance, java.lang.String fileName) Reads a log tail equal 50Kb at line.
void	setAppenderThreshold(JmxInstance instance, java.lang.String appenderName, java.lang.String threshold) Writes threshold for the specified logger.
void	setLoggerLevel(JmxInstance instance, java.lang.String loggerName, java.lang.String level) Writes down level for the specified logger.
void	setLoggersLevels(JmxInstance instance, java.util.Map<java.lang.String,java.lang.String> updates)

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getLogFileNames

java.util.List<java.lang.String> getLogFileNames(JmxInstance instance)

Returns the list of titles of logs.

Parameters:

instance - jmx connection

Returns:

list of titles of logs

getTail

java.lang.String getTail(JmxInstance instance,
                         java.lang.String fileName)
                  throws LogControlException

Reads a log tail equal 50Kb at line.

Parameters:

instance - jmx connection

fileName - name of a readable file

Returns:

line of log records

Throws:

LogControlException

getLogFileLink

java.lang.String getLogFileLink(JmxInstance instance,
                                java.lang.String fileName)
                         throws LogControlException

Get URL for log file downloading.

Parameters:

instance - jmx connection

fileName - name of a log file

Returns:

URL

Throws:

LogControlException

getLogFileLink

java.lang.String getLogFileLink(JmxInstance instance,
                                java.lang.String remoteContext,
                                java.lang.String fileName)
                         throws LogControlException

Get URL for log file downloading.

Parameters:

instance - jmx connection

remoteContext - remote web context

fileName - name of a log file

Returns:

URL

Throws:

LogControlException

getLogFileSize

long getLogFileSize(JmxInstance instance,
                    java.lang.String fileName)
             throws LogControlException

Get size for log file downloading.

Parameters:

instance - jmx connection

fileName - name of a log file

Returns:

URL

Throws:

LogControlException

getLoggerNames

java.util.List<java.lang.String> getLoggerNames(JmxInstance instance)

Get current loggers names.

Parameters:

instance - jmx connection

Returns:

current logger names

getLoggerLevel

java.lang.String getLoggerLevel(JmxInstance instance,
                                java.lang.String loggerName)
                         throws LogControlException

Reads current level of the logger.

Parameters:

instance - jmx connection

loggerName - logger name

Returns:

level of the logger

Throws:

LogControlException

getLoggersLevels

java.util.Map<java.lang.String,java.lang.String> getLoggersLevels(JmxInstance instance)

Parameters:

instance - jmx connection

Returns:

current loggers names and levels

setLoggerLevel

void setLoggerLevel(JmxInstance instance,
                    java.lang.String loggerName,
                    java.lang.String level)
             throws LogControlException

Writes down level for the specified logger.

Parameters:

instance - jmx connection

loggerName - logger name

level - level

Throws:

LogControlException

setLoggersLevels

void setLoggersLevels(JmxInstance instance,
                      java.util.Map<java.lang.String,java.lang.String> updates)
               throws LogControlException

Throws:

LogControlException

getAppenders

java.util.List<java.lang.String> getAppenders(JmxInstance instance)

Get current appenders.

Parameters:

instance - jmx connection

Returns:

current appender names

getAppenderThreshold

java.lang.String getAppenderThreshold(JmxInstance instance,
                                      java.lang.String appenderName)
                               throws LogControlException

Reads current threshold of the appender.

Parameters:

instance - jmx connection

appenderName - appender name

Returns:

threshold of the logger

Throws:

LogControlException

setAppenderThreshold

void setAppenderThreshold(JmxInstance instance,
                          java.lang.String appenderName,
                          java.lang.String threshold)
                   throws LogControlException

Writes threshold for the specified logger.

Parameters:

instance - jmx connection

appenderName - logger name

threshold - threshold level

Throws:

LogControlException

getHostInfo

JmxRemoteLoggingAPI.LoggingHostInfo getHostInfo(JmxInstance instance)

Parameters:

instance - jmx connection

Returns:

host info

getAvailableContexts

java.util.List<java.lang.String> getAvailableContexts(JmxInstance instance)

Parameters:

instance - jmx connection

Returns:

list of available web contexts on this instance