Skip navigation links

com.bea.wlevs.management.configuration
Interface CQLProcessorMBean

public interface CQLProcessorMBean

extends ProcessorMBean

Inner Class Summary

static class

CQLProcessorMBean.FunctionParameter

Inner classes inherited from class com.bea.wlevs.management.configuration.ProcessorMBean

ProcessorMBean.RuleConfigParameters, ProcessorMBean.RuleType

Field Summary
static java.lang.String	MBEAN_TYPE

Method Summary
void	addParameters(java.lang.String preparedStatementId, java.lang.String paramsValue) This method binds a new set of parameter values against a parameterized query/view.
java.lang.String	addQuery(java.lang.String query) This method will add an CQL query to the designated CQL Processor.
void	addQuery(java.lang.String id, java.lang.String query) This method will add an CQL query with a name to the designated CQL Processor.
void	addQuery(java.lang.String id, java.lang.String query, boolean active) This method will add an CQL query with a name to the designated CQL Processor.
void	addQuery(java.lang.String id, java.lang.String query, boolean active, java.lang.String orderingConstraint, java.lang.String partitionExpression) This method adds an CQL query and configures its ordering constraint.
void	addTypeAlias(java.lang.String source, java.lang.String target) This method will add a type alias to the designated CQL Processor.
java.lang.String	addView(java.lang.String view) This method will add an CQL view to the designated CQL processor.
java.lang.String	addView(java.lang.String view, java.util.List viewSchema) This method will add an CQL query with a name to the designated CQL Processor.
void	addView(java.lang.String id, java.lang.String view) This method will add an CQL query with a name to the designated CQL Processor.
void	addView(java.lang.String id, java.lang.String view, java.util.List viewSchema) This method will add an CQL query with a name to the designated CQL Processor.
void	addView(java.lang.String id, java.lang.String view, java.util.List viewSchema, boolean active) This method will add an CQL view with a name to the designated CQL Processor.
void	addView(java.lang.String id, java.lang.String view, java.util.List viewSchema, java.lang.String orderingConstraint, java.lang.String partitionExpression) This method will add an CQL view with a name to the designated CQL Processor.
void	bindParameters(java.lang.String preparedStatementId, java.lang.String paramsId, java.lang.String paramsValue) This method binds a new set of named parameter values against a parameterized query/view.
void	deleteAllQueries() This methods deletes all queries that has been configured in the CQL Processor.
void	deleteAllViews() This methods deletes all views that have been configured in the CQL Processor.
void	deleteTypeAlias(java.lang.String source) This method will delete a type alias to the designated CQL Processor.
java.lang.String[]	getAllBoundParameterNames(java.lang.String preparedStatementId) This method returns the names of the bound parameters which are bound to a rule identified by the preparedStatementId argument.
java.util.Map	getAllBoundParameters(java.lang.String preparedStatementId) This method retrieves all parameter values for a parameterized query identified by the preparedStatementId argument.
java.util.Map	getAllFunctionsInfo() Returns all user defined functions that have been associated to this processor, possibly through the wlevs:function tag in the EPN assembly configuration file.
java.util.Map	getAllQueries() This method fetches all the queries in this processor.
java.util.Map	getAllQueriesInfo() Returns all the queries configured for this processor along with all the information about the queries.
java.util.Map	getAllViews() This method fetches all the views in this processor.
java.util.Map	getAllViewsInfo() Returns all the views configured for this processor along with all the information about the views.
java.lang.String	getBoundParameters(java.lang.String preparedStatementId, java.lang.String paramsId) This method retrieves the set of parameter values with the given name for a parameterized query identified by the preparedStatementId argument.
java.util.Set	getEventPropertyNamesForQuerySources(java.lang.String queryId) This method returns the property names for all sources referenced by the query.
java.util.Set	getEventPropertyNamesForViewSources(java.lang.String viewId) This method returns the property names for all sources referenced by the view.
int	getNumberOfBoundParameters(java.lang.String preparedStatementId) This method returns the number of bound parameters which are bound for the rule identified by the preparedStatementId argument.
java.util.Map	getTypeAliases() This method fetches all the aliases in this processor.
java.util.Map	getView(java.lang.String id) This method fetches a view with the given id.
java.util.Map	getViews(java.lang.String[] ids) This method fetches a set of views with the given ids.
void	replaceAllBoundParameters(java.lang.String preparedStatementId, java.lang.String[] paramsIds, java.lang.String[] newParamsValues) This method replaces all parameter values for a parameterized query identified by the ruleId argument with the parameter values provided.
void	replaceBoundParameters(java.lang.String preparedStatementId, java.lang.String paramsId, java.lang.String newParamsValue) This method replaces single parameter values for a parameterized query identified by the ruleId argument.
void	replaceQuery(java.lang.String id, java.lang.String query) Replaces the query string on the query with the specified id.
void	replaceQuery(java.lang.String id, java.lang.String query, java.lang.String orderingConstraint, java.lang.String partitionExpression) Replaces the query string on the query with the specified id.
void	replaceTypeAlias(java.lang.String source, java.lang.String target) This method will replace an existing alias of the type.
void	replaceView(java.lang.String id, java.lang.String view, java.util.List viewSchema) This method will replace an existing view by another view.
void	replaceView(java.lang.String id, java.lang.String view, java.util.List viewSchema, java.lang.String orderingConstraint, java.lang.String partitionExpression) This method will replace an existing view by another view.
void	unbindAllParameters(java.lang.String preparedStatementId) This method deletes or unbind all parameter values for the parameterized query identified by the ruleId argument.
void	unbindParameters(java.lang.String preparedStatementId, java.lang.String paramsId) This method deletes or unbind the named set of parameter values for the parameterized query identified by the ruleId argument.

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

