org.apache.unomi.rest.endpoints

Class RulesServiceEndPoint

java.lang.Object

org.apache.unomi.rest.endpoints.RulesServiceEndPoint

@Produces(value="application/json")
 @Consumes(value="application/json")
 @Path(value="/rules")
public class RulesServiceEndPoint
extends Object

A JAX-RS endpoint to manage Rules.

Constructor Summary

Constructors

Constructor and Description
RulesServiceEndPoint()

Method Summary

Modifier and Type	Method and Description
Map<String,RuleStatistics>	getAllRuleStatistics() Retrieves the rule statistics for all known rules.
Rule	getRule(String ruleId) Retrieves the rule identified by the specified identifier.
PartialList<Rule>	getRuleDetails(Query query) Retrieves rule details for rules matching the specified query.
Set<Metadata>	getRuleMetadatas() Retrieves the metadata for all known rules.
PartialList<Metadata>	getRuleMetadatas(Query query) Retrieves rule metadatas for rules matching the specified Query.
RuleStatistics	getRuleStatistics(String ruleId) Retrieves the statistics for the rule with the specified identifier
void	removeRule(String ruleId) Deletes the rule identified by the specified identifier.
void	resetAllRuleStatistics() Deletes all the rule statistics, which basically resets them to 0.
void	resetQueries() Deprecated. As of version 1.1.0-incubating, not needed anymore
void	setRule(Rule rule) Persists the specified rule to the context server.
void	setRulesService(RulesService rulesService)

Methods inherited from class java.lang.Object

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

Constructor Detail

RulesServiceEndPoint

public RulesServiceEndPoint()

Method Detail

setRulesService

public void setRulesService(RulesService rulesService)

getRuleMetadatas

@GET
 @Path(value="/")
public Set<Metadata> getRuleMetadatas()

Retrieves the metadata for all known rules.

Returns:

the Set of known metadata

setRule

@POST
 @Path(value="/")
public void setRule(Rule rule)

Persists the specified rule to the context server.

Parameters:

rule - the rule to be persisted

getAllRuleStatistics

@GET
 @Path(value="/statistics")
public Map<String,RuleStatistics> getAllRuleStatistics()

Retrieves the rule statistics for all known rules.

Returns:

a map that contains the rule key as a key and as the value a @RuleStatistics object.

resetAllRuleStatistics

@DELETE
 @Path(value="/statistics")
public void resetAllRuleStatistics()

Deletes all the rule statistics, which basically resets them to 0.

getRuleMetadatas

@POST
 @Path(value="/query")
public PartialList<Metadata> getRuleMetadatas(Query query)

Retrieves rule metadatas for rules matching the specified Query.

Parameters:

query - the query the rules which metadata we want to retrieve must match

Returns:

a PartialList of rules metadata for the rules matching the specified query

getRuleDetails

@POST
 @Path(value="/query/detailed")
public PartialList<Rule> getRuleDetails(Query query)

Retrieves rule details for rules matching the specified query.

Parameters:

query - the query specifying which rules to retrieve

Returns:

a PartialList of rule details for the rules matching the specified query

getRule

@GET
 @Path(value="/{ruleId}")
public Rule getRule(@PathParam(value="ruleId")
                                                   String ruleId)

Retrieves the rule identified by the specified identifier.

Parameters:

ruleId - the identifier of the rule we want to retrieve

Returns:

the rule identified by the specified identifier or null if no such rule exists.

getRuleStatistics

@GET
 @Path(value="/{ruleId}/statistics")
public RuleStatistics getRuleStatistics(@PathParam(value="ruleId")
                                                                                  String ruleId)

Retrieves the statistics for the rule with the specified identifier

Parameters:

ruleId - the identifier of the rule we want to retrieve

Returns:

the statistics for the specified rule or null if no such rule exists.

removeRule

@DELETE
 @Path(value="/{ruleId}")
public void removeRule(@PathParam(value="ruleId")
                                                         String ruleId)

Deletes the rule identified by the specified identifier.

Parameters:

ruleId - the identifier of the rule we want to delete

resetQueries

@Deprecated
 @GET
 @Path(value="/resetQueries")
public void resetQueries()

Deprecated. As of version 1.1.0-incubating, not needed anymore

TODO: remove