Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-13491 Added Response Header Request Attributes Prefix to InvokeHTTP (#9507) 

Signed-off-by: David Handermann <exceptionfactory@apache.org>
This commit is contained in:
NissimShiman 2024-11-20 22:03:37 -05:00 committed by GitHub
parent b421ccad21
commit aa3a7c05ad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 40 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
nifi-extension-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/InvokeHTTP.java
View File

@ -455,12 +455,22 @@ public class InvokeHTTP extends AbstractProcessor {
public static final PropertyDescriptor RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED = new PropertyDescriptor.Builder()
.name("Response Header Request Attributes Enabled")
.description("Enable adding HTTP response headers as attributes to FlowFiles transferred to the Original relationship.")
.description("Enable adding HTTP response headers as attributes to FlowFiles transferred to the Original, Retry or No Retry relationships.")
.required(false)
.defaultValue(Boolean.FALSE.toString())
.allowableValues(Boolean.TRUE.toString(), Boolean.FALSE.toString())
.build();
public static final PropertyDescriptor RESPONSE_HEADER_REQUEST_ATTRIBUTES_PREFIX = new PropertyDescriptor.Builder()
.name("Response Header Request Attributes Prefix")
.description("Prefix to HTTP response headers when included as attributes to FlowFiles transferred to the Original, Retry or No Retry relationships. "
+ "It is recommended to end with a separator character like '.' or '-'.")
.required(false)
.expressionLanguageSupported(ExpressionLanguageScope.FLOWFILE_ATTRIBUTES)
.addValidator(StandardValidators.NON_EMPTY_VALIDATOR)
.dependsOn(RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED, Boolean.TRUE.toString())
.build();
public static final PropertyDescriptor RESPONSE_REDIRECTS_ENABLED = new PropertyDescriptor.Builder()
.name("Response Redirects Enabled")
.description("Enable following HTTP redirects sent with HTTP 300 series responses as described in RFC 7231 Section 6.4.")
@ -508,6 +518,7 @@ public class InvokeHTTP extends AbstractProcessor {
RESPONSE_GENERATION_REQUIRED,
RESPONSE_FLOW_FILE_NAMING_STRATEGY,
RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED,
RESPONSE_HEADER_REQUEST_ATTRIBUTES_PREFIX,
RESPONSE_REDIRECTS_ENABLED
);
@ -878,13 +889,6 @@ public class InvokeHTTP extends AbstractProcessor {
requestFlowFile = session.putAllAttributes(requestFlowFile, statusAttributes);
}
// If the property to add the response headers to the request flowfile is true then add them
if (context.getProperty(RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED).asBoolean() && requestFlowFile != null) {
// write the response headers as attributes
// this will overwrite any existing flowfile attributes
requestFlowFile = session.putAllAttributes(requestFlowFile, convertAttributesFromHeaders(responseHttp));
}
boolean outputBodyToRequestAttribute = (!isSuccess(statusCode) || putToAttribute) && requestFlowFile != null;
boolean outputBodyToResponseContent = (isSuccess(statusCode) && !putToAttribute) || context.getProperty(RESPONSE_GENERATION_REQUIRED).asBoolean();
ResponseBody responseBody = responseHttp.body();
@ -918,7 +922,7 @@ public class InvokeHTTP extends AbstractProcessor {
// write the response headers as attributes
// this will overwrite any existing flowfile attributes
responseFlowFile = session.putAllAttributes(responseFlowFile, convertAttributesFromHeaders(responseHttp));
responseFlowFile = session.putAllAttributes(responseFlowFile, convertAttributesFromHeaders(responseHttp, ""));
// update FlowFile's filename attribute with an extracted value from the remote URL
if (FlowFileNamingStrategy.URL_PATH.equals(getFlowFileNamingStrategy(context)) && HttpMethod.GET.name().equals(httpRequest.method())) {
@ -987,6 +991,16 @@ public class InvokeHTTP extends AbstractProcessor {
}
}
// This needs to be done after the response flowFile has been created from the request flowFile
// as the added attribute headers may have a prefix added that doesn't make sense for the response flowFile.
if (context.getProperty(RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED).asBoolean() && requestFlowFile != null) {
final String prefix = context.getProperty(RESPONSE_HEADER_REQUEST_ATTRIBUTES_PREFIX).evaluateAttributeExpressions(requestFlowFile).getValue();
// write the response headers as attributes
// this will overwrite any existing flowfile attributes
requestFlowFile = session.putAllAttributes(requestFlowFile, convertAttributesFromHeaders(responseHttp, prefix));
}
route(requestFlowFile, responseFlowFile, session, context, statusCode);
}
@ -1255,10 +1269,12 @@ public class InvokeHTTP extends AbstractProcessor {
/**
* Returns a Map of flowfile attributes from the response http headers. Multivalue headers are naively converted to comma separated strings.
* Prefix is passed in to allow differentiation for these new attributes.
*/
private Map<String, String> convertAttributesFromHeaders(final Response responseHttp) {
private Map<String, String> convertAttributesFromHeaders(final Response responseHttp, final String prefix) {
// create a new hashmap to store the values from the connection
final Map<String, String> attributes = new HashMap<>();
final String trimmedPrefix = trimToEmpty(prefix);
final Headers headers = responseHttp.headers();
headers.names().forEach((key) -> {
final List<String> values = headers.values(key);
@ -1266,7 +1282,7 @@ public class InvokeHTTP extends AbstractProcessor {
if (!values.isEmpty()) {
// create a comma separated string from the values, this is stored in the map
final String value = StringUtils.join(values, MULTIPLE_HEADER_DELIMITER);
attributes.put(key, value);
attributes.put(trimmedPrefix + key, value);
}
});

15
nifi-extension-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/InvokeHTTPTest.java
View File

@ -452,8 +452,10 @@ public class InvokeHTTPTest {
@Test
public void testRunGetHttp200SuccessResponseHeaderRequestAttributes() {
final String prefix = "response.";
setUrlProperty();
runner.setProperty(InvokeHTTP.RESPONSE_HEADER_REQUEST_ATTRIBUTES_ENABLED, Boolean.TRUE.toString());
runner.setProperty(InvokeHTTP.RESPONSE_HEADER_REQUEST_ATTRIBUTES_PREFIX, prefix);
final String firstHeader = String.class.getSimpleName();
final String secondHeader = Integer.class.getSimpleName();
@ -470,10 +472,19 @@ public class InvokeHTTPTest {
assertRelationshipStatusCodeEquals(InvokeHTTP.RESPONSE, HTTP_OK);
final MockFlowFile requestFlowFile = getRequestFlowFile();
requestFlowFile.assertAttributeEquals(CONTENT_LENGTH_HEADER, Integer.toString(0));
requestFlowFile.assertAttributeEquals(prefix + CONTENT_LENGTH_HEADER, Integer.toString(0));
requestFlowFile.assertAttributeNotExists(CONTENT_LENGTH_HEADER);
final String repeatedHeaders = String.format("%s, %s", firstHeader, secondHeader);
requestFlowFile.assertAttributeEquals(REPEATED_HEADER, repeatedHeaders);
requestFlowFile.assertAttributeEquals(prefix + REPEATED_HEADER, repeatedHeaders);
requestFlowFile.assertAttributeNotExists(REPEATED_HEADER);
final MockFlowFile responseFlowFile = getResponseFlowFile();
responseFlowFile.assertAttributeNotExists(prefix + CONTENT_LENGTH_HEADER);
responseFlowFile.assertAttributeEquals(CONTENT_LENGTH_HEADER, Integer.toString(0));
responseFlowFile.assertAttributeNotExists(prefix + REPEATED_HEADER);
responseFlowFile.assertAttributeEquals(REPEATED_HEADER, repeatedHeaders);
}
@Test