com.xatkit.core.platform.io

Class JsonEventMatcher

java.lang.Object

com.xatkit.core.platform.io.JsonEventMatcher

public class JsonEventMatcher
extends Object

A matcher that creates EventInstances from Json webhook calls.

This class is configured through the addMatchableEvent(HeaderValue, FieldValue, String) method, that allows to specify an EventInstance type for a given header and field content. Matched requests are reified into EventInstances containing all the fields of the provided payload.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonEventMatcher.FieldValue A pair representing a field value to match.
static class	JsonEventMatcher.HeaderValue A pair representing a Header value to match.

Field Summary

Fields

Modifier and Type	Field and Description
protected EventInstanceBuilder	eventInstanceBuilder The EventInstanceBuilder used to reify the received payloads into EventInstances.
protected Map<JsonEventMatcher.HeaderValue,Map<JsonEventMatcher.FieldValue,String>>	matchableEvents The internal Map used to store the header and field values to match.
static String	PRINT_BUILDER_CONTENT_KEY The Configuration key to store whether to print the EventInstanceBuilder content before building the matched EventInstance.
protected boolean	printBuilder A flag telling whether to print the EventInstanceBuilder content before building the matched EventInstance.

Constructor Summary

Constructors

Constructor and Description
JsonEventMatcher(EventInstanceBuilder eventInstanceBuilder, Configuration configuration) Constructs a new JsonEventMatcher with the provided EventInstanceBuilder.

Method Summary

Modifier and Type	Method and Description
void	addMatchableEvent(JsonEventMatcher.HeaderValue headerValue, JsonEventMatcher.FieldValue fieldValue, String eventTypeName) Registers a new EventInstance to match from the provided headerValue and fieldValue.
protected void	convertJsonObjectToOutContext(com.google.gson.JsonObject jsonObject, EventInstanceBuilder builder) Converts the provided jsonObject's fields into out context values set in the provided builder.
protected void	convertJsonObjectToOutContext(String parentKey, com.google.gson.JsonObject jsonObject, EventInstanceBuilder builder) Converts the provided jsonObject's field into out context values set in the provided builder.
protected com.xatkit.intent.EventInstance	createEventInstance(String eventDefinitionName, com.google.gson.JsonElement content) Creates an EventInstance from the provided eventDefinitionName and content.
com.xatkit.intent.EventInstance	match(List<org.apache.http.Header> headers, com.google.gson.JsonElement content) Matches the provided headers and content against the registered EventInstances.

Methods inherited from class java.lang.Object

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

Field Detail

PRINT_BUILDER_CONTENT_KEY

public static final String PRINT_BUILDER_CONTENT_KEY

The Configuration key to store whether to print the EventInstanceBuilder content before building the matched EventInstance.

This value is set to false if not specified.

See Also:

DEFAULT_PRINT_BUILDER_CONTENT, Constant Field Values

matchableEvents

protected Map<JsonEventMatcher.HeaderValue,Map<JsonEventMatcher.FieldValue,String>> matchableEvents

The internal Map used to store the header and field values to match.

eventInstanceBuilder

protected EventInstanceBuilder eventInstanceBuilder

The EventInstanceBuilder used to reify the received payloads into EventInstances.

printBuilder

protected boolean printBuilder

A flag telling whether to print the EventInstanceBuilder content before building the matched EventInstance.

Constructor Detail

JsonEventMatcher

public JsonEventMatcher(EventInstanceBuilder eventInstanceBuilder,
                        Configuration configuration)

Constructs a new JsonEventMatcher with the provided EventInstanceBuilder.

Parameters:

eventInstanceBuilder - the EventInstanceBuilder used to reify the received payloads into EventInstances.

configuration - the Configuration used to customize the JsonEventMatcher

Throws:

NullPointerException - if the provided eventInstanceBuilder is null

Method Detail

addMatchableEvent

public void addMatchableEvent(JsonEventMatcher.HeaderValue headerValue,
                              JsonEventMatcher.FieldValue fieldValue,
                              String eventTypeName)

Registers a new EventInstance to match from the provided headerValue and fieldValue.

