Skip navigation links

com.bea.wlevs.management.configuration
Interface ProcessorMBean

All Known Subinterfaces:

CQLProcessorMBean, EPLProcessorMBean

public interface ProcessorMBean

extends StageMBean

Inner Class Summary

static class	ProcessorMBean.RuleConfigParameters Values defined here identify rule configuration parameters.
static class	ProcessorMBean.RuleType

Method Summary
java.lang.String	addRule(java.lang.String query) This method will add an EPL rule to the designated EPL Processor.
void	addRule(java.lang.String id, java.lang.String query) This method will add an EPL rule with a name to the designated EPL Processor.
void	addRule(java.lang.String id, java.lang.String query, boolean active) This method will add an EPL rule with a name to the designated EPL Processor.
java.util.Map	addRules(java.util.Map rules) This method adds a set of EPL queries to the designated EPL Processor.
void	deleteAllRules() This methods deletes all rules that has been configured in the EPL Processor.
void	deleteRule(java.lang.String id) This method deletes a rule from the EPL Processor with the given rule id.
void	deleteRules(java.lang.String[] ids) This method deletes all rules with the given ids.
java.lang.String	downloadRules() This method returns in XML format all rules and any parameter values associated with parameterized queries in the designated EPL Proessor.
java.util.Map	getAllRules() This method fetches all the rules that has been configured in the designated EPL Proessor.
java.util.Map	getAllRulesInfo() Returns all the rules configured for this processor along with all the information about the rules.
java.lang.String	getRule(java.lang.String id) This method fetches a rule with the given id.
java.util.Map	getRules(java.lang.String[] ids) This method fetches the rules for ids that are in the array.
boolean	isRuleStarted(java.lang.String id) Use this to find out whether rule is started and is processing events.
void	replaceRule(java.lang.String id, java.lang.String query) This method will replace an existing EPL rule by another rule.
java.util.Map	replaceRules(java.util.Map rules) This method will replace several existing EPL rules.
void	startRule(java.lang.String id) Starts a rule and makes it ready to process events
void	stopRule(java.lang.String id) Stops a cql query or EPL rule so that it will not process incoming events anymore.
java.util.Map	uploadRules(java.util.Map rules) This method uploads a collection of EPL queries to the designated EPL processor.
java.util.Map	uploadRules(java.lang.String configXML) This method uploads a collection of EPL queries and associated parameter value bindings to the designated EPL processor.

Methods inherited from interface com.bea.wlevs.management.configuration.StageMBean

configurePlayback, configurePlaybackWithDuration, configureRecord, configureRecordWithDuration, getPlaybackConfiguration, getRecordConfiguration, getRecordPlayback, isPlayingBack, isRecording, startPlayback, startRecording, stopPlayback, stopRecording

Methods inherited from interface com.bea.wlevs.management.WebLogicMBean

getName, getObjectName, getType

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

addRule

public java.lang.String addRule(java.lang.String query)
                         throws javax.management.JMException

This method will add an EPL rule to the designated EPL Processor.

Parameters:

query - - An epl rule

Returns:

- rule name - The name of the rule will be generated and returned

Throws:

javax.management.JMException -

addRule

public void addRule(java.lang.String id,
                    java.lang.String query)
             throws javax.management.JMException

This method will add an EPL rule with a name to the designated EPL Processor.

Parameters:

id- - A String which has the name of the query

query- - A String representing a query in EPL Syntax

Throws:

OperationsException - - if rule with the same id already exists

addRule

public void addRule(java.lang.String id,
                    java.lang.String query,
                    boolean active)
             throws javax.management.JMException

This method will add an EPL rule with a name to the designated EPL Processor.

Parameters:

id- - A String which has the name of the query

query- - A String representing a query in EPL Syntax

active - Flag indicating if the rule should be started and ready to receive events.

Throws:

OperationsException - - if rule with the same id already exists

addRules

public java.util.Map addRules(java.util.Map rules)
                       throws javax.management.JMException

This method adds a set of EPL queries to the designated EPL Processor.

Parameters:

rules - - A Map containg the queries with their names.

Returns:

- A Map of queries that was added successfully. If the name of the query was not provided the return Map will have the auto-generated name of the query.

Throws:

OperationsException - - if rule with the same id already exists

replaceRule

public void replaceRule(java.lang.String id,
                        java.lang.String query)
                 throws javax.management.JMException

This method will replace an existing EPL rule by another rule. The original rule will be destroyed, and the new one inserted in its place. If the original rule is parameterized, any existing bindings will be moved to the new rule.

