com.redhat.lightblue.hooks

Class HookManager

java.lang.Object

com.redhat.lightblue.hooks.HookManager

public class HookManager
extends Object

This class manages hooks. As operations are performed, queueHooks() is called to queue up hooks for successfully processed documents. Once operations are complete and changes are committed, callQueuedHooks is called to execute all hooks that were queued. The queues are executed in the order they are queued, but the hooks for a single document can be executed in a non-deterministic order. Each hook receives a list containing pre- and post- update versions of the documents. If there are multiple hooks for the given operation, the hooks of that operation share the document copies. Because of this, hooks must treat documents as read-only.

Constructor Summary

Constructors

Constructor and Description
HookManager(HookResolver r, com.fasterxml.jackson.databind.node.JsonNodeFactory factory) Construct hooks with the given hook resolver

Method Summary

Methods

Modifier and Type	Method and Description
void	callQueuedHooks() Calls all queued hooks, and then clears the queued hooks.
void	clear() Clears all queued hooks
void	queueHooks(CRUDOperationContext ctx) Queues hooks for the operation represented by the operation context.
void	queueMediatorHooks(CRUDOperationContext ctx) Queues mediator hooks for the operation represented by the operation context.

Methods inherited from class java.lang.Object

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

Constructor Detail

HookManager

public HookManager(HookResolver r,
           com.fasterxml.jackson.databind.node.JsonNodeFactory factory)

Construct hooks with the given hook resolver

Method Detail

clear

public void clear()

Clears all queued hooks

queueHooks

public void queueHooks(CRUDOperationContext ctx)

Queues hooks for the operation represented by the operation context.

Parameters:

ctx - Operation context This will create copies of all the documents that has no errors in the context, and save them for later hook execution.

queueMediatorHooks

public void queueMediatorHooks(CRUDOperationContext ctx)

Queues mediator hooks for the operation represented by the operation context.

Parameters:

ctx - Operation context This operation will only queue mediator hooks. This will create copies of all the documents that has no errors in the context, and save them for later hook execution.

callQueuedHooks

public void callQueuedHooks()

Calls all queued hooks, and then clears the queued hooks. Any hook that failed will be logged, but hook execution will continue unless one of the hooks throws an exception with @StopHookProcessing annotation.