Parameters:

headerValue - the JsonEventMatcher.HeaderValue to match the received request against

fieldValue - the JsonEventMatcher.FieldValue to match the received payload against

eventTypeName - the type of the EventInstance to return

Throws:

NullPointerException - if the provided headerValue, fieldValue, or eventTypeName is null

XatkitException - if the provided headerValue and fieldValue are already associated to another eventTypeName, or if calling this method would associate the JsonEventMatcher.FieldValue.EMPTY_FIELD_VALUE and specialized JsonEventMatcher.FieldValues to the provided headerValue.

See Also:

JsonEventMatcher.HeaderValue, JsonEventMatcher.FieldValue, JsonEventMatcher.FieldValue.EMPTY_FIELD_VALUE

match

public com.xatkit.intent.EventInstance match(List<org.apache.http.Header> headers,
                                             com.google.gson.JsonElement content)

Matches the provided headers and content against the registered EventInstances.

This method first iterates the provided headers and look for each registered one if the provided content contains a registered field. If at least one header and one field of the content are matched the corresponding EventInstance is returned.

Note:

the current implementation only check top-level field from the provided content. (see #139)

Parameters:

headers - the list containing the Headers to match

content - the JsonElement representing the content of the request

Returns:

the matched EventInstance if it exists, null otherwise

Throws:

NullPointerException - if the provided headers or content is null

createEventInstance

protected com.xatkit.intent.EventInstance createEventInstance(String eventDefinitionName,
                                                              com.google.gson.JsonElement content)

Creates an EventInstance from the provided eventDefinitionName and content.

The built EventInstance is associated to the EventDefinition matching the given eventDefinitionName if it exists, and its out contexts are set with the fields of the provided content JsonElement.

Note that the built EventInstance contains all the fields containing literal values of the provided content, formatted by the convertJsonObjectToOutContext(JsonObject, EventInstanceBuilder) method.

Parameters:

eventDefinitionName - the name of the EventDefinition to create an EventInstance from

content - the JsonElement to set as the created EventInstance out context

Returns:

an EventInstance matching the provided eventDefinitionName and containing the content out context values.

Throws:

NullPointerException - if the provided eventDefinitionName or content is null

See Also:

convertJsonObjectToOutContext(JsonObject, EventInstanceBuilder)

convertJsonObjectToOutContext

protected void convertJsonObjectToOutContext(com.google.gson.JsonObject jsonObject,
                                             EventInstanceBuilder builder)

Converts the provided jsonObject's fields into out context values set in the provided builder.

This method formats the jsonObject fields following this pattern:

• Top-level field names are reused to set out context keys (e.g. "content")
• Contained field names are prefixed by '_', followed by their containing field name (e.g. "content_field1")
• Only fields containing literal values are set in the EventInstance's out context

This method is a convenience wrapper for convertJsonObjectToOutContext(String, JsonObject, EventInstanceBuilder) with the empty string as its first parameter.

Note: this method does not handle JsonArrays for now (see #141)

Parameters:

jsonObject - the JsonObject to extract the fields from

builder - the EventInstanceBuilder used to set out context values

Throws:

NullPointerException - if the provided jsonObject or builder is null

See Also:

convertJsonObjectToOutContext(String, JsonObject, EventInstanceBuilder)

convertJsonObjectToOutContext

protected void convertJsonObjectToOutContext(String parentKey,
                                             com.google.gson.JsonObject jsonObject,
                                             EventInstanceBuilder builder)

Converts the provided jsonObject's field into out context values set in the provided builder.

This method formats the jsonObject fields following this pattern:

• Top-level field names are reused to set out context keys (e.g. "content")
• Contained field names are prefixed by '_', followed by their containing field name (e.g. "content_field1")
• Only fields containing literal values are set in the EventInstance's out context

Note: this method does not handle JsonArrays for now (see #141)

Parameters:

parentKey - the key of the parent of the provided jsonObject

jsonObject - the JsonObject to extract the fields from

builder - the EventInstanceBuilder used to set out context values

Throws:

NullPointerException - if the provided parentKey, jsonObject, or builder is null