addRule, addRule, addRule, addRules, deleteAllRules, deleteRule, deleteRules, downloadRules, getAllRules, getAllRulesInfo, getRule, getRules, isRuleStarted, replaceRule, replaceRules, startRule, stopRule, uploadRules, uploadRules

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

Field Detail

MBEAN_TYPE

public static final java.lang.String MBEAN_TYPE

Method Detail

addQuery

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

This method will add an CQL query to the designated CQL Processor.

Parameters:

query -

Returns:

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

Throws:

javax.management.JMException -

addQuery

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

This method will add an CQL query with a name to the designated CQL Processor.

Parameters:

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

query- - A String representing a query in CQL syntax

Throws:

OperationsException - - if rule with the same id already exists

addQuery

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

This method will add an CQL query with a name to the designated CQL Processor.

Parameters:

id - A String which has the name of the query

query - A String representing a query in CQL syntax

active - indicates if the rule should be started and ready to process events

Throws:

javax.management.JMException - if an error occurs

addQuery

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

This method adds an CQL query and configures its ordering constraint. By default, when a new query is created, it is configured to execute set with ordered constraint.

Parameters:

id - A String which has the name of the query

query - A String representing a query in CQL syntax

active - indicates if the rule should be started and ready to process events

orderingConstraint - String representation of the application's schema type OrderingConstraint

partitionExpression - String representation of expression to be used for ordered_per_partition option.

Throws:

javax.management.JMException - if ordering constraint does not exist, or if it cannot be configured.

replaceQuery

public void replaceQuery(java.lang.String id,
                         java.lang.String query,
                         java.lang.String orderingConstraint,
                         java.lang.String partitionExpression)
                  throws javax.management.JMException

Replaces the query string on the query with the specified id.

Parameters:

id - A String which has the name of the query

query - A String representing the new query in CQL syntax

orderingConstraint - String representation of the application's schema type OrderingConstraint

partitionExpression - String representation of expression to be used for ordered_per_partition option.

Throws:

javax.management.JMException - if ordering constraint does not exist, or if it cannot be configured.

replaceQuery

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

Replaces the query string on the query with the specified id.

Parameters:

id - A String which has the name of the query

query - A String representing the new query in CQL syntax

Throws:

javax.management.JMException - if an error occurs

getAllQueries

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

This method fetches all the queries in this processor.

Returns:

- A Map consisting of query ids and their statements.

Throws:

javax.management.JMException -

getAllQueriesInfo

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

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

Returns:

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

deleteAllQueries

public void deleteAllQueries()
                      throws javax.management.JMException

