Package org.apache.nifi.mongodb

Class MongoDBLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.serialization.JsonInferenceSchemaRegistryService

org.apache.nifi.mongodb.MongoDBLookupService

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, LookupService<Object>

@Tags({"mongo","mongodb","lookup","record"})
@CapabilityDescription("Provides a lookup service based around MongoDB. Each key that is specified \nwill be added to a query as-is. For example, if you specify the two keys, \nuser and email, the resulting query will be { \"user\": \"tester\", \"email\": \"tester@test.com\" }.\nThe query is limited to the first result (findOne in the Mongo documentation). If no \"Lookup Value Field\" is specified then the entire MongoDB result document minus the _id field will be returned as a record.")
public class MongoDBLookupService
extends JsonInferenceSchemaRegistryService
implements LookupService<Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.nifi.components.PropertyDescriptor	COLLECTION_NAME
static final org.apache.nifi.components.PropertyDescriptor	CONTROLLER_SERVICE
private MongoDBClientService	controllerService
static final org.apache.nifi.components.PropertyDescriptor	DATABASE_NAME
static final org.apache.nifi.components.PropertyDescriptor	LOCAL_SCHEMA_NAME
static final org.apache.nifi.components.PropertyDescriptor	LOOKUP_VALUE_FIELD
private String	lookupValueField
private org.bson.Document	projection
static final org.apache.nifi.components.PropertyDescriptor	PROJECTION
private String	schemaNameProperty

Fields inherited from class org.apache.nifi.serialization.SchemaRegistryService

schemaAccessStrategy

Constructor Summary

Constructors

Constructor	Description
MongoDBLookupService()

Method Summary

Modifier and Type	Method	Description
private org.bson.Document	findOne(org.bson.Document query, org.bson.Document projection, Map<String,String> context)
Set<String>	getRequiredKeys()
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
Class<?>	getValueType()
private RecordSchema	loadSchema(Map<String,String> context, org.bson.Document doc)
Optional<Object>	lookup(Map<String,Object> coordinates)
Optional<Object>	lookup(Map<String,Object> coordinates, Map<String,String> context)
void	onEnabled(org.apache.nifi.controller.ConfigurationContext context)

Methods inherited from class org.apache.nifi.serialization.JsonInferenceSchemaRegistryService

getDefaultSchemaAccessStrategy, getSchema, getSchemaAccessStrategy

Methods inherited from class org.apache.nifi.serialization.SchemaRegistryService

buildSchemaTextProperty, buildStrategyProperty, customValidate, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAccessStrategyDescriptor, getSchemaAccessStrategyValues, getSuppliedSchemaFields, migrateProperties, storeSchemaAccessStrategy

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful, migrateProperties

Field Details

LOCAL_SCHEMA_NAME

public static final org.apache.nifi.components.PropertyDescriptor LOCAL_SCHEMA_NAME

CONTROLLER_SERVICE

public static final org.apache.nifi.components.PropertyDescriptor CONTROLLER_SERVICE

DATABASE_NAME

public static final org.apache.nifi.components.PropertyDescriptor DATABASE_NAME

COLLECTION_NAME

public static final org.apache.nifi.components.PropertyDescriptor COLLECTION_NAME

LOOKUP_VALUE_FIELD

public static final org.apache.nifi.components.PropertyDescriptor LOOKUP_VALUE_FIELD

PROJECTION

public static final org.apache.nifi.components.PropertyDescriptor PROJECTION

lookupValueField

private String lookupValueField

projection

private volatile org.bson.Document projection

controllerService

private MongoDBClientService controllerService

schemaNameProperty

private String schemaNameProperty

Constructor Details

MongoDBLookupService

public MongoDBLookupService()

Method Details

lookup

public Optional<Object> lookup(Map<String,Object> coordinates)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<Object>

Throws:

LookupFailureException

lookup

public Optional<Object> lookup(Map<String,Object> coordinates,
 Map<String,String> context)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<Object>

Throws:

LookupFailureException

loadSchema

private RecordSchema loadSchema(Map<String,String> context,
 org.bson.Document doc)

onEnabled

@OnEnabled
public void onEnabled(org.apache.nifi.controller.ConfigurationContext context)

Overrides:

onEnabled in class JsonInferenceSchemaRegistryService

getValueType

public Class<?> getValueType()

Specified by:

getValueType in interface LookupService<Object>

getRequiredKeys

public Set<String> getRequiredKeys()

Specified by:

getRequiredKeys in interface LookupService<Object>

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class JsonInferenceSchemaRegistryService

findOne

private org.bson.Document findOne(org.bson.Document query,
 org.bson.Document projection,
 Map<String,String> context)