org.marketcetera.modules.remote.receiver

Interface ReceiverModuleMXBean

All Known Implementing Classes:

ReceiverModule

public interface ReceiverModuleMXBean

Management interface for ReceiverModule.

Since:

1.5.0

Version:

$Id: ReceiverModuleMXBean.java 16154 2012-07-14 16:34:05Z colin $

Author:

anshul@marketcetera.com

Method Summary

Methods

Modifier and Type	Method and Description
LogEventLevel	getLogLevel() Gets the minimum log level of log events remotely transmitted by this module.
String	getURL() Gets the URL at which remote emitters should be able to connect to this module.
boolean	isSkipJAASConfiguration() If the module should skip the automatic JAAS configuration when it's started.
void	setLogLevel(LogEventLevel inLevel) Sets the minimum log level of log events remotely transmitted by this module.
void	setSkipJAASConfiguration(boolean inSkipJAASConfiguration) Sets if the module should skip the automatic JAAS configuration when it's started.
void	setURL(String inURL) Sets the URL at which remote emitters should be able to connect to this module.

Method Detail

getURL

String getURL()

Gets the URL at which remote emitters should be able to connect to this module.

Returns:

the URL value.

setURL

void setURL(String inURL)

Sets the URL at which remote emitters should be able to connect to this module.

Parameters:

inURL - the URL value.

Throws:

IllegalStateException - if the module is started. The URL can only be set when the module is not started.

getLogLevel

LogEventLevel getLogLevel()

Gets the minimum log level of log events remotely transmitted by this module.

The returned log level corresponds to the log-level for the system-wide logger category Messages.USER_MSG_CATEGORY.

Returns:

the log level value.

setLogLevel

void setLogLevel(LogEventLevel inLevel)

Sets the minimum log level of log events remotely transmitted by this module.

Setting this log level also sets the log level for the system-wide logger category Messages.USER_MSG_CATEGORY.

Do note for this function to work correctly the system logger category should not be specified in the log4j configuration file. The log4j configuration file is reread whenever it's updated. If the log4j configuration file contains configuration for the system logger category, it will over-write the configuration carried out via this method and result in confusing system behavior.

Parameters:

inLevel - the log level value.

isSkipJAASConfiguration

boolean isSkipJAASConfiguration()

If the module should skip the automatic JAAS configuration when it's started.

Returns:

if the module should skip the automatic JAAS configuration when it's started.

setSkipJAASConfiguration

void setSkipJAASConfiguration(boolean inSkipJAASConfiguration)

Sets if the module should skip the automatic JAAS configuration when it's started.

Parameters:

inSkipJAASConfiguration - if the automatic JAAS configuration should be skipped.