This methods deletes all queries that has been configured in the CQL Processor.

Throws:

javax.management.JMException -

addView

public java.lang.String addView(java.lang.String view)
                         throws javax.management.JMException

This method will add an CQL view to the designated CQL processor.

Parameters:

view -

Returns:

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

Throws:

javax.management.JMException -

addView

public void addView(java.lang.String id,
                    java.lang.String view)
             throws javax.management.JMException

This method will add an CQL query with a name to the designated CQL Processor.

Parameters:

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

view - - A String representing a view in CQL syntax

Throws:

OperationsException - - if rule with the same id already exists

addView

public java.lang.String addView(java.lang.String view,
                                java.util.List viewSchema)
                         throws javax.management.JMException

This method will add an CQL query with a name to the designated CQL Processor.

Parameters:

view - - A String representing a view in CQL syntax

viewSchema - - A list of tokens representing the column name for the view

Throws:

OperationsException - - if rule with the same id already exists

addView

public void addView(java.lang.String id,
                    java.lang.String view,
                    java.util.List viewSchema)
             throws javax.management.JMException

This method will add an CQL query with a name to the designated CQL Processor.

Parameters:

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

view - - A String representing a view in CQL syntax

viewSchema - - A list of tokens representing the column name for the view

Throws:

OperationsException - - if rule with the same id already exists

addView

public void addView(java.lang.String id,
                    java.lang.String view,
                    java.util.List viewSchema,
                    boolean active)
             throws javax.management.JMException

This method will add an CQL view with a name to the designated CQL Processor.

Parameters:

id - A String which has the name of the view

view - A String representing a view in CQL syntax

viewSchema - A list of tokens representing the column name for the view

active - Flag indicating if the view should be started and ready

Throws:

javax.management.JMException - On any error adding the view

addView

public void addView(java.lang.String id,
                    java.lang.String view,
                    java.util.List viewSchema,
                    java.lang.String orderingConstraint,
                    java.lang.String partitionExpression)
             throws javax.management.JMException

This method will add an CQL view with a name to the designated CQL Processor.

Parameters:

id - A String which has the name of the view

view - A String representing a view in CQL syntax

viewSchema - A list of tokens representing the column name for the view

orderingConstraint - String representation of the application's schema type OrderingConstraint

partitionExpression - String representation of expression to be used for ordered_per_partition option.

Throws:

javax.management.JMException - On any error adding the view

replaceView

public void replaceView(java.lang.String id,
                        java.lang.String view,
                        java.util.List viewSchema)
                 throws javax.management.JMException

This method will replace an existing view by another view. The original rule will be destroyed, and the new one inserted in its place.

Parameters:

id - - A String which has the id of the view

query- - A String representing a view in CQL syntax

Throws:

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

replaceView

public void replaceView(java.lang.String id,
                        java.lang.String view,
                        java.util.List viewSchema,
                        java.lang.String orderingConstraint,
                        java.lang.String partitionExpression)
                 throws javax.management.JMException

This method will replace an existing view by another view. The original rule will be destroyed, and the new one inserted in its place.

Parameters:

id - - A String which has the id of the view

query- - A String representing a view in CQL syntax

orderingConstraint - String representation of the application's schema type OrderingConstraint

partitionExpression - String representation of expression to be used for ordered_per_partition option.

Throws:

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

getView

public java.util.Map getView(java.lang.String id)
                      throws javax.management.JMException

This method fetches a view with the given id.

Parameters:

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

Returns:

view - A map of the view statement and the view schema.

Throws:

OperationsException - - if id is not found or if it is not a view

getViews

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

This method fetches a set of views with the given ids.

Parameters:

id - - A array of strings which represents the id of the views

Returns:

views - A map of ids and maps, which contain the view expression and its schema.

Throws:

OperationsException - - if id is not found or if it is not a view

getAllViews

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

This method fetches all the views in this processor.

Returns:

- A Map consisting of views ids and maps, which contain the view statement and its schema.

Throws:

javax.management.JMException -

getAllViewsInfo

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

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

Returns:

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

deleteAllViews

public void deleteAllViews()
                    throws javax.management.JMException

This methods deletes all views that have been configured in the CQL Processor.

