Package org.apache.nifi.lookup

Class RestLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.RestLookupService

All Implemented Interfaces:

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

@Tags({"rest","lookup","json","xml","http"})
@CapabilityDescription("Use a REST service to look up values.")
@SupportsSensitiveDynamicProperties
@DynamicProperties(@DynamicProperty(name="*",value="*",description="All dynamic properties are added as HTTP headers with the name as the header name and the value as the header value.",expressionLanguageScope=FLOWFILE_ATTRIBUTES))
public class RestLookupService
extends org.apache.nifi.controller.AbstractControllerService
implements RecordLookupService

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.nifi.components.PropertyDescriptor	AUTHENTICATION_STRATEGY
private String	basicPass
private String	basicUser
(package private) static final String	BODY_KEY
private okhttp3.OkHttpClient	client
private Map<String,org.apache.nifi.components.PropertyValue>	headers
private boolean	isDigest
(package private) static final Set<String>	KEYS
(package private) static final String	METHOD_KEY
(package private) static final String	MIME_TYPE_KEY
static final org.apache.nifi.components.PropertyDescriptor	OAUTH2_ACCESS_TOKEN_PROVIDER
private Optional<OAuth2AccessTokenProvider>	oauth2AccessTokenProviderOptional
static final org.apache.nifi.components.PropertyDescriptor	PROP_BASIC_AUTH_PASSWORD
static final org.apache.nifi.components.PropertyDescriptor	PROP_BASIC_AUTH_USERNAME
static final org.apache.nifi.components.PropertyDescriptor	PROP_CONNECT_TIMEOUT
static final org.apache.nifi.components.PropertyDescriptor	PROP_DIGEST_AUTH
static final org.apache.nifi.components.PropertyDescriptor	PROP_READ_TIMEOUT
private static final List<org.apache.nifi.components.PropertyDescriptor>	PROPERTY_DESCRIPTORS
static final org.apache.nifi.components.PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
private static final ProxySpec[]	PROXY_SPECS
private ProxyConfigurationService	proxyConfigurationService
private RecordReaderFactory	readerFactory
(package private) static final org.apache.nifi.components.PropertyDescriptor	RECORD_PATH
(package private) static final org.apache.nifi.components.PropertyDescriptor	RECORD_READER
private RecordPath	recordPath
static final org.apache.nifi.components.PropertyDescriptor	RESPONSE_HANDLING_STRATEGY
private ResponseHandlingStrategy	responseHandlingStrategy
(package private) static final org.apache.nifi.components.PropertyDescriptor	SSL_CONTEXT_SERVICE
(package private) static final org.apache.nifi.components.PropertyDescriptor	URL
private org.apache.nifi.components.PropertyValue	urlTemplate
(package private) static final List<String>	VALID_VERBS

Constructor Summary

Constructors

Constructor	Description
RestLookupService()

Method Summary

Modifier and Type	Method	Description
private void	buildHeaders(org.apache.nifi.controller.ConfigurationContext context)
private okhttp3.Request	buildRequest(String mimeType, String method, String body, String endpoint, Map<String,String> context)
protected String	determineEndpoint(Map<String,Object> coordinates, Map<String,String> context)
protected okhttp3.Response	executeRequest(okhttp3.Request request)
Set<String>	getRequiredKeys()
protected org.apache.nifi.components.PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
Class<?>	getValueType()
private Record	handleResponse(InputStream is, long inputLength, Map<String,String> context)
Optional<Record>	lookup(Map<String,Object> coordinates)
Optional<Record>	lookup(Map<String,Object> coordinates, Map<String,String> context)
void	migrateProperties(org.apache.nifi.migration.PropertyConfiguration config)
void	onDisabled()
void	onEnabled(org.apache.nifi.controller.ConfigurationContext context)
private void	setAuthenticator(okhttp3.OkHttpClient.Builder okHttpClientBuilder, org.apache.nifi.controller.ConfigurationContext context)
private void	setProxy(okhttp3.OkHttpClient.Builder builder)
protected void	validateVerb(String method)

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

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

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, 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

Field Details

URL

static final org.apache.nifi.components.PropertyDescriptor URL

RECORD_READER