Parameters:

id- - A String which has the name of the query

query- - A String representing a query in EPL Syntax

Throws:

OperationsException - - if rule with the same id does not exist

replaceRules

public java.util.Map replaceRules(java.util.Map rules)
                           throws javax.management.JMException

This method will replace several existing EPL rules. The original rules will be destroyed, and the new ones inserted in their places. If the original rules are parameterized, any existing bindings will be moved to the new rules.

Parameters:

rules - - A Map containg the queries with their names.

Returns:

- A Map of queries that was added successfully. If the name of the query was not provided the return Map will have the auto-generated name of the query.

Throws:

OperationsException - - if rule with the same id does not exist

uploadRules

public java.util.Map uploadRules(java.util.Map rules)
                          throws javax.management.JMException

This method uploads a collection of EPL queries to the designated EPL processor. The queries uploaded will completely replace existing rules.

Parameters:

rules - - A Map containing queries with their names

Returns:

- A Map of queries that was uploaded successfully.

Throws:

javax.management.JMException -

uploadRules

public java.util.Map uploadRules(java.lang.String configXML)
                          throws javax.management.JMException

This method uploads a collection of EPL queries and associated parameter value bindings to the designated EPL processor. The queries and bindings uploaded will completely replace existing rules and bindings. The XML must be valid against the schema of the processor configuration.

Parameters:

configXML - - A String in XML format of all all rules and associated parameter bindings valid against the processor configuration schema.

Returns:

- The map of queries that was uploaded successfully.

Throws:

javax.management.JMException -

downloadRules

public java.lang.String downloadRules()
                               throws javax.management.JMException

This method returns in XML format all rules and any parameter values associated with parameterized queries in the designated EPL Proessor.

Returns:

- A String in XML format of all rules and parameter value bindings.

Throws:

javax.management.JMException -

getRule

public java.lang.String getRule(java.lang.String id)
                         throws javax.management.JMException

This method fetches a rule with the given id.

Parameters:

id - - A string which represents the id of the rule

Returns:

Throws:

javax.management.JMException -

getRules

public java.util.Map getRules(java.lang.String[] ids)
                       throws javax.management.JMException

This method fetches the rules for ids that are in the array.

Parameters:

ids - - An array of rule ids.

Returns:

- A Map containing the ruleids and rules.

Throws:

javax.management.JMException -

getAllRules

public java.util.Map getAllRules()
                          throws javax.management.JMException

This method fetches all the rules that has been configured in the designated EPL Proessor.

Returns:

- A Map consisting of rules names and rules

Throws:

javax.management.JMException -

getAllRulesInfo

public java.util.Map getAllRulesInfo()
                              throws javax.management.JMException

Returns all the rules configured for this processor along with all the information about the rules.

Returns:

Map where the key is the rule id. Map value are also Maps, where the keys that are Strings identify the configuration type for the rule (defined in enum RuleConfigParameters) and values are Objects with the configuration values.

Throws:

javax.management.JMException - on any error

deleteRule

public void deleteRule(java.lang.String id)
                throws javax.management.JMException

This method deletes a rule from the EPL Processor with the given rule id.

Parameters:

id- - A String which represents the rule-id

Throws:

javax.management.JMException -

deleteRules

public void deleteRules(java.lang.String[] ids)
                 throws javax.management.JMException

This method deletes all rules with the given ids.

Parameters:

ids- - A String array of ids to be deleted from the EPL Processor

Throws:

javax.management.JMException -

deleteAllRules

public void deleteAllRules()
                    throws javax.management.JMException

This methods deletes all rules that has been configured in the EPL Processor.

Throws:

javax.management.JMException -

startRule

public void startRule(java.lang.String id)
               throws javax.management.JMException

Starts a rule and makes it ready to process events

Parameters:

id - the identifier of the rule that is to be started

Throws:

javax.management.JMException - if an error occurs

stopRule

public void stopRule(java.lang.String id)
              throws javax.management.JMException

Stops a cql query or EPL rule so that it will not process incoming events anymore.

Parameters:

id - the identifier of the rule that is to be stopped

Throws:

javax.management.JMException - if an error occurs

isRuleStarted

public boolean isRuleStarted(java.lang.String id)
                      throws javax.management.JMException

Use this to find out whether rule is started and is processing events. Returns true if the rule is started, false otherwise.

Parameters:

id - the identifier of the rule for which start status is to be determined

Throws:

javax.management.JMException - on any error