Throws:

javax.management.JMException -

getAllFunctionsInfo

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

Returns all user defined functions that have been associated to this processor, possibly through the wlevs:function tag in the EPN assembly configuration file.

Returns:

Map where the key is the function name. Values are also Maps, where the keys map to the enumeration FunctionParameter, and the values are defined by the enumeration.

Throws:

javax.management.JMException -

addTypeAlias

public void addTypeAlias(java.lang.String source,
                         java.lang.String target)
                  throws javax.management.JMException

This method will add a type alias to the designated CQL Processor.

Parameters:

source- - Alias string

target- - destination string of the alias i.e. complete type string

Throws:

OperationsException - - if alias with the same source name already exists

deleteTypeAlias

public void deleteTypeAlias(java.lang.String source)
                     throws javax.management.JMException

This method will delete a type alias to the designated CQL Processor.

Parameters:

source- - Alias string

Throws:

OperationsException - - if alias with the same source name already exists

replaceTypeAlias

public void replaceTypeAlias(java.lang.String source,
                             java.lang.String target)
                      throws javax.management.JMException

This method will replace an existing alias of the type. The original alias with name source will be deleted and new definition of the alias will be defined.

Parameters:

source- - Alias string

target- - destination string of the alias i.e. complete type string

Throws:

OperationsException - - if alias with the source name does not exist

getTypeAliases

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

This method fetches all the aliases in this processor.

Returns:

- A Map consisting of alias source and their target

Throws:

javax.management.JMException -

addParameters

public void addParameters(java.lang.String preparedStatementId,
                          java.lang.String paramsValue)
                   throws javax.management.JMException

This method binds a new set of parameter values against a parameterized query/view. It is similar to bindParameters(id,null,value), however is named following the more standard convention of addAttribute.

A parameterized query/view is a query/view containing parameters, where a parameter is specified as ':n', n being greater-or-equal to 1. Parameters cannot be duplicates, but do not need to be in order. For example, the following is a valid parameterized query: "select :1 from :3 where :2 like :4".

If a set of parameter values already exists for the parameterized query with the given name, then it will be replaced. Otherwise, a new set of parameter values will be added with the given name.

The bound rule will be named as: preparedStatementId '_' paramsId. For example, if the preparedStatementId is 'Q1' and the paramsId is 'P1', then the instantiated rule is named 'Q1_P1'. An exception is raised should a query named 'Q1_P1' already exist.

Parameters:

preparedStatementId - identifier of parameterized query.

paramsId - Identifier for the set of parameter values.

paramsValue - comma separated string of parameter values to bind against parameterized query.

Throws:

javax.management.JMException -

bindParameters

public void bindParameters(java.lang.String preparedStatementId,
                           java.lang.String paramsId,
                           java.lang.String paramsValue)
                    throws javax.management.JMException

This method binds a new set of named parameter values against a parameterized query/view.

A parameterized query/view is a query/view containing parameters, where a parameter is specified as ':n', n being greater-or-equal to 1. Parameters cannot be duplicates, but do not need to be in order. For example, the following is a valid parameterized query: "select :1 from :3 where :2 like :4".

If a set of parameter values already exists for the parameterized query with the given name, then it will be replaced. Otherwise, a new set of parameter values will be added with the given name.

The bound rule will be named as: preparedStatementId '_' paramsId. For example, if the preparedStatementId is 'Q1' and the paramsId is 'P1', then the instantiated rule is named 'Q1_P1'. An exception is raised should a query named 'Q1_P1' already exist.

Parameters:

preparedStatementId - identifier of parameterized query.

paramsId - Identifier for the set of parameter values.

paramsValue - comma separated string of parameter values to bind against parameterized query.

Throws:

javax.management.JMException -

replaceBoundParameters

public void replaceBoundParameters(java.lang.String preparedStatementId,
                                   java.lang.String paramsId,
                                   java.lang.String newParamsValue)
                            throws javax.management.JMException

This method replaces single parameter values for a parameterized query identified by the ruleId argument. The paramsNames argument specifies a parallel array of names for each set of parameter values where a null element causes the corresponding set of parameter values to be unnamed.

Parameters:

