com.marklogic.client.alerting

Interface RuleManager

public interface RuleManager

Manages CRUD of rules for the REST API alerting capability, as well as match operations against installed rules.

Method Summary

Modifier and Type	Method and Description
void	delete(String ruleName) Removes a rule from the server.
boolean	exists(String ruleName) Tests for existence of rule on the REST server.
<T extends RuleListReadHandle> T	match(QueryDefinition docQuery, long start, long pageLength, String[] candidateRules, T ruleListHandle) Matches server rules based on results of a search, with pagination applied to search.
<T extends RuleListReadHandle> T	match(QueryDefinition docQuery, long start, long pageLength, String[] candidateRules, T ruleListHandle, ServerTransform transform) Matches server rules based on results of a search, with pagination applied to search.
<T extends RuleListReadHandle> T	match(QueryDefinition docQuery, T ruleListHandle) Matches server rules based on the results of a search.
<T extends RuleListReadHandle> T	match(String[] docIds, String[] candidateRules, T ruleListHandle) Matches server rules based on an array of document IDs and an array of rule names.
<T extends RuleListReadHandle> T	match(String[] docIds, String[] candidateRules, T ruleListHandle, ServerTransform transform) Matches server rules based on an array of document IDs and an array of rule names.
<T extends RuleListReadHandle> T	match(String[] docIds, T ruleListHandle) Matches server rules based on an array of document IDS.
<T extends RuleListReadHandle> T	match(StructureWriteHandle document, String[] candidateRules, T ruleListHandle) Matches server rules based on a document supplied in a write handle.
<T extends RuleListReadHandle> T	match(StructureWriteHandle document, String[] candidateRules, T ruleListHandle, ServerTransform transform) Matches server rules based on a document supplied in a write handle.
<T extends RuleListReadHandle> T	match(StructureWriteHandle document, T ruleListHandle) Matches server rules based on a document supplied in a write handle.
<T extends RuleListReadHandle> T	matchAs(Object content, String[] candidateRules, T ruleListHandle) Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.
<T extends RuleListReadHandle> T	matchAs(Object content, String[] candidateRules, T ruleListHandle, ServerTransform transform) Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.
<T extends RuleListReadHandle> T	matchAs(Object content, T ruleListHandle) Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.
<T extends RuleReadHandle> T	readRule(String ruleName, T readHandle) Reads a rule from the server into the provided handle.
<T> T	readRuleAs(String ruleName, Class<T> as) Reads a rule from the server in an XML representation provided as an object of an IO class.
void	writeRule(RuleDefinition writeHandle) Writes a rule to the server from the provided handle.
void	writeRule(String ruleName, RuleWriteHandle writeHandle) Writes a rule to the server from the provided handle.
void	writeRuleAs(String ruleName, Object ruleSource) Writes a rule to the server in an XML representation provided as an object of an IO class.

Method Detail

exists

boolean exists(String ruleName)

Tests for existence of rule on the REST server.

Parameters:

ruleName - Name of the rule

Returns:

true if rule exists, false otherwise.

readRuleAs

<T> T readRuleAs(String ruleName,
                 Class<T> as)
          throws ResourceNotFoundException,
                 ForbiddenUserException,
                 FailedRequestException

Reads a rule from the server in an XML representation provided as an object of an IO class.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

ruleName - name of rule on REST server

as - the IO class for reading the rule

Returns:

an object of the IO class with the rule

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

readRule

<T extends RuleReadHandle> T readRule(String ruleName,
                                      T readHandle)
                               throws ResourceNotFoundException,
                                      ForbiddenUserException,
                                      FailedRequestException

Reads a rule from the server into the provided handle.

Type Parameters:

T - the type of RuleReadHandle to return

Parameters:

ruleName - Name of rule on REST server.

readHandle - Handle that will accept the rule payload. Often will be an instance of RuleDefinition.

Returns:

Handle or object that models the rule.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeRuleAs

void writeRuleAs(String ruleName,
                 Object ruleSource)
          throws ResourceNotFoundException,
                 ForbiddenUserException,
                 FailedRequestException

Writes a rule to the server in an XML representation provided as an object of an IO class.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Parameters:

ruleName - name of rule on REST server

ruleSource - an IO representation of the rule

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeRule

void writeRule(RuleDefinition writeHandle)
        throws ResourceNotFoundException,
               ForbiddenUserException,
               FailedRequestException

Writes a rule to the server from the provided handle.

Parameters:

writeHandle - Handle that contains the rule payload. Must be a RuleDefinition object to use this method, which has no ruleName.

Throws:

ResourceNotFoundException

ForbiddenUserException

FailedRequestException

writeRule

void writeRule(String ruleName,
               RuleWriteHandle writeHandle)

Writes a rule to the server from the provided handle.

Parameters:

ruleName - Name of rule on REST server.

writeHandle - Handle that contains the rule payload. Often will be an instance of RuleDefinition.

delete

void delete(String ruleName)
     throws ForbiddenUserException,
            FailedRequestException

Removes a rule from the server.

Parameters:

ruleName - Name of rule on REST server.

Throws:

ForbiddenUserException

FailedRequestException

match

<T extends RuleListReadHandle> T match(QueryDefinition docQuery,
                                       T ruleListHandle)

Matches server rules based on the results of a search.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

