com.exalead.access.feedapi

Interface FeedTrigger

All Known Subinterfaces:

PageFeedTrigger

public interface FeedTrigger

Feed Trigger interface: A Feed Trigger is an entry point to alter the behavior of a Feed. It is called before and after the feed execution, allowing for query manipulation, context modification and result manipulation. IMPORTANT: Feed Triggers are shared across request and thus MUST be both stateless and threadsafe. If you need to keep states between the beforeQuery call and the afterQuery call, you can store the variables in the QueryContext: beforeQuery: context.setVariable("myComputedScore", 42); afterQuery: context.getVariable("myComputedScore");

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FeedTrigger.BeforeSubfeedAware A Trigger that implements BeforeSubfeedAware will receive an additional event after its execute() method, but before the sub feeds processing.
static interface	FeedTrigger.LifecycleAware
static class	FeedTrigger.Result

Method Summary

Modifier and Type	Method and Description
FeedTrigger.Result	afterQuery(Feed feed, QueryContext context, ResultFeed resultFeed) After Feed Execution call.
FeedTrigger.Result	beforeQuery(Feed feed, QueryContext context) Before Feed Execution call.

Method Detail

beforeQuery

FeedTrigger.Result beforeQuery(Feed feed,
                               QueryContext context)
                        throws AccessException

Before Feed Execution call. Return Result.STOP to skip the evaluation of the feed, Result.CONTINUE for the normal behavior.

Parameters:

feed -

context -

Throws:

AccessException

afterQuery

FeedTrigger.Result afterQuery(Feed feed,
                              QueryContext context,
                              ResultFeed resultFeed)
                       throws AccessException

After Feed Execution call. Return Result.CONTINUE for the normal behavior, or Result.EVAL_AGAIN to re-execute the feed after overriding a few parameters.

Parameters:

feed -

context -

Throws:

AccessException