preparedStatementId - identifier of parameterized query.

paramsId - String identifier for parameter name or old parameter value

newParamsValue - new String parameter value to bind against parameterized query.

Throws:

javax.management.JMException -

replaceAllBoundParameters

public void replaceAllBoundParameters(java.lang.String preparedStatementId,
                                      java.lang.String[] paramsIds,
                                      java.lang.String[] newParamsValues)
                               throws javax.management.JMException

This method replaces all parameter values for a parameterized query identified by the ruleId argument with the parameter values provided. The parameter values will be unnamed.

Parameters:

preparedStatementId - identifier of parameterized query.

paramsIds - String array defining the identifier for each parameterized value set.

newParamsValues - String array of comma separated parameter value sets to bind against parameterized query.

Throws:

javax.management.JMException -

unbindParameters

public void unbindParameters(java.lang.String preparedStatementId,
                             java.lang.String paramsId)
                      throws javax.management.JMException

This method deletes or unbind the named set of parameter values for the parameterized query identified by the ruleId argument.

Parameters:

preparedStatementId - identifier of parameterized query.

paramsId - String identifier of parameter values.

Throws:

javax.management.JMException -

unbindAllParameters

public void unbindAllParameters(java.lang.String preparedStatementId)
                         throws javax.management.JMException

This method deletes or unbind all parameter values for the parameterized query identified by the ruleId argument.

Parameters:

preparedStatementId - identifier of parameterized query.

Throws:

javax.management.JMException -

getBoundParameters

public java.lang.String getBoundParameters(java.lang.String preparedStatementId,
                                           java.lang.String paramsId)
                                    throws javax.management.JMException

This method retrieves the set of parameter values with the given name for a parameterized query identified by the preparedStatementId argument.

Parameters:

preparedStatementId - identifier of parameterized query.

paramsId - name of parameter values.

Returns:

String of comma separated parameter values.

Throws:

javax.management.JMException -

getAllBoundParameters

public java.util.Map getAllBoundParameters(java.lang.String preparedStatementId)
                                    throws javax.management.JMException

This method retrieves all parameter values for a parameterized query identified by the preparedStatementId argument.

Parameters:

preparedStatementId - identifier of parameterized query.

Returns:

Map of parameter names and parameter values.

Throws:

javax.management.JMException -

getNumberOfBoundParameters

public int getNumberOfBoundParameters(java.lang.String preparedStatementId)
                               throws javax.management.JMException

This method returns the number of bound parameters which are bound for the rule identified by the preparedStatementId argument. If the rule is not parameterized, then a value of zero will be returned.

Parameters:

preparedStatementId - A string which represents the id of the rule

Returns:

the number of parameters which must be bound or zero if the rule is not parameterized.

Throws:

javax.management.JMException -

getAllBoundParameterNames

public java.lang.String[] getAllBoundParameterNames(java.lang.String preparedStatementId)
                                             throws javax.management.JMException

This method returns the names of the bound parameters which are bound to a rule identified by the preparedStatementId argument.

Parameters:

preparedStatementId - A String which represents the id of the rule.

Returns:

The names of the parameters bound

Throws:

javax.management.JMException -

getEventPropertyNamesForQuerySources

public java.util.Set getEventPropertyNamesForQuerySources(java.lang.String queryId)
                                                   throws javax.management.JMException

This method returns the property names for all sources referenced by the query. For example, in a expression select * from S, where S is defined as a stream of the event type 'String a, String b', this method would return a set containing the Strings 'a' and 'b'.

Parameters:

queryId - The string representing the id of a query

Returns:

Set of all property names for the query sources.

Throws:

javax.management.JMException - if no query is found for queryId

getEventPropertyNamesForViewSources

public java.util.Set getEventPropertyNamesForViewSources(java.lang.String viewId)
                                                  throws javax.management.JMException

This method returns the property names for all sources referenced by the view. For example, in a expression select * from S, where S is defined as a stream of the event type 'String a, String b', this method would return a set containing the Strings 'a' and 'b'.

Parameters:

viewId - The string representing the id of a view

Returns:

Set of all property names for the view sources.

Throws:

javax.management.JMException - if no view is found for viewId