static final org.apache.nifi.components.PropertyDescriptor RECORD_READER

RECORD_PATH

static final org.apache.nifi.components.PropertyDescriptor RECORD_PATH

SSL_CONTEXT_SERVICE

static final org.apache.nifi.components.PropertyDescriptor SSL_CONTEXT_SERVICE

AUTHENTICATION_STRATEGY

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

OAUTH2_ACCESS_TOKEN_PROVIDER

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

PROP_BASIC_AUTH_USERNAME

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

PROP_BASIC_AUTH_PASSWORD

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

PROP_DIGEST_AUTH

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

PROP_CONNECT_TIMEOUT

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

PROP_READ_TIMEOUT

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

RESPONSE_HANDLING_STRATEGY

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

PROXY_SPECS

private static final ProxySpec[] PROXY_SPECS

PROXY_CONFIGURATION_SERVICE

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

MIME_TYPE_KEY

static final String MIME_TYPE_KEY

See Also:

• Constant Field Values

BODY_KEY

static final String BODY_KEY

See Also:

• Constant Field Values

METHOD_KEY

static final String METHOD_KEY

See Also:

• Constant Field Values

PROPERTY_DESCRIPTORS

private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

KEYS

static final Set<String> KEYS

VALID_VERBS

static final List<String> VALID_VERBS

proxyConfigurationService

private volatile ProxyConfigurationService proxyConfigurationService

readerFactory

private volatile RecordReaderFactory readerFactory

recordPath

private volatile RecordPath recordPath

client

private volatile okhttp3.OkHttpClient client

headers

private volatile Map<String,org.apache.nifi.components.PropertyValue> headers

urlTemplate

private volatile org.apache.nifi.components.PropertyValue urlTemplate

basicUser

private volatile String basicUser

basicPass

private volatile String basicPass

isDigest

private volatile boolean isDigest

responseHandlingStrategy

private volatile ResponseHandlingStrategy responseHandlingStrategy

oauth2AccessTokenProviderOptional

private volatile Optional<OAuth2AccessTokenProvider> oauth2AccessTokenProviderOptional

Constructor Details

RestLookupService

public RestLookupService()

Method Details

getSupportedPropertyDescriptors

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

Overrides:

getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

onEnabled

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

onDisabled

@OnDisabled
public void onDisabled()

buildHeaders

private void buildHeaders(org.apache.nifi.controller.ConfigurationContext context)

setProxy

private void setProxy(okhttp3.OkHttpClient.Builder builder)

lookup

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

Specified by:

lookup in interface LookupService<Record>

Throws:

LookupFailureException

lookup

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

Specified by:

lookup in interface LookupService<Record>

Throws:

LookupFailureException

migrateProperties

public void migrateProperties(org.apache.nifi.migration.PropertyConfiguration config)

Specified by:

migrateProperties in interface org.apache.nifi.controller.ControllerService

validateVerb

protected void validateVerb(String method)
                     throws LookupFailureException

Throws:

LookupFailureException

determineEndpoint

protected String determineEndpoint(Map<String,Object> coordinates,
 Map<String,String> context)

getSupportedDynamicPropertyDescriptor

protected org.apache.nifi.components.PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class org.apache.nifi.components.AbstractConfigurableComponent

executeRequest

protected okhttp3.Response executeRequest(okhttp3.Request request)
                                   throws IOException

Throws:

IOException

handleResponse

private Record handleResponse(InputStream is,
 long inputLength,
 Map<String,String> context)
                       throws SchemaNotFoundException,
MalformedRecordException,
IOException

Throws:

SchemaNotFoundException

MalformedRecordException

IOException

buildRequest

private okhttp3.Request buildRequest(String mimeType,
 String method,
 String body,
 String endpoint,
 Map<String,String> context)

setAuthenticator

private void setAuthenticator(okhttp3.OkHttpClient.Builder okHttpClientBuilder,
 org.apache.nifi.controller.ConfigurationContext context)

getValueType

public Class<?> getValueType()

Specified by:

getValueType in interface LookupService<Record>

Specified by:

getValueType in interface RecordLookupService

getRequiredKeys

public Set<String> getRequiredKeys()

Specified by:

getRequiredKeys in interface LookupService<Record>