This is an automated email from the ASF dual-hosted git repository.
exceptionfactory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push:
new 6e46f7e2ac NIFI-15575 Switched to Javadoc snippet tag for code
examples in comments (#10879)
6e46f7e2ac is described below
commit 6e46f7e2ac0193aba6c81117816345d4c6721ef8
Author: dan-s1 <[email protected]>
AuthorDate: Fri Feb 13 15:42:16 2026 -0500
NIFI-15575 Switched to Javadoc snippet tag for code examples in comments
(#10879)
Signed-off-by: David Handermann <[email protected]>
---
.../java/org/apache/nifi/sql/CalciteDatabase.java | 8 +-
.../nifi/serialization/record/RecordFieldType.java | 88 ++++++-------
.../java/org/apache/nifi/util/FormatUtils.java | 14 +-
.../apache/nifi/util/NaiveSearchRingBuffer.java | 23 ++--
.../org/apache/nifi/util/text/DateTimeMatcher.java | 18 +--
.../aws/AwsSecretsManagerParameterProvider.java | 6 +-
.../AwsSecretsManagerParameterValueProvider.java | 11 +-
.../strategies/FileCredentialsStrategy.java | 8 +-
.../AzureKeyVaultSecretsParameterProvider.java | 7 +-
.../groovyx/flow/ProcessSessionWrap.java | 22 ++--
.../HashiCorpVaultParameterValueProvider.java | 11 +-
.../nifi/processors/standard/TestQueryRecord.java | 58 ++++-----
.../controller/ControllerServiceProxyWrapper.java | 142 ++++++++++-----------
.../impl/FileBasedClusterNodeFirewall.java | 14 +-
.../org/apache/nifi/controller/ComponentNode.java | 18 ++-
15 files changed, 221 insertions(+), 227 deletions(-)
diff --git
a/nifi-commons/nifi-calcite-utils/src/main/java/org/apache/nifi/sql/CalciteDatabase.java
b/nifi-commons/nifi-calcite-utils/src/main/java/org/apache/nifi/sql/CalciteDatabase.java
index 537f9956f3..91f053f326 100644
---
a/nifi-commons/nifi-calcite-utils/src/main/java/org/apache/nifi/sql/CalciteDatabase.java
+++
b/nifi-commons/nifi-calcite-utils/src/main/java/org/apache/nifi/sql/CalciteDatabase.java
@@ -52,8 +52,7 @@ import java.util.Properties;
* The typical usage pattern for this class is as follows:
* </p>
*
- * <pre>
- * <code>
+ * {@snippet :
* try (final CalciteDatabase database = new CalciteDatabase()) {
* final ResettableDataSource dataSource = getDataSource();
* final NiFiTable firstTable = new NiFiTable("MY_TABLE", dataSource,
getLogger());
@@ -64,11 +63,10 @@ import java.util.Properties;
* database.addTable(secondTable);
*
* try (final PreparedStatement stmt =
database.getConnection().prepareStatement("SELECT * FROM MY_TABLE")) {
- * ...
+ * // Custom code
* }
* }
- * </code>
- * </pre>
+ * }
*/
public class CalciteDatabase implements Closeable {
private static final Logger logger =
LoggerFactory.getLogger(CalciteDatabase.class);
diff --git
a/nifi-commons/nifi-record/src/main/java/org/apache/nifi/serialization/record/RecordFieldType.java
b/nifi-commons/nifi-record/src/main/java/org/apache/nifi/serialization/record/RecordFieldType.java
index 8e2f87c40e..047a0d1336 100644
---
a/nifi-commons/nifi-record/src/main/java/org/apache/nifi/serialization/record/RecordFieldType.java
+++
b/nifi-commons/nifi-record/src/main/java/org/apache/nifi/serialization/record/RecordFieldType.java
@@ -121,24 +121,22 @@ public enum RecordFieldType {
* created by providing the {@link RecordSchema} for the record:
* </p>
*
- * <code>
- * final DataType recordType =
RecordFieldType.RECORD.getRecordDataType(recordSchema);
- * </code>
+ * {@snippet :
+ * final DataType recordType =
RecordFieldType.RECORD.getRecordDataType(recordSchema);
+ * }
*
* <p>
* A field of type RECORD should always have a {@link RecordDataType}, so
the following idiom is acceptable for use:
* </p>
*
- * <code>
- * <pre>
- * final DataType dataType = ...;
- * if (dataType.getFieldType() == RecordFieldType.RECORD) {
- * final RecordDataType recordDataType = (RecordDataType) dataType;
- * final RecordSchema childSchema = recordDataType.getChildSchema();
- * ...
+ * {@snippet :
+ * final DataType dataType; // TODO assignment for dataType
+ * if (dataType.getFieldType() == RecordFieldType.RECORD) {
+ * final RecordDataType recordDataType = (RecordDataType) dataType;
+ * final RecordSchema childSchema =
recordDataType.getChildSchema();
+ * // Other code
+ * }
* }
- * </pre>
- * </code>
*/
RECORD("record", null, new RecordDataType((RecordSchema) null)),
@@ -148,24 +146,22 @@ public enum RecordFieldType {
* For example, if a field should allow either a Long or an Integer, this
can be accomplished by using:
* </p>
*
- * <code>
- * final DataType choiceType = RecordFieldType.CHOICE.getChoiceDataType(
RecordFieldType.INT.getDataType(), RecordFieldType.LONG.getDataType() );
- * </code>
+ * {@snippet :
+ * final DataType choiceType =
RecordFieldType.CHOICE.getChoiceDataType( RecordFieldType.INT.getDataType(),
RecordFieldType.LONG.getDataType() );
+ * }
*
* <p>
* A field of type CHOICE should always have a {@link ChoiceDataType}, so
the following idiom is acceptable for use:
* </p>
*
- * <code>
- * <pre>
- * final DataType dataType = ...;
- * if (dataType.getFieldType() == RecordFieldType.CHOICE) {
- * final ChoiceDataType choiceDataType = (ChoiceDataType) dataType;
- * final List<DataType> allowableTypes =
choiceDataType.getPossibleSubTypes();
- * ...
+ * {@snippet :
+ * final DataType dataType; // TODO assignment for dataType
+ * if (dataType.getFieldType() == RecordFieldType.CHOICE) {
+ * final ChoiceDataType choiceDataType = (ChoiceDataType) dataType;
+ * final List<DataType> allowableTypes =
choiceDataType.getPossibleSubTypes();
+ * // Other code
+ * }
* }
- * </pre>
- * </code>
*/
CHOICE("choice", null, new ChoiceDataType(Collections.emptyList())),
@@ -176,24 +172,22 @@ public enum RecordFieldType {
* this field should be created using the {@link
#getArrayDataType(DataType)} method:
* </p>
*
- * <code>
- * final DataType arrayType = RecordFieldType.ARRAY.getArrayDataType(
RecordFieldType.INT.getDataType() );
- * </code>
+ * {@snippet :
+ * final DataType arrayType = RecordFieldType.ARRAY.getArrayDataType(
RecordFieldType.INT.getDataType() );
+ * }
*
* <p>
* A field of type ARRAY should always have an {@link ArrayDataType}, so
the following idiom is acceptable for use:
* </p>
*
- * <code>
- * <pre>
- * final DataType dataType = ...;
- * if (dataType.getFieldType() == RecordFieldType.ARRAY) {
- * final ArrayDataType arrayDataType = (ArrayDataType) dataType;
- * final DataType elementType = arrayDataType.getElementType();
- * ...
+ * {@snippet :
+ * final DataType dataType; // TODO assignment for dataType
+ * if (dataType.getFieldType() == RecordFieldType.ARRAY) {
+ * final ArrayDataType arrayDataType = (ArrayDataType) dataType;
+ * final DataType elementType = arrayDataType.getElementType();
+ * // Other code
+ * }
* }
- * </pre>
- * </code>
*/
ARRAY("array", null, new ArrayDataType(null)),
@@ -203,24 +197,22 @@ public enum RecordFieldType {
* created by providing the {@link DataType} for the values:
* </p>
*
- * <code>
- * final DataType recordType = RecordFieldType.MAP.getRecordDataType(
RecordFieldType.STRING.getDataType() );
- * </code>
+ * {@snippet :
+ * final DataType recordType = RecordFieldType.MAP.getRecordDataType(
RecordFieldType.STRING.getDataType() );
+ * }
*
* <p>
* A field of type MAP should always have a {@link MapDataType}, so the
following idiom is acceptable for use:
* </p>
*
- * <code>
- * <pre>
- * final DataType dataType = ...;
- * if (dataType.getFieldType() == RecordFieldType.MAP) {
- * final MapDataType mapDataType = (MapDataType) dataType;
- * final DataType valueType = mapDataType.getValueType();
- * ...
+ * {@snippet :
+ * final DataType dataType; // TODO assignment for dataType
+ * if (dataType.getFieldType() == RecordFieldType.MAP) {
+ * final MapDataType mapDataType = (MapDataType) dataType;
+ * final DataType valueType = mapDataType.getValueType();
+ * // Other code
+ * }
* }
- * </pre>
- * </code>
*/
MAP("map", null, new MapDataType(null));
diff --git
a/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/FormatUtils.java
b/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/FormatUtils.java
index 7210932692..da59c8541d 100644
---
a/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/FormatUtils.java
+++
b/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/FormatUtils.java
@@ -164,13 +164,13 @@ public class FormatUtils {
* This method handles decimal values over {@code 1 ns}, but {@code < 1
ns} will return {@code 0} in any other unit.
* <p>
* Examples:
- * <p>
- * "10 seconds", {@code TimeUnit.MILLISECONDS} -> 10_000.0
- * "0.010 s", {@code TimeUnit.MILLISECONDS} -> 10.0
- * "0.010 s", {@code TimeUnit.SECONDS} -> 0.010
- * "0.010 ns", {@code TimeUnit.NANOSECONDS} -> 1
- * "0.010 ns", {@code TimeUnit.MICROSECONDS} -> 0
- *
+ * {@snippet lang="text" :
+ * "10 seconds", TimeUnit.MILLISECONDS -> 10_000.0
+ * "0.010 s", TimeUnit.MILLISECONDS -> 10.0
+ * "0.010 s", TimeUnit.SECONDS -> 0.010
+ * "0.010 ns", TimeUnit.NANOSECONDS -> 1
+ * "0.010 ns", TimeUnit.MICROSECONDS -> 0
+ * }
* @param value the {@code String} input
* @param desiredUnit the desired output {@link TimeUnit}
* @return the parsed and converted amount (without a unit)
diff --git
a/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java
b/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java
index ee962b8ade..f1d82e1a92 100644
---
a/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java
+++
b/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java
@@ -30,19 +30,18 @@ import java.util.Arrays;
*
* <p>
* The intended usage paradigm is:
- * <code>
- * <pre>
- * final byte[] searchSequence = ...;
- * final CircularBuffer buffer = new CircularBuffer(searchSequence);
- * while ((int nextByte = in.read()) > 0) {
- * if ( buffer.addAndCompare(nextByte) ) {
- * // This byte is the last byte in the given sequence
- * } else {
- * // This byte does not complete the given sequence
- * }
+ * {@snippet :
+ * final byte[] searchSequence; //TODO assignment
+ * final CircularBuffer buffer = new CircularBuffer(searchSequence);
+ * int nextByte;
+ * while ((nextByte = in.read()) > 0) {
+ * if ( buffer.addAndCompare(nextByte) ) {
+ * // This byte is the last byte in the given sequence
+ * } else {
+ * // This byte does not complete the given sequence
+ * }
+ * }
* }
- * </pre>
- * </code>
* </p>
*/
public class NaiveSearchRingBuffer {
diff --git
a/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/text/DateTimeMatcher.java
b/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/text/DateTimeMatcher.java
index 678779e796..407ebd69d3 100644
---
a/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/text/DateTimeMatcher.java
+++
b/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/text/DateTimeMatcher.java
@@ -22,15 +22,15 @@ package org.apache.nifi.util.text;
* by the Time Format used in {@link java.time.format.DateTimeFormatter}. It
is not uncommon to see code written along the lines of:
* </p>
*
- * <code><pre>
- * final String format = "yyyy/MM/dd HH:mm:ss.SSS";
- * try {
- * DateTimeFormatter.ofPattern(format).parse(text);
- * return true;
- * } catch (Exception e) {
- * return false;
- * }
- * </pre></code>
+ * {@snippet :
+ * final String format = "yyyy/MM/dd HH:mm:ss.SSS";
+ * try {
+ * DateTimeFormatter.ofPattern(format).parse(text);
+ * return true;
+ * } catch (Exception e) {
+ * return false;
+ * }
+ * }
*
* <p>
* This approach, however, is frowned upon for two important reasons.
Firstly, the performance is poor. A micro-benchmark that involves executing
diff --git
a/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-providers/src/main/java/org/apache/nifi/parameter/aws/AwsSecretsManagerParameterProvider.java
b/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-providers/src/main/java/org/apache/nifi/parameter/aws/AwsSecretsManagerParameterProvider.java
index c962ca511d..e1371aa95b 100644
---
a/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-providers/src/main/java/org/apache/nifi/parameter/aws/AwsSecretsManagerParameterProvider.java
+++
b/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-providers/src/main/java/org/apache/nifi/parameter/aws/AwsSecretsManagerParameterProvider.java
@@ -71,8 +71,10 @@ import javax.net.ssl.X509ExtendedKeyManager;
import javax.net.ssl.X509TrustManager;
/**
- * Reads secrets from AWS Secrets Manager to provide parameter values.
Secrets must be created similar to the following AWS cli command: <br/><br/>
- * <code>aws secretsmanager create-secret --name "[Context]" --secret-string
'{ "[Param]": "[secretValue]", "[Param2]": "[secretValue2]" }'</code> <br/><br/>
+ * Reads secrets from AWS Secrets Manager to provide parameter values.
Secrets must be created similar to the following AWS cli command:
+ * {@snippet lang="text" :
+ * aws secretsmanager create-secret --name "[Context]" --secret-string '{
"[Param]": "[secretValue]", "[Param2]": "[secretValue2]" }'
+ * }
*/
@Tags({"aws", "secretsmanager", "secrets", "manager"})
@CapabilityDescription("Fetches parameters from AWS SecretsManager. Each
secret becomes a Parameter group, which can map to a Parameter Context, with " +
diff --git
a/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-value-providers/src/main/java/org/apache/nifi/stateless/parameter/AwsSecretsManagerParameterValueProvider.java
b/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-value-providers/src/main/java/org/apache/nifi/stateless/parameter/AwsSecretsManagerParameterValueProvider.java
index 7dac4d4724..665f55a2ab 100644
---
a/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-value-providers/src/main/java/org/apache/nifi/stateless/parameter/AwsSecretsManagerParameterValueProvider.java
+++
b/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-parameter-value-providers/src/main/java/org/apache/nifi/stateless/parameter/AwsSecretsManagerParameterValueProvider.java
@@ -42,16 +42,17 @@ import java.util.List;
import java.util.Properties;
/**
- * Reads secrets from AWS Secrets Manager to provide parameter values.
Secrets must be created similar to the following AWS cli command: <br/><br/>
- * <code>aws secretsmanager create-secret --name "[Context]" --secret-string
'{ "[Param]": "[secretValue]", "[Param2]": "[secretValue2]" }'</code> <br/><br/>
- *
+ * Reads secrets from AWS Secrets Manager to provide parameter values.
Secrets must be created similar to the following AWS cli command:
+ * {@snippet lang="text" :
+ * aws secretsmanager create-secret --name "[Context]" --secret-string
'{ "[Param]": "[secretValue]", "[Param2]": "[secretValue2]" }'
+ * }
* A standard configuration for this provider would be: <br/><br/>
*
- * <code>
+ * {@snippet lang="properties" :
* nifi.stateless.parameter.provider.AWSSecretsManager.name=AWS Secrets
Manager Value Provider
*
nifi.stateless.parameter.provider.AWSSecretsManager.type=org.apache.nifi.stateless.parameter.AwsSecretsManagerParameterValueProvider
*
nifi.stateless.parameter.provider.AWSSecretsManager.properties.aws-credentials-file=./conf/bootstrap-aws.conf
- * </code>
+ * }
*/
public class AwsSecretsManagerParameterValueProvider extends
AbstractSecretBasedParameterValueProvider implements ParameterValueProvider {
private static final Logger logger =
LoggerFactory.getLogger(AwsSecretsManagerParameterValueProvider.class);
diff --git
a/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/credentials/provider/factory/strategies/FileCredentialsStrategy.java
b/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/credentials/provider/factory/strategies/FileCredentialsStrategy.java
index 0851525cac..ff167fe421 100644
---
a/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/credentials/provider/factory/strategies/FileCredentialsStrategy.java
+++
b/nifi-extension-bundles/nifi-aws-bundle/nifi-aws-processors/src/main/java/org/apache/nifi/processors/aws/credentials/provider/factory/strategies/FileCredentialsStrategy.java
@@ -27,10 +27,10 @@ import java.io.File;
/**
* Supports AWS credentials stored in a file. The file format should be a
Java properties file like the following:
*
- * <code>
- * accessKey = XXXXXXXXXXXXXXXXXXXX
- * secretKey = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- * </code>
+ * {@snippet lang="properties" :
+ * accessKey = XXXXXXXXXXXXXXXXXXXX
+ * secretKey = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+ * }
*
* * @see <a
href="http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/auth/PropertiesFileCredentialsProvider.html";>
* PropertiesFileCredentialsProvider</a>
diff --git
a/nifi-extension-bundles/nifi-azure-bundle/nifi-azure-parameter-providers/src/main/java/org/apache/nifi/parameter/azure/AzureKeyVaultSecretsParameterProvider.java
b/nifi-extension-bundles/nifi-azure-bundle/nifi-azure-parameter-providers/src/main/java/org/apache/nifi/parameter/azure/AzureKeyVaultSecretsParameterProvider.java
index 2132966c6f..841a17ee9a 100644
---
a/nifi-extension-bundles/nifi-azure-bundle/nifi-azure-parameter-providers/src/main/java/org/apache/nifi/parameter/azure/AzureKeyVaultSecretsParameterProvider.java
+++
b/nifi-extension-bundles/nifi-azure-bundle/nifi-azure-parameter-providers/src/main/java/org/apache/nifi/parameter/azure/AzureKeyVaultSecretsParameterProvider.java
@@ -42,9 +42,10 @@ import java.util.Map;
import java.util.regex.Pattern;
/**
- * Reads secrets from Azure Key Vault Secrets to provide parameter values.
Secrets must be created similar to the following Azure cli command: <br/><br/>
- * <code>az keyvault secret set --vault-name <your-unique-keyvault-name>
--name <parameter-name> --value <parameter-value>
- * --tags group-name=<group-name></code> <br/><br/>
+ * Reads secrets from Azure Key Vault Secrets to provide parameter values.
Secrets must be created similar to the following Azure cli command:
+ * {@snippet lang="text" :
+ * az keyvault secret set --vault-name <your-unique-keyvault-name>
--name <parameter-name> --value <parameter-value> --tags group-name=<group-name>
+ * }
* @see <a
href="https://learn.microsoft.com/en-us/azure/key-vault/secrets/quick-create-cli";>Azure
Key Vault Secrets</a>
*/
@Tags({"azure", "keyvault", "key", "vault", "secrets"})
diff --git
a/nifi-extension-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/flow/ProcessSessionWrap.java
b/nifi-extension-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/flow/ProcessSessionWrap.java
index 0f2970953b..a7deb61461 100644
---
a/nifi-extension-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/flow/ProcessSessionWrap.java
+++
b/nifi-extension-bundles/nifi-groovyx-bundle/nifi-groovyx-processors/src/main/java/org/apache/nifi/processors/groovyx/flow/ProcessSessionWrap.java
@@ -84,16 +84,18 @@ public abstract class ProcessSessionWrap implements
ProcessSession {
/**
* function returns wrapped flowfile with session for the simplified
script access.
- * The sample implementation: <code>
- * public SessionFile wrap(FlowFile f) {
- * if (f == null) {
- * return null;
- * }
- * if (f instanceof SessionFile) {
- * return ((SessionFile) f);
- * }
- * return new SessionFile(this, f);
- * }</code>
+ * The sample implementation:
+ * {@snippet :
+ * public SessionFile wrap(FlowFile f) {
+ * if (f == null) {
+ * return null;
+ * }
+ * if (f instanceof SessionFile sessionFile) {
+ * return sessionFile;
+ * }
+ * return new SessionFile(this, f);
+ * }
+ * }
*/
public abstract SessionFile wrap(FlowFile f);
diff --git
a/nifi-extension-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-value-provider/src/main/java/org/apache/nifi/stateless/parameter/HashiCorpVaultParameterValueProvider.java
b/nifi-extension-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-value-provider/src/main/java/org/apache/nifi/stateless/parameter/HashiCorpVaultParameterValueProvider.java
index dd97a78ffa..01bd82100c 100644
---
a/nifi-extension-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-value-provider/src/main/java/org/apache/nifi/stateless/parameter/HashiCorpVaultParameterValueProvider.java
+++
b/nifi-extension-bundles/nifi-hashicorp-vault-bundle/nifi-hashicorp-vault-parameter-value-provider/src/main/java/org/apache/nifi/stateless/parameter/HashiCorpVaultParameterValueProvider.java
@@ -33,17 +33,18 @@ import java.util.Objects;
* Reads secrets from HashiCorp Vault to provide parameters. An example of
setting one such secret parameter value
* using the Vault CLI would be:
*
- * <code>vault kv put "${vault.kv.path}/[ParamContextName]"
[Param1]=[ParamValue1] [Param2]=[ParamValue2]</code>
+ * {@snippet lang="text" :
+ * vault kv put "${vault.kv.path}/[ParamContextName]"
[Param1]=[ParamValue1] [Param2]=[ParamValue2]
+ * }
*
* Here, vault.kv.path is supplied by the file specified by the "Vault
Configuration File" property.
*
- * A standard configuration for this provider would be: <br/><br/>
- *
- * <code>
+ * A standard configuration for this provider would be:
+ * {@snippet lang="properties" :
* nifi.stateless.parameter.provider.Vault.name=HashiCorp Vault Provider
*
nifi.stateless.parameter.provider.Vault.type=org.apache.nifi.stateless.parameter.HashiCorpVaultParameterProvider
*
nifi.stateless.parameter.provider.Vault.properties.vault-configuration-file=./conf/bootstrap-hashicorp-vault.conf
- * </code>
+ * }
*/
public class HashiCorpVaultParameterValueProvider extends
AbstractSecretBasedParameterValueProvider implements ParameterValueProvider {
private static final String KEY_VALUE_PATH = "vault.kv.path";
diff --git
a/nifi-extension-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestQueryRecord.java
b/nifi-extension-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestQueryRecord.java
index 46f84480da..c361bf3f3a 100644
---
a/nifi-extension-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestQueryRecord.java
+++
b/nifi-extension-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/processors/standard/TestQueryRecord.java
@@ -794,28 +794,28 @@ public class TestQueryRecord {
/**
* Returns a Record that, if written in JSON, would look like:
- * <code><pre>
- * {
- * "person": {
- * "name": "John Doe",
- * "age": 30,
- * "favoriteColors": [ "red", "green" ],
- * "dob": 598741575825,
- * "dobTimestamp": 598741575825,
- * "joinDate": "2018-02-04",
- * "weight": 180.8,
- * "mother": {
- * "name": "Jane Doe"
- * }
- * },
- * "favouriteThings": {
- * "sport": "basketball",
- * "color": "green",
- * "roses": "raindrops",
- * "kittens": "whiskers"
- * }
+ * {@snippet lang="json" :
+ * {
+ * "person": {
+ * "name": "John Doe",
+ * "age": 30,
+ * "favoriteColors": [ "red", "green" ],
+ * "dob": 598741575825,
+ * "dobTimestamp": 598741575825,
+ * "joinDate": "2018-02-04",
+ * "weight": 180.8,
+ * "mother": {
+ * "name": "Jane Doe"
+ * }
+ * },
+ * "favouriteThings": {
+ * "sport": "basketball",
+ * "color": "green",
+ * "roses": "raindrops",
+ * "kittens": "whiskers"
+ * }
+ * }
* }
- * </pre></code>
*
* @return the Record
*/
@@ -872,12 +872,12 @@ public class TestQueryRecord {
/**
* Returns a Record that, if written in JSON, would look like:
- * <code><pre>
- * {
- * "id": >id<,
- * "tags": [>tag1<,>tag2<...]
- * }
- * </pre></code>
+ * {@snippet lang="json":
+ * {
+ * "id": "someId",
+ * "tags": ["someTag1","someTag2" ...]
+ * }
+ *}
*
* @return the Record
*/
@@ -896,7 +896,7 @@ public class TestQueryRecord {
/**
* Returns a Record that, if written in JSON, would look like:
- * <code><pre>
+ * {@snippet lang="json" :
* {
* "name": "John Doe",
* "title": "Software Engineer",
@@ -920,7 +920,7 @@ public class TestQueryRecord {
* "label": "home"
* }]
* }
- * </pre></code>
+ * }
*
* @return the Record
*/
diff --git
a/nifi-framework-api/src/main/java/org/apache/nifi/controller/ControllerServiceProxyWrapper.java
b/nifi-framework-api/src/main/java/org/apache/nifi/controller/ControllerServiceProxyWrapper.java
index b00e218836..999f5f97d1 100644
---
a/nifi-framework-api/src/main/java/org/apache/nifi/controller/ControllerServiceProxyWrapper.java
+++
b/nifi-framework-api/src/main/java/org/apache/nifi/controller/ControllerServiceProxyWrapper.java
@@ -30,42 +30,42 @@ package org.apache.nifi.controller;
*
* E.g.:
*
- * <pre><code>public interface IConnectionProviderService {
- * IConnection getConnection();
- * void closeConnection(IConnection);
+ * {@snippet :
+ * public interface IConnectionProviderService {
+ * IConnection getConnection();
+ * void closeConnection(IConnection connection);
+ * }
+ *
+ * public class ConnectionProviderServiceImpl {
+ * IConnection getConnection() {
+ * return new SimpleConnection();
+ * }
+ *
+ * void closeConnection(IConnection connection) {
+ * if (connection instanceof SimpleConnection) {
+ * // Other code
+ * } else {
+ * throw new InvalidArgumentException();
+ * }
+ * }
+ * }
+ *
+ * public class ConnectionUserProcessor {
+ * IConnectionProviderService service; // Set to
ConnectionProviderServiceImpl
+ *
+ * void onTrigger() {
+ * IConnection connection = service.getConnection();
+ *
+ * // 'connection' at this point is a proxy of a 'SimpleConnection'
object
+ * // So '(connection instanceof IConnection)' is true, but
+ * // '(connection instanceof SimpleConnection)' is false
+ * // Other code
+ *
+ * service.closeConnection(connection); // This would have thrown
InvalidArgumentException
+ * }
+ * }
* }
*
- * public class ConnectionProviderServiceImpl {
- * IConnection getConnection() {
- * return new SimpleConnection();
- * }
- *
- * void closeConnection(IConnection) {
- * if (connection instanceof SimpleConnection) {
- * ...
- * } else {
- * throw new InvalidArgumentException();
- * }
- * }
- * }
- *
- * public class ConnectionUserProcessor {
- * IConnectionProviderService service; #Set to
ConnectionProviderServiceImpl
- *
- * void onTrigger() {
- * IConnection connection = service.getConnection();
- *
- * # 'connection' at this point is a proxy of a 'SimpleConnection'
object
- * # So '(connection instanceof IConnection)' is true, but
- * # '(connection instanceof SimpleConnection)' is false
- *
- * ...
- *
- * service.closeConnection(connection); # !! This would have thrown
InvalidArgumentException
- * }
- * }
- * </code></pre>
- *
* But why wrap the return value in a proxy in the first place? It is needed
to handle the following scenario:
*
* A Controller Service method returns an object to a Processor.
@@ -74,44 +74,44 @@ package org.apache.nifi.controller;
* Since it tries to use the Processor classloader, it fails.
*
* E.g.:
- * <pre><code>package root.interface;
- *
- * public interface IReportService {
- * IReport getReport();
- * }
- * public interface IReport {
- * void submit();
- * }
- *
- *
- * package root.service;
- *
- * public class ReportServiceImpl {
- * IReport getReport() {
- * return new Report();
- * }
- * }
- * public class ReportImpl {
- * void submit() {
- * Class.forName("roo.service.OtherClass");
- * ...
- * }
- * }
- * public class OtherClass {}
- *
- *
- * package root.processor;
- *
- * public class ReportProcessor {
- * IReportService service; #Set to ReportServiceImpl
- *
- * void onTrigger() {
- * IReport report = service.getReport();
- * ...
- * report.submit(); # !! This would have thrown ClassNotFoundException
- * }
+ * {@snippet :
+ * package root.interface;
+ *
+ * public interface IReportService {
+ * IReport getReport();
+ * }
+ * public interface IReport {
+ * void submit();
+ * }
+ *
+ * package root.service;
+ *
+ * public class ReportServiceImpl {
+ * IReport getReport() {
+ * return new Report();
+ * }
+ * }
+ * public class ReportImpl {
+ * void submit() {
+ * Class.forName("roo.service.OtherClass");
+ * // Other code
+ * }
+ * }
+ * public class OtherClass {}
+ *
+ *
+ * package root.processor;
+ *
+ * public class ReportProcessor {
+ * IReportService service; //Set to ReportServiceImpl
+ *
+ * void onTrigger() {
+ * IReport report = service.getReport();
+ * // Other code
+ * report.submit(); // This would have thrown ClassNotFoundException
+ * }
+ * }
* }
- * </code></pre>
*
* So in general there is a barrier between the Controller Service and the
Processor (or another Controller Service) due to the fact that they have
* their own classloaders.
diff --git
a/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java
b/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java
index cea54afedf..2aed52388d 100644
---
a/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java
+++
b/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java
@@ -35,13 +35,13 @@ import java.util.Collection;
* A file-based implementation of the ClusterFirewall interface. The class is
configured with a file. If the file is empty, then everything is permissible.
Otherwise, the file should contain hostnames
* or IPs formatted as dotted decimals with an optional CIDR suffix. Each
entry must be separated by a newline. An example configuration is given below:
*
- * <code>
- * # hash character is a comment delimiter
- * 1.2.3.4 # exact IP
- * some.host.name # a host name
- * 4.5.6.7/8 # range of CIDR IPs
- * 9.10.11.12/13 # a smaller range of CIDR IPs
- * </code>
+ * {@snippet lang="text" :
+ * # hash character is a comment delimiter
+ * 1.2.3.4 # exact IP
+ * some.host.name # a host name
+ * 4.5.6.7/8 # range of CIDR IPs
+ * 9.10.11.12/13 # a smaller range of CIDR IPs
+ * }
*
* This class allows for synchronization with an optionally configured restore
directory. If configured, then at startup, if the either the config file or the
restore directory's copy is missing, then
* the configuration file will be copied to the appropriate location. If both
restore directory contains a copy that is different in content to configuration
file, then an exception is thrown at
diff --git
a/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ComponentNode.java
b/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ComponentNode.java
index f6231bbb7b..db96181299 100644
---
a/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ComponentNode.java
+++
b/nifi-framework-bundle/nifi-framework/nifi-framework-core-api/src/main/java/org/apache/nifi/controller/ComponentNode.java
@@ -105,17 +105,15 @@ public interface ComponentNode extends
ComponentAuthorizable {
* we don't want to trigger validation for each update, so we can follow
the pattern:
* </p>
*
- * <pre>
- * <code>
- * componentNode.pauseValidationTrigger();
- * try {
- * componentNode.setProperties(properties);
- * componentNode.setAnnotationData(annotationData);
- * } finally {
- * componentNode.resumeValidationTrigger();
+ * {@snippet :
+ * componentNode.pauseValidationTrigger();
+ * try {
+ * componentNode.setProperties(properties);
+ * componentNode.setAnnotationData(annotationData);
+ * } finally {
+ * componentNode.resumeValidationTrigger();
+ * }
* }
- * </code>
- * </pre>
*
* <p>
* When calling this method, it is imperative that {@link
#resumeValidationTrigger()} is always called within a {@code finally} block to
