Package COM.activesw.api.client

Class BrokerLogConfig

java.lang.Object

COM.activesw.api.client.BrokerLogConfig

public class BrokerLogConfig
extends Object

A log configuration object.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOG_OUTPUT_NT_EVENT_LOG
static final String	LOG_OUTPUT_SNMP_TRAP
static final String	LOG_OUTPUT_UNIX_SYSLOG
static final String	LOG_TOPIC_ALERT
static final String	LOG_TOPIC_INFO
static final String	LOG_TOPIC_WARNING

Constructor Summary

Constructors

Constructor	Description
BrokerLogConfig()	Create a new log configuration object.
BrokerLogConfig(BrokerLogConfig log_config)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
void	clearLogOutput(String code)	Clear the state of a single log output.
void	clearLogOutputs()	Clear the state of all log outputs.
void	clearLogTopic(String code)	Clear the state of a single log topic.
void	clearLogTopics()	Clear the state of all log topics.
BrokerLogConfigEntry	getLogOutput(String code)	Get the value of a single log output.
BrokerLogConfigEntry[]	getLogOutputs()	Get the state of all log outputs.
BrokerLogConfigEntry	getLogTopic(String code)	Get the value of a single log topic's state.
BrokerLogConfigEntry[]	getLogTopics()	Get the states of all the log topics.
void	setLogOutput(BrokerLogConfigEntry log_output)	Set the value of a simple log output's state.
void	setLogOutput(String code, boolean enabled, String value)	Set the value of a single log output's state.
void	setLogTopic(BrokerLogConfigEntry log_topic)	Set the value of a single log topic's state.
void	setLogTopic(String code, boolean enabled, String value)	Set the value of a single log topic's state.
String	toString()	Get a string with the log config information in a form suitable for human viewing.
String	toString(int indent_level)	Get a string with the log config information in a form suitable for human viewing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

LOG_OUTPUT_UNIX_SYSLOG

public static final String LOG_OUTPUT_UNIX_SYSLOG

See Also:

• Constant Field Values

LOG_OUTPUT_NT_EVENT_LOG

public static final String LOG_OUTPUT_NT_EVENT_LOG

See Also:

• Constant Field Values

LOG_OUTPUT_SNMP_TRAP

public static final String LOG_OUTPUT_SNMP_TRAP

See Also:

• Constant Field Values

LOG_TOPIC_ALERT

public static final String LOG_TOPIC_ALERT

See Also:

• Constant Field Values

LOG_TOPIC_WARNING

public static final String LOG_TOPIC_WARNING

See Also:

• Constant Field Values

LOG_TOPIC_INFO

public static final String LOG_TOPIC_INFO

See Also:

• Constant Field Values

Constructor Details

BrokerLogConfig

public BrokerLogConfig()

Create a new log configuration object. The default log config has no entries.

BrokerLogConfig

public BrokerLogConfig(BrokerLogConfig log_config)
                throws BrokerException

Copy constructor.

Throws:

BrokerNullParameterException - If log_config is null.

BrokerException

Method Details

getLogOutput

public BrokerLogConfigEntry getLogOutput(String code)
                                  throws BrokerException

Get the value of a single log output. The code can be any of the LOG_OUTPUT_* values.

Throws:

BrokerNullParameterException - If code is null.

BrokerOutOfRangeException - If the code value is not in this log config.

BrokerException

getLogOutputs

public BrokerLogConfigEntry[] getLogOutputs()

Get the state of all log outputs.

setLogOutput

public void setLogOutput(String code,
 boolean enabled,
 String value)
                  throws BrokerException

Set the value of a single log output's state. The code can be any of the LOG_OUTPUT_* values. The value can be any additional string needed by the log output. Usually the value is null.

Throws:

BrokerNullParameterException - If code is null.

BrokerException

setLogOutput

public void setLogOutput(BrokerLogConfigEntry log_output)
                  throws BrokerException

Set the value of a simple log output's state. The code can be any of the LOG_OUTPUT_* values. The value can be any additional string needed by the log output. Usually the value is null.

Throws:

BrokerNullParameterException - If log_outputs is null, or if log_output.code is null.

BrokerException

clearLogOutput

public void clearLogOutput(String code)
                    throws BrokerException

Clear the state of a single log output. The code can be any of the LOG_OUTPUT_* constants.

Throws:

BrokerNullPointerException - If code is null.

BrokerException

clearLogOutputs

public void clearLogOutputs()

Clear the state of all log outputs.

getLogTopic

public BrokerLogConfigEntry getLogTopic(String code)
                                 throws BrokerException

Get the value of a single log topic's state. The code can be any of the LOG_TOPIC_* constants.

Throws:

BrokerNullParameterException - If code is null.

BrokerOutOfRangeException - If the code value is not set in this log config.

BrokerException

getLogTopics

public BrokerLogConfigEntry[] getLogTopics()

Get the states of all the log topics.

setLogTopic

public void setLogTopic(String code,
 boolean enabled,
 String value)
                 throws BrokerException

Set the value of a single log topic's state. The code values can be any of the LOG_TOPIC_* values. The value can be any additional string needed by the log topic. Usually the value is null.

Throws:

BrokerNullParameterException - If code is null.

BrokerException

setLogTopic

public void setLogTopic(BrokerLogConfigEntry log_topic)
                 throws BrokerException

Set the value of a single log topic's state. The code values can be any of the LOG_TOPIC_* values. The value can be any additional string needed by the log topic. Usually the value is null.

Throws:

BrokerNullParameterException - If log_topic is null, or if log_topic.code is null.

BrokerException

clearLogTopic

public void clearLogTopic(String code)
                   throws BrokerException

Clear the state of a single log topic. The code can be any of the LOG_TOPIC_* constants.

Throws:

BrokerNullParameterException - If code is null.

BrokerException

clearLogTopics

public void clearLogTopics()

Clear the state of all log topics.

toString

public String toString()

Get a string with the log config information in a form suitable for human viewing.

Overrides:

toString in class Object

toString

public String toString(int indent_level)

Get a string with the log config information in a form suitable for human viewing. The "indent_level" is the number of 4-space indents that the output should be generated for.