com.sun.appserv.management.config
Interface ManagementRulesConfig

All Superinterfaces:

AMX, AMXConfig, AMXMBeanLogging, ConfigElement, Container, Enabled, NotificationBroadcaster, NotificationEmitter

public interface ManagementRulesConfig
extends ConfigElement, Container, Enabled

Manipulates management rules.

Since:

Appserver 9.0

Field Summary

static String	EVENT_DESCRIPTION_KEY For use with createManagementRuleConfig() specifying Event description (String)
static String	EVENT_LEVEL_KEY For use with createManagementRuleConfig() specifying Event Level [default=INFO] (String)
static String	EVENT_LOG_ENABLED_KEY For use with createManagementRuleConfig() specifying whether event logging is to be enabled (Boolean)
static String	EVENT_PROPERTIES_KEY For use with createManagementRuleConfig() specifying Event properties (Properties)
static String	J2EE_TYPE The j2eeType as returned by AMX.getJ2EEType()
static String	RULE_DESCRIPTION_KEY For use with createManagementRuleConfig() specifying description of the rule (String)
static String	RULE_ENABLED_KEY For use with createManagementRuleConfig() specifying whether the rule is to be enabled (Boolean)

Fields inherited from interface com.sun.appserv.management.config.AMXConfig

CONFIG_CREATED_NOTIFICATION_TYPE, CONFIG_OBJECT_NAME_KEY, CONFIG_REMOVED_NOTIFICATION_TYPE

Fields inherited from interface com.sun.appserv.management.base.AMX

FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME

Fields inherited from interface com.sun.appserv.management.base.Container

ATTR_CONTAINEE_J2EE_TYPES

Method Summary

ManagementRuleConfig	createManagementRuleConfig(String ruleName, String eventType, String actionMBeanName, Map<String,String> optional) Create new self management rule.
Map<String,ManagementRuleConfig>	getManagementRuleConfigMap()
void	removeManagementRuleConfig(String name)

Methods inherited from interface com.sun.appserv.management.base.AMX

getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface com.sun.appserv.management.base.AMXMBeanLogging

getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel

Methods inherited from interface com.sun.appserv.management.base.Container

getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap

Methods inherited from interface com.sun.appserv.management.config.Enabled

getEnabled, setEnabled

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

The j2eeType as returned by AMX.getJ2EEType()

See Also:

Constant Field Values

RULE_DESCRIPTION_KEY

static final String RULE_DESCRIPTION_KEY

For use with createManagementRuleConfig() specifying description of the rule (String)

See Also:

Constant Field Values

RULE_ENABLED_KEY

static final String RULE_ENABLED_KEY

For use with createManagementRuleConfig() specifying whether the rule is to be enabled (Boolean)

See Also:

Constant Field Values

EVENT_LOG_ENABLED_KEY

static final String EVENT_LOG_ENABLED_KEY

For use with createManagementRuleConfig() specifying whether event logging is to be enabled (Boolean)

See Also:

Constant Field Values

EVENT_LEVEL_KEY

static final String EVENT_LEVEL_KEY

For use with createManagementRuleConfig() specifying Event Level [default=INFO] (String)

See Also:

Constant Field Values

EVENT_PROPERTIES_KEY

static final String EVENT_PROPERTIES_KEY

For use with createManagementRuleConfig() specifying Event properties (Properties)

See Also:

Constant Field Values

EVENT_DESCRIPTION_KEY

static final String EVENT_DESCRIPTION_KEY

For use with createManagementRuleConfig() specifying Event description (String)

See Also:

Constant Field Values

Method Detail

getManagementRuleConfigMap

Map<String,ManagementRuleConfig> getManagementRuleConfigMap()

createManagementRuleConfig

ManagementRuleConfig createManagementRuleConfig(String ruleName,
                                                String eventType,
                                                String actionMBeanName,
                                                Map<String,String> optional)

Create new self management rule. In addition to the formal parameters, the following optional parameters may be specified:

• RULE_DESCRIPTION_KEY
• RULE_ENABLED_KEY
• EVENT_DESCRIPTION_KEY
• EVENT_LOG_ENABLED_KEY
• EVENT_LEVEL_KEY
• EVENT_PROPERTIES_KEY

Parameters:

ruleName - name of the management rule. Required.

eventType - one of the values defined in EventTypeValues

actionMBeanName - actionMbeanName associated with rule (optional)

optional - optional additional values

Returns:

ObjectName of created management-rule

Throws:

Exception

See Also:

EventTypeValues

removeManagementRuleConfig

void removeManagementRuleConfig(String name)