com.delphix.masking.api.plugin.utils

Class ComponentConfigurator

java.lang.Object

com.delphix.masking.api.plugin.utils.ComponentConfigurator

public final class ComponentConfigurator
extends java.lang.Object

This class consolidates logic for applying and extracting plugin component configuration using JSON deserialization and serialization. It also provides the singular jackson ObjectMapper object that should be used for all plugin configuration manipulation.
This class relies on jackson annotations to discover which fields in the component object are configurable. Fields without @JsonProperty annotation are effectively invisible to the serializer.

Method Summary

Modifier and Type	Method and Description
static void	applyConfiguration(MaskingComponent component, com.fasterxml.jackson.databind.JsonNode json) Apply the specified configuration to the component objects.
static void	applyConfiguration(MaskingComponent component, java.lang.String json) Apply the specified configuration to the component objects.
static com.fasterxml.jackson.databind.JsonNode	extractConfigJsonNode(MaskingComponent component) Extract and serialize all @JsonProperty annotated fields from the object.
static java.lang.String	extractConfigString(MaskingComponent component) Extract and serialize all @JsonProperty annotated fields from the object.
static com.fasterxml.jackson.module.jsonSchema.JsonSchema	generateSchema(MaskingComponent component) This method returns the schema object in a format appropriate for embedding in the swagger framework object.
static java.lang.String	generateSchemaText(MaskingComponent component) This method returns the schema object as a text string.
static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper() Get the object mapper for all plugin component serialization and deserialization activities.

Methods inherited from class java.lang.Object

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

Method Detail

applyConfiguration

public static void applyConfiguration(MaskingComponent component,
                                      java.lang.String json)
                               throws ComponentConfigurationException

Apply the specified configuration to the component objects.

Parameters:

component - The component object to be modified.

json - The JSON serialization of the object's configuration.

Throws:

ComponentConfigurationException - When the JSON can't be applied

applyConfiguration

public static void applyConfiguration(MaskingComponent component,
                                      com.fasterxml.jackson.databind.JsonNode json)
                               throws ComponentConfigurationException

Apply the specified configuration to the component objects.

Parameters:

component - The component object to be modified.

json - The JSON serialization of the object's configuration.

Throws:

ComponentConfigurationException - When the JSON can't be applied

extractConfigString

public static java.lang.String extractConfigString(MaskingComponent component)
                                            throws ComponentConfigurationException

Extract and serialize all @JsonProperty annotated fields from the object.

Parameters:

component - The component object to be modified.

Returns:

The JSON serialization as a string

Throws:

ComponentConfigurationException - When the component's configuration is invalid

extractConfigJsonNode

public static com.fasterxml.jackson.databind.JsonNode extractConfigJsonNode(MaskingComponent component)

Extract and serialize all @JsonProperty annotated fields from the object.

Parameters:

component - The component object to be modified.

Returns:

The JSON serialization as a tree of JsonNode objects

generateSchema

public static com.fasterxml.jackson.module.jsonSchema.JsonSchema generateSchema(MaskingComponent component)

This method returns the schema object in a format appropriate for embedding in the swagger framework object.

Parameters:

component - The component for which the schema should be generated

Returns:

The schema as object tree

generateSchemaText

public static java.lang.String generateSchemaText(MaskingComponent component)

This method returns the schema object as a text string.

Parameters:

component - The component for which the schema should be generated

Returns:

The schema string

getObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

Get the object mapper for all plugin component serialization and deserialization activities. This ensures the mapper has a consistent configuration across all usage.

Returns:

The object mapper