Package org.forgerock.audit.util

Class ElasticsearchUtil

java.lang.Object

org.forgerock.audit.util.ElasticsearchUtil

public final class ElasticsearchUtil
extends Object

Utilities for working with Elasticsearch.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	FIELD_NAMES_FIELD	JSON field-name of normalized field-names.
protected static String	NORMALIZED_FIELD	JSON field-name of metadata to assist in de-normalization.
static com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER	Jackson ObjectMapper for working with JSON.

Method Summary

Modifier and Type	Method	Description
static JsonValue	denormalizeJson(JsonValue value)	De-normalizes JSON that was previously normalized by normalizeJson(JsonValue).
static String	normalizeJson(JsonValue value)	Normalizes JSON to conform to Elasticsearch data-format restrictions.
static JsonPointer	normalizeJsonPointer(JsonPointer ptr)	Replaces periods in JsonPointer keys with underscore.
static boolean	renameField(JsonValue jsonValue, String oldKey, String newKey)	Renames a field within the given JsonValue.
protected static String	replaceKeyPeriodsWithUnderscores(String json)	Replaces all period-characters in JSON keys with underscore-characters [ref].
protected static JsonValue	restoreKeyPeriods(JsonValue value, JsonValue normalized)	Reverses the normalization steps preformed by replaceKeyPeriodsWithUnderscores(String).

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

Jackson ObjectMapper for working with JSON.

NORMALIZED_FIELD

protected static final String NORMALIZED_FIELD

JSON field-name of metadata to assist in de-normalization.

See Also:

Constant Field Values

FIELD_NAMES_FIELD

protected static final String FIELD_NAMES_FIELD

JSON field-name of normalized field-names.

See Also:

Constant Field Values

Method Detail

normalizeJson

public static String normalizeJson(JsonValue value)
                            throws IOException

Normalizes JSON to conform to Elasticsearch data-format restrictions. The following normalizations are performed,

• Periods in JSON fields (keys) are converted to underscore characters

The following metadata, for example, is added to the Normalized JSON, to facilitate de-normalization,

     "_normalized" : {
         "fieldNames" : {
             "key_1" : "key.1",
             "key_2" : "key.2"
         }
     }
 

Parameters:

value - JSON value

Returns:

Resulting JSON, with _normalized field if any normalization was necessary

Throws:

IOException - If unable to parse the json.

denormalizeJson

public static JsonValue denormalizeJson(JsonValue value)
                                 throws IOException

De-normalizes JSON that was previously normalized by normalizeJson(JsonValue).

Parameters:

value - JSON value

Returns:

Original, de-normalized JSON

Throws:

IOException - If unable to parse the json.

replaceKeyPeriodsWithUnderscores

protected static String replaceKeyPeriodsWithUnderscores(String json)
                                                  throws IOException

Replaces all period-characters in JSON keys with underscore-characters [ref]. If normalization is required, the fieldNames field will be added to the normalized metadata.

Parameters:

json - JSON String input

Returns:

Resulting JSON String

Throws:

IOException - If unable to parse the json.

restoreKeyPeriods

protected static JsonValue restoreKeyPeriods(JsonValue value,
                                             JsonValue normalized)
                                      throws IOException

Reverses the normalization steps preformed by replaceKeyPeriodsWithUnderscores(String).

Parameters:

value - JSON input

normalized - De-normalization metadata, which this method may add to

Returns:

Resulting JSON

Throws:

IOException - If unable to parse the json.

normalizeJsonPointer

public static JsonPointer normalizeJsonPointer(JsonPointer ptr)

Replaces periods in JsonPointer keys with underscore.

Parameters:

ptr - The JsonPointer to normalize.

Returns:

A normalized JsonPointer.

renameField

public static boolean renameField(JsonValue jsonValue,
                                  String oldKey,
                                  String newKey)

Renames a field within the given JsonValue.

Parameters:

jsonValue - JsonValue to have a top-level field renamed

oldKey - Old field name

newKey - New field name (field must not already exist)

Returns:

true if field was found and renamed, and false otherwise