Class BotRule

java.lang.Object

org.frontcache.bots.BotRule

public class BotRule
extends Object

One classification rule from conf/bots.conf: name | condition | verdict [| dry-run]. The verdict is a CLIENT TYPE - bot or guest, nothing else. It is not a judgement about the client: it selects a behaviour profile (which branch of a WebResponse's expireTimeMap applies, so a different TTL or a cached response vs. an origin call, and whether an <fc:include client="..."> fragment is resolved). Guard rules can read it back through their client-type: predicate, but that is one consumer among several, not the purpose. Deliberately shaped like GuardRule, hit counter included: an operator who has read the Guard Rules screen should need no second explanation for this one.

Constructor Summary

Constructors

Constructor	Description
BotRule(String name, List<GuardPredicate> predicates, String clientType, boolean dryRun)

Method Summary

Modifier and Type	Method	Description
void	countHit()
String	getClientType()	bot or guest
String	getCondition()
long	getHits()
String	getName()
List<GuardPredicate>	getPredicates()
boolean	isDryRun()
boolean	matches(RequestContext context)
BotRuleEntry	toEntry()
String	toString()

Methods inherited from class Object

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

Constructor Details

BotRule

public BotRule(String name,
 List<GuardPredicate> predicates,
 String clientType,
 boolean dryRun)

Method Details

matches

public boolean matches(RequestContext context)

Returns:

true when EVERY predicate holds (predicates are AND-ed, evaluation short-circuits)

getName

public String getName()

getPredicates

public List<GuardPredicate> getPredicates()

getClientType

public String getClientType()

bot or guest

isDryRun

public boolean isDryRun()

getHits

public long getHits()

countHit

public void countHit()

getCondition

public String getCondition()

toEntry

public BotRuleEntry toEntry()

Returns:

flat, JSON-friendly snapshot of this rule for the management API and the console

toString

public String toString()

Overrides:

toString in class Object