[
https://issues.apache.org/jira/browse/NIFI-4516?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16392253#comment-16392253
]
ASF GitHub Bot commented on NIFI-4516:
--------------------------------------
Github user MikeThomsen commented on a diff in the pull request:
https://github.com/apache/nifi/pull/2517#discussion_r173346578
--- Diff:
nifi-nar-bundles/nifi-solr-bundle/nifi-solr-processors/src/main/java/org/apache/nifi/processors/solr/FetchSolr.java
---
@@ -0,0 +1,401 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.nifi.processors.solr;
+
+import com.google.gson.stream.JsonWriter;
+import org.apache.nifi.annotation.behavior.InputRequirement;
+import org.apache.nifi.annotation.behavior.WritesAttribute;
+import org.apache.nifi.annotation.behavior.WritesAttributes;
+import org.apache.nifi.annotation.documentation.CapabilityDescription;
+import org.apache.nifi.annotation.documentation.Tags;
+import org.apache.nifi.components.AllowableValue;
+import org.apache.nifi.components.PropertyDescriptor;
+import org.apache.nifi.expression.AttributeExpression;
+import org.apache.nifi.flowfile.FlowFile;
+import org.apache.nifi.flowfile.attributes.CoreAttributes;
+import org.apache.nifi.logging.ComponentLog;
+import org.apache.nifi.processor.ProcessContext;
+import org.apache.nifi.processor.ProcessSession;
+import org.apache.nifi.processor.ProcessorInitializationContext;
+import org.apache.nifi.processor.Relationship;
+import org.apache.nifi.processor.exception.ProcessException;
+import org.apache.nifi.processor.io.OutputStreamCallback;
+import org.apache.nifi.processor.util.StandardValidators;
+import org.apache.nifi.schema.access.SchemaNotFoundException;
+import org.apache.nifi.serialization.RecordSetWriter;
+import org.apache.nifi.serialization.RecordSetWriterFactory;
+import org.apache.nifi.serialization.record.RecordSchema;
+import org.apache.nifi.serialization.record.RecordSet;
+import org.apache.solr.client.solrj.SolrQuery;
+import org.apache.solr.client.solrj.request.QueryRequest;
+import org.apache.solr.client.solrj.response.FacetField;
+import org.apache.solr.client.solrj.response.FieldStatsInfo;
+import org.apache.solr.client.solrj.response.IntervalFacet;
+import org.apache.solr.client.solrj.response.QueryResponse;
+import org.apache.solr.client.solrj.response.RangeFacet;
+import org.apache.solr.client.solrj.response.RangeFacet.Count;
+import org.apache.solr.common.params.FacetParams;
+import org.apache.solr.common.params.MultiMapSolrParams;
+import org.apache.solr.common.params.StatsParams;
+import org.apache.solr.servlet.SolrRequestParsers;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.apache.nifi.processors.solr.SolrUtils.SOLR_TYPE;
+import static org.apache.nifi.processors.solr.SolrUtils.COLLECTION;
+import static
org.apache.nifi.processors.solr.SolrUtils.JAAS_CLIENT_APP_NAME;
+import static
org.apache.nifi.processors.solr.SolrUtils.SSL_CONTEXT_SERVICE;
+import static
org.apache.nifi.processors.solr.SolrUtils.SOLR_SOCKET_TIMEOUT;
+import static
org.apache.nifi.processors.solr.SolrUtils.SOLR_CONNECTION_TIMEOUT;
+import static
org.apache.nifi.processors.solr.SolrUtils.SOLR_MAX_CONNECTIONS;
+import static
org.apache.nifi.processors.solr.SolrUtils.SOLR_MAX_CONNECTIONS_PER_HOST;
+import static org.apache.nifi.processors.solr.SolrUtils.ZK_CLIENT_TIMEOUT;
+import static
org.apache.nifi.processors.solr.SolrUtils.ZK_CONNECTION_TIMEOUT;
+import static org.apache.nifi.processors.solr.SolrUtils.SOLR_LOCATION;
+import static org.apache.nifi.processors.solr.SolrUtils.BASIC_USERNAME;
+import static org.apache.nifi.processors.solr.SolrUtils.BASIC_PASSWORD;
+import static org.apache.nifi.processors.solr.SolrUtils.RECORD_WRITER;
+
+@Tags({"Apache", "Solr", "Get", "Query", "Records"})
+@InputRequirement(InputRequirement.Requirement.INPUT_ALLOWED)
+@CapabilityDescription("Queries Solr and outputs the results as a FlowFile
in the format of XML or using a Record Writer")
+@WritesAttributes({
+ @WritesAttribute(attribute = "solr.cursor.mark", description =
"Cursor mark can be used for scrolling Solr"),
+ @WritesAttribute(attribute = "solr.status.code", description =
"Status code of Solr request. A status code of 0 indicates that the request was
successfully processed"),
+ @WritesAttribute(attribute = "solr.query.time", description = "The
elapsed time to process the query (in ms)"),
+ @WritesAttribute(attribute = "mime.type", description = "The mime
type of the data format"),
+ @WritesAttribute(attribute = "fetchsolr.exeption.class",
description = "The Java exception class raised when the processor fails"),
+ @WritesAttribute(attribute = "fetchsolr.exeption.message",
description = "The Java exception message raised when the processor fails")
+})
+public class FetchSolr extends SolrProcessor {
+
+ public static final AllowableValue MODE_XML = new
AllowableValue("XML");
+ public static final AllowableValue MODE_REC = new
AllowableValue("Records");
+ public static final String MIME_TYPE_JSON = "application/json";
+ public static final String ATTRIBUTE_CURSOR_MARK = "solr.cursor.mark";
+ public static final String ATTRIBUTE_SOLR_STATUS = "solr.status.code";
+ public static final String ATTRIBUTE_QUERY_TIME = "solr.query.time";
+ public static final String EXCEPTION = "fetchsolr.exeption";
+ public static final String EXCEPTION_MESSAGE =
"fetchsolr.exeption.message";
+
+ public static final PropertyDescriptor SOLR_QUERY_STRING = new
PropertyDescriptor
+ .Builder().name("solr_query_string")
+ .displayName("Solr Query String")
+ .description("A query string to execute against Solr")
+ .required(true)
+
.addValidator(StandardValidators.createAttributeExpressionLanguageValidator(AttributeExpression.ResultType.STRING))
+ .expressionLanguageSupported(true)
+ .defaultValue("q=*:*")
+ .build();
+
+ public static final PropertyDescriptor RETURN_TYPE = new
PropertyDescriptor
+ .Builder().name("Return Type")
+ .displayName("Return Type")
+ .description("Output format of Solr results. Write Solr
documents to FlowFiles as XML or using a Record Writer")
+ .required(true)
+ .allowableValues(MODE_XML, MODE_REC)
+ .defaultValue(MODE_XML.getValue())
+ .build();
+
+ public static final PropertyDescriptor REQUEST_HANDLER = new
PropertyDescriptor
+ .Builder().name("request_handler")
+ .displayName("Request Handler")
+ .description("Define a request handler here, e. g. /query")
+ .required(true)
+ .addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
+ .defaultValue("/select")
+ .build();
+
+ public static final Relationship RESULTS = new
Relationship.Builder().name("results")
+ .description("Results of Solr queries").build();
+ public static final Relationship FACETS = new
Relationship.Builder().name("facets")
+ .description("Results of faceted search").build();
+ public static final Relationship STATS = new
Relationship.Builder().name("stats")
+ .description("Stats about Solr index").build();
+ public static final Relationship ORIGINAL = new
Relationship.Builder().name("original")
+ .description("Original flowfile").build();
+ public static final Relationship FAILURE = new
Relationship.Builder().name("failure")
+ .description("Failure relationship").build();
+
+ private Set<Relationship> relationships;
+ private List<PropertyDescriptor> descriptors;
+
+ @Override
+ public Set<Relationship> getRelationships() {
+ return this.relationships;
+ }
+
+ @Override
+ public List<PropertyDescriptor> getSupportedPropertyDescriptors() {
+ return this.descriptors;
+ }
+
+ @Override
+ protected void init(final ProcessorInitializationContext context) {
+ super.init(context);
+
+ final List<PropertyDescriptor> descriptors = new ArrayList<>();
+ descriptors.add(SOLR_TYPE);
+ descriptors.add(SOLR_LOCATION);
+ descriptors.add(COLLECTION);
+ descriptors.add(SOLR_QUERY_STRING);
+ descriptors.add(RETURN_TYPE);
+ descriptors.add(RECORD_WRITER);
+ descriptors.add(REQUEST_HANDLER);
+ descriptors.add(JAAS_CLIENT_APP_NAME);
+ descriptors.add(BASIC_USERNAME);
+ descriptors.add(BASIC_PASSWORD);
+ descriptors.add(SSL_CONTEXT_SERVICE);
+ descriptors.add(SOLR_SOCKET_TIMEOUT);
+ descriptors.add(SOLR_CONNECTION_TIMEOUT);
+ descriptors.add(SOLR_MAX_CONNECTIONS);
+ descriptors.add(SOLR_MAX_CONNECTIONS_PER_HOST);
+ descriptors.add(ZK_CLIENT_TIMEOUT);
+ descriptors.add(ZK_CONNECTION_TIMEOUT);
+ this.descriptors = Collections.unmodifiableList(descriptors);
+
+ final Set<Relationship> relationships = new HashSet<>();
+ relationships.add(FAILURE);
+ relationships.add(RESULTS);
+ relationships.add(FACETS);
+ relationships.add(STATS);
+ relationships.add(ORIGINAL);
+ this.relationships = Collections.unmodifiableSet(relationships);
+ }
+
+ public static final Set<String> SUPPORTED_SEARCH_COMPONENTS = new
HashSet<String>();
+ static {
+
SUPPORTED_SEARCH_COMPONENTS.addAll(Arrays.asList(StatsParams.STATS,
FacetParams.FACET));
+ }
+ public static final Set<String> SEARCH_COMPONENTS_ON = new
HashSet<String>();
+ static {
+ SEARCH_COMPONENTS_ON.addAll(Arrays.asList("true", "on", "yes"));
+ }
+
+ @Override
+ public void onTrigger(final ProcessContext context, final
ProcessSession session) throws ProcessException {
+ final ComponentLog logger = getLogger();
+
+ FlowFile flowFileOriginal = session.get();
+
+ if (flowFileOriginal == null) {
+ if (context.hasNonLoopConnection())
+ return;
+ flowFileOriginal = session.create();
+ }
+
+ final Map<String,String[]> solrParams = parseSolrParams(context,
flowFileOriginal);
+ final Set<String> searchComponents =
extractSearchComponents(solrParams);
+ final SolrQuery solrQuery = new SolrQuery();
+ solrQuery.add(new MultiMapSolrParams(solrParams));
+
+
solrQuery.setRequestHandler(context.getProperty(REQUEST_HANDLER).getValue());
+
+ final QueryRequest req = new QueryRequest(solrQuery);
+
+ if (isBasicAuthEnabled()) {
+ req.setBasicAuthCredentials(getUsername(), getPassword());
+ }
+ try {
+ final QueryResponse response = req.process(getSolrClient());
+ Map<String,String> attributes = new HashMap<>();
+ attributes.put(ATTRIBUTE_CURSOR_MARK,
response.getNextCursorMark());
+ attributes.put(ATTRIBUTE_SOLR_STATUS,
String.valueOf(response.getStatus()));
+ attributes.put(ATTRIBUTE_QUERY_TIME,
String.valueOf(response.getQTime()));
+
+ if (response.getResults().size() > 0) {
+ FlowFile flowFileResponse =
session.create(flowFileOriginal);
+ if
(context.getProperty(RETURN_TYPE).getValue().equals(MODE_XML.getValue())){
+ flowFileResponse = session.write(flowFileResponse,
SolrUtils.getOutputStreamCallbackToTransformSolrResponseToXml(response));
+ flowFileResponse =
session.putAttribute(flowFileResponse, CoreAttributes.MIME_TYPE.key(),
"application/xml");
+ } else {
+ final RecordSetWriterFactory writerFactory =
context.getProperty(RECORD_WRITER).asControllerService(RecordSetWriterFactory.class);
+ final RecordSchema schema =
writerFactory.getSchema(flowFileOriginal.getAttributes(), null);
+ final RecordSet recordSet =
SolrUtils.solrDocumentsToRecordSet(response.getResults(), schema);
+ final StringBuffer mimeType = new StringBuffer();
+ flowFileResponse = session.write(flowFileResponse, new
OutputStreamCallback() {
+ @Override
+ public void process(final OutputStream out) throws
IOException {
+ try (final RecordSetWriter writer =
writerFactory.createWriter(getLogger(), schema, out)) {
+ writer.write(recordSet);
+ writer.flush();
+ mimeType.append(writer.getMimeType());
+ } catch (SchemaNotFoundException e) {
+ throw new ProcessException("Could not
parse Solr response", e);
+ }
+ }
+ });
+ flowFileResponse =
session.putAttribute(flowFileResponse, CoreAttributes.MIME_TYPE.key(),
mimeType.toString());
+ }
+ flowFileResponse =
session.putAllAttributes(flowFileResponse, attributes);
+ session.transfer(flowFileResponse, RESULTS);
+ }
+
+ if (searchComponents.contains(FacetParams.FACET)) {
+ FlowFile flowFileFacets = session.create(flowFileOriginal);
+ flowFileFacets = session.write(flowFileFacets, out -> {
+ try (
+ final OutputStreamWriter osw = new
OutputStreamWriter(out);
+ final JsonWriter writer = new JsonWriter(osw)
+ ) {
+ addFacetsFromSolrResponseToJsonWriter(response,
writer);
+ }
+ });
+ flowFileFacets = session.putAttribute(flowFileFacets,
CoreAttributes.MIME_TYPE.key(), MIME_TYPE_JSON);
+ flowFileFacets = session.putAllAttributes(flowFileFacets,
attributes);
+ session.transfer(flowFileFacets, FACETS);
+ }
+
+ if (searchComponents.contains(StatsParams.STATS)) {
+ FlowFile flowFileStats = session.create(flowFileOriginal);
+ flowFileStats = session.write(flowFileStats, out -> {
+ try (
+ final OutputStreamWriter osw = new
OutputStreamWriter(out);
+ final JsonWriter writer = new JsonWriter(osw)
+ ) {
+ addStatsFromSolrResponseToJsonWriter(response,
writer);
+ }
+ });
+ flowFileStats = session.putAttribute(flowFileStats,
CoreAttributes.MIME_TYPE.key(), MIME_TYPE_JSON);
+ flowFileStats = session.putAllAttributes(flowFileStats,
attributes);
+ session.transfer(flowFileStats, STATS);
+ }
+
+ } catch (Exception e) {
+ flowFileOriginal = session.penalize(flowFileOriginal);
+ flowFileOriginal = session.putAttribute(flowFileOriginal,
EXCEPTION, e.getClass().getName());
+ flowFileOriginal = session.putAttribute(flowFileOriginal,
EXCEPTION_MESSAGE, e.getMessage());
+ session.transfer(flowFileOriginal, FAILURE);
+ logger.error("Failed to execute query {} due to {}. FlowFile
will be routed to relationship failure", new Object[]{solrQuery.toString(), e},
e);
+ }
+
+ if (!flowFileOriginal.isPenalized())
+ session.transfer(flowFileOriginal, ORIGINAL);
+ }
+
+ private Map<String,String[]> parseSolrParams(final ProcessContext
context, final FlowFile flowFile) {
+ final MultiMapSolrParams newSolrParams =
SolrRequestParsers.parseQueryString(context.getProperty(SOLR_QUERY_STRING).evaluateAttributeExpressions(flowFile).getValue());
+ return Collections.unmodifiableMap(newSolrParams.getMap());
+ }
+
+ private Set<String> extractSearchComponents(Map<String,String[]>
solrParams) {
+ final Set<String> searchComponentsTemp = new HashSet<>();
+ for (final String searchComponent : SUPPORTED_SEARCH_COMPONENTS)
+ if (solrParams.keySet().contains(searchComponent))
+ if
(SEARCH_COMPONENTS_ON.contains(solrParams.get(searchComponent)[0]))
+ searchComponentsTemp.add(searchComponent);
+ return Collections.unmodifiableSet(searchComponentsTemp);
+ }
+
+ private static void addStatsFromSolrResponseToJsonWriter(final
QueryResponse response, final JsonWriter writer) throws IOException {
--- End diff --
See [this](https://stackoverflow.com/a/11625103/284538) for an example if
you haven't done it before.
> Add FetchSolr processor
> -----------------------
>
> Key: NIFI-4516
> URL: https://issues.apache.org/jira/browse/NIFI-4516
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Extensions
> Reporter: Johannes Peter
> Assignee: Johannes Peter
> Priority: Major
> Labels: features
>
> The processor shall be capable
> * to query Solr within a workflow,
> * to make use of standard functionalities of Solr such as faceting,
> highlighting, result grouping, etc.,
> * to make use of NiFis expression language to build Solr queries,
> * to handle results as records.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