docQuery - A query definition to qualify documents to match.

ruleListHandle - A handle to hold the match results.

Returns:

The List of rules matched by the documents returned by this query.

match

<T extends RuleListReadHandle> T match(QueryDefinition docQuery,
                                       long start,
                                       long pageLength,
                                       String[] candidateRules,
                                       T ruleListHandle)

Matches server rules based on results of a search, with pagination applied to search. Use this method to match, say, a page or search results against rules.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

docQuery - A query definition to qualify documents to match.

start - The start position in query results to match.

pageLength - The number of results in the filtering query to match. Use null to return all matches.

candidateRules - An array of rule names to return in matches. Null matches all rules.

ruleListHandle - A handle to hold the match results.

Returns:

The list of rules matched by the documents returned by the query.

match

<T extends RuleListReadHandle> T match(QueryDefinition docQuery,
                                       long start,
                                       long pageLength,
                                       String[] candidateRules,
                                       T ruleListHandle,
                                       ServerTransform transform)

Matches server rules based on results of a search, with pagination applied to search. Use this method to match, say, a page or search results against rules.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

docQuery - A query definition to qualify documents to match.

start - The start position in query results to match.

pageLength - The number of results in the filtering query to match. Use null to return all matches.

candidateRules - An array of rule names to return in matches. A zero-length array matches all rules.

ruleListHandle - A handle to hold the match results.

transform - a server transform to modify the rule list payload.

Returns:

The list of rules matched by the documents returned by the query.

match

<T extends RuleListReadHandle> T match(String[] docIds,
                                       T ruleListHandle)

Matches server rules based on an array of document IDS.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

docIds - An array of document IDs to match against.

ruleListHandle - A handle to hold the match results.

Returns:

The union of all rules matched by the document ids provided.

match

<T extends RuleListReadHandle> T match(String[] docIds,
                                       String[] candidateRules,
                                       T ruleListHandle)

Matches server rules based on an array of document IDs and an array of rule names.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

docIds - An array of document IDs to match against.

candidateRules - An array of rule names to return in matches. A zero-length array matches all rules.

ruleListHandle - A handle to hold the match results

Returns:

The union of rules in candidateRules matched by the document ids provided.

match

<T extends RuleListReadHandle> T match(String[] docIds,
                                       String[] candidateRules,
                                       T ruleListHandle,
                                       ServerTransform transform)

Matches server rules based on an array of document IDs and an array of rule names.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

docIds - An array of document IDs to match against.

candidateRules - An array of rule names to return in matches. A zero-length array matches all rules.

ruleListHandle - A handle to hold the match results.

transform - a server transform to modify the rule list payload.

Returns:

The union of rules in candidateRules matched by the document ids provided.

matchAs

<T extends RuleListReadHandle> T matchAs(Object content,
                                         T ruleListHandle)

Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

content - an IO representation of the document to match against rules

ruleListHandle - a handle to hold the match results

Returns:

the union of rules matched by the document provided

matchAs

<T extends RuleListReadHandle> T matchAs(Object content,
                                         String[] candidateRules,
                                         T ruleListHandle)

Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Type Parameters:

T - the type of object that will be returned by the handle registered for it

Parameters:

content - an IO representation of the document to match against rules

candidateRules - an array of rule names to match. A zero-length array matches all rules.

ruleListHandle - a handle to hold the match results

Returns:

the union of rules matched by the document provided

matchAs

<T extends RuleListReadHandle> T matchAs(Object content,
                                         String[] candidateRules,
                                         T ruleListHandle,
                                         ServerTransform transform)

Matches server rules based on a document supplied in a textual representation provided as an object of an IO class.

The IO class must have been registered before creating the database client. By default, the provided handles that implement ContentHandle are registered.

Learn more about shortcut methods

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

content - an IO representation of the document to match against rules

candidateRules - an array of rule names to match. A zero-length array matches all rules.

ruleListHandle - a handle to hold the match results

transform - a server transform to modify the rule list payload

Returns:

the union of rules matched by the document provided

match

<T extends RuleListReadHandle> T match(StructureWriteHandle document,
                                       T ruleListHandle)

Matches server rules based on a document supplied in a write handle.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

document - A document payload to match against rules.

ruleListHandle - A handle to hold the match results.

Returns:

The union of rules matched by the document provided.

match

<T extends RuleListReadHandle> T match(StructureWriteHandle document,
                                       String[] candidateRules,
                                       T ruleListHandle)

Matches server rules based on a document supplied in a write handle.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

document - A document payload to match against rules.

candidateRules - An array of rule names to match. A zero-length array matches all rules.

ruleListHandle - A handle to hold the match results

Returns:

The union of rules in candidateRules matched by the document.

match

<T extends RuleListReadHandle> T match(StructureWriteHandle document,
                                       String[] candidateRules,
                                       T ruleListHandle,
                                       ServerTransform transform)

Matches server rules based on a document supplied in a write handle.

Type Parameters:

T - the type of RuleListReadHandle to return

Parameters:

document - A document payload to match against rules.

candidateRules - An array of rule names to match. A zero-length array matches all rules.

ruleListHandle - A handle to hold the match results.

transform - a server transform to modify the rule list payload.

Returns:

The union of rules in candidateRules matched by the document.