diff --git a/nifi-nar-maven-plugin/pom.xml b/nifi-nar-maven-plugin/pom.xml index 46dd33319d..765cbdf569 100644 --- a/nifi-nar-maven-plugin/pom.xml +++ b/nifi-nar-maven-plugin/pom.xml @@ -66,6 +66,13 @@ + + org.apache.maven.plugins + maven-checkstyle-plugin + + **/HelpMojo.java + + diff --git a/nifi-parent/pom.xml b/nifi-parent/pom.xml index bdb94c8d72..6fcf3643c1 100644 --- a/nifi-parent/pom.xml +++ b/nifi-parent/pom.xml @@ -205,7 +205,18 @@ 6.5 - + + + org.codehaus.mojo + findbugs-maven-plugin + 3.0.1 + + true + Max + true + 14 + + @@ -248,6 +259,14 @@ org.apache.maven.plugins maven-checkstyle-plugin + + + check-style + + check + + + @@ -327,7 +346,6 @@ warning true - **/HelpMojo.java,**/generated-sources @@ -354,38 +372,49 @@ - - - check-licenses - - check - - - - - checkstyle - - false - + + + check-licenses - org.apache.maven.plugins - maven-checkstyle-plugin + org.apache.rat + apache-rat-plugin - check-style + + check + + verify + + + + + + + + + findbugs + + + + org.codehaus.mojo + findbugs-maven-plugin + + + run-findbugs check - - + + diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/flowfile/attributes/CoreAttributes.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/flowfile/attributes/CoreAttributes.java index b0f40481d6..9b4c3af4b7 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/flowfile/attributes/CoreAttributes.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/flowfile/attributes/CoreAttributes.java @@ -19,18 +19,15 @@ package org.apache.nifi.flowfile.attributes; public enum CoreAttributes implements FlowFileAttributeKey { /** - * The flowfile's path indicates the relative directory to which a FlowFile - * belongs and does not contain the filename + * The flowfile's path indicates the relative directory to which a FlowFile belongs and does not contain the filename */ PATH("path"), /** - * The flowfile's absolute path indicates the absolute directory to which a - * FlowFile belongs and does not contain the filename + * The flowfile's absolute path indicates the absolute directory to which a FlowFile belongs and does not contain the filename */ ABSOLUTE_PATH("absolute.path"), /** - * The filename of the FlowFile. The filename should not contain any - * directory structure. + * The filename of the FlowFile. The filename should not contain any directory structure. */ FILENAME("filename"), /** @@ -50,8 +47,7 @@ public enum CoreAttributes implements FlowFileAttributeKey { */ DISCARD_REASON("discard.reason"), /** - * Indicates an identifier other than the FlowFile's UUID that is known to - * refer to this FlowFile. + * Indicates an identifier other than the FlowFile's UUID that is known to refer to this FlowFile. */ ALTERNATE_IDENTIFIER("alternate.identifier"); diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/VersionNegotiator.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/VersionNegotiator.java index a05ea9de65..d8ee27a45f 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/VersionNegotiator.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/VersionNegotiator.java @@ -26,13 +26,10 @@ public interface VersionNegotiator { int getVersion(); /** - * Sets the version of this resource to the specified version. Only the - * lower byte of the version is relevant. + * Sets the version of this resource to the specified version. Only the lower byte of the version is relevant. * * @param version the version to set - * @throws IllegalArgumentException if the given Version is not supported by - * this resource, as is indicated by the {@link #isVersionSupported(int)} - * method + * @throws IllegalArgumentException if the given Version is not supported by this resource, as is indicated by the {@link #isVersionSupported(int)} method */ void setVersion(int version) throws IllegalArgumentException; @@ -43,9 +40,8 @@ public interface VersionNegotiator { int getPreferredVersion(); /** - * Gets the preferred version of this resource that is no greater than the - * given maxVersion. If no acceptable version exists that is less than - * maxVersion, then null is returned + * Gets the preferred version of this resource that is no greater than the given maxVersion. If no acceptable version exists that is less than maxVersion, then null is + * returned * * @param maxVersion the maximum version desired * @return the preferred version if found; null otherwise @@ -53,8 +49,7 @@ public interface VersionNegotiator { Integer getPreferredVersion(int maxVersion); /** - * Indicates whether or not the specified version is supported by this - * resource + * Indicates whether or not the specified version is supported by this resource * * @param version the version to test * @return true if supported; false otherwise diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/exception/TransmissionDisabledException.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/exception/TransmissionDisabledException.java index 05fd915af1..d18c807957 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/exception/TransmissionDisabledException.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/exception/TransmissionDisabledException.java @@ -17,8 +17,7 @@ package org.apache.nifi.remote.exception; /** - * Indicates that the user disabled transmission while communications were - * taking place with a peer + * Indicates that the user disabled transmission while communications were taking place with a peer */ public class TransmissionDisabledException extends RuntimeException { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/CompressionOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/CompressionOutputStream.java index 311c84c531..525b5b15db 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/CompressionOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/CompressionOutputStream.java @@ -58,8 +58,7 @@ public class CompressionOutputStream extends OutputStream { } /** - * Compresses the currently buffered chunk of data and sends it to the - * output stream + * Compresses the currently buffered chunk of data and sends it to the output stream * * @throws IOException if issues occur writing to stream */ diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/BufferStateManager.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/BufferStateManager.java index e613155183..6e54d62fff 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/BufferStateManager.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/BufferStateManager.java @@ -38,9 +38,7 @@ public class BufferStateManager { } /** - * Ensures that the buffer is at least as big as the size specified, - * resizing the buffer if necessary. This operation MAY change the direction - * of the buffer. + * Ensures that the buffer is at least as big as the size specified, resizing the buffer if necessary. This operation MAY change the direction of the buffer. * * @param requiredSize the desired size of the buffer */ diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelInputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelInputStream.java index 19179bcdf1..ca6de8513f 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelInputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelInputStream.java @@ -47,8 +47,7 @@ public class SSLSocketChannelInputStream extends InputStream { } /** - * Closes the underlying SSLSocketChannel, which will also close the - * OutputStream and connection + * Closes the underlying SSLSocketChannel, which will also close the OutputStream and connection */ @Override public void close() throws IOException { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelOutputStream.java index ce4e4200fc..262cf54f61 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/remote/io/socket/ssl/SSLSocketChannelOutputStream.java @@ -43,8 +43,7 @@ public class SSLSocketChannelOutputStream extends OutputStream { } /** - * Closes the underlying SSLSocketChannel, which also will close the - * InputStream and the connection + * Closes the underlying SSLSocketChannel, which also will close the InputStream and the connection */ @Override public void close() throws IOException { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedInputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedInputStream.java index aaf37ea397..2afaa70623 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedInputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedInputStream.java @@ -19,11 +19,8 @@ package org.apache.nifi.stream.io; import java.io.InputStream; /** - * This class is a slight modification of the BufferedInputStream in the java.io - * package. The modification is that this implementation does not provide - * synchronization on method calls, which means that this class is not suitable - * for use by multiple threads. However, the absence of these synchronized - * blocks results in potentially much better performance. + * This class is a slight modification of the BufferedInputStream in the java.io package. The modification is that this implementation does not provide synchronization on method calls, which means + * that this class is not suitable for use by multiple threads. However, the absence of these synchronized blocks results in potentially much better performance. */ public class BufferedInputStream extends java.io.BufferedInputStream { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedOutputStream.java index eadfcab953..dc56927175 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/BufferedOutputStream.java @@ -21,11 +21,8 @@ import java.io.IOException; import java.io.OutputStream; /** - * This class is a slight modification of the - * {@link java.io.BufferedOutputStream} class. This implementation differs in - * that it does not mark methods as synchronized. This means that this class is - * not suitable for writing by multiple concurrent threads. However, the removal - * of the synchronized keyword results in potentially much better performance. + * This class is a slight modification of the {@link java.io.BufferedOutputStream} class. This implementation differs in that it does not mark methods as synchronized. This means that this class is + * not suitable for writing by multiple concurrent threads. However, the removal of the synchronized keyword results in potentially much better performance. */ public class BufferedOutputStream extends FilterOutputStream { @@ -35,15 +32,13 @@ public class BufferedOutputStream extends FilterOutputStream { protected byte buf[]; /** - * The number of valid bytes in the buffer. This value is always in the - * range 0 through buf.length; elements + * The number of valid bytes in the buffer. This value is always in the range 0 through buf.length; elements * buf[0] through buf[count-1] contain valid byte data. */ protected int count; /** - * Creates a new buffered output stream to write data to the specified - * underlying output stream. + * Creates a new buffered output stream to write data to the specified underlying output stream. * * @param out the underlying output stream. */ @@ -52,8 +47,7 @@ public class BufferedOutputStream extends FilterOutputStream { } /** - * Creates a new buffered output stream to write data to the specified - * underlying output stream with the specified buffer size. + * Creates a new buffered output stream to write data to the specified underlying output stream with the specified buffer size. * * @param out the underlying output stream. * @param size the buffer size. @@ -92,16 +86,12 @@ public class BufferedOutputStream extends FilterOutputStream { } /** - * Writes len bytes from the specified byte array starting at - * offset off to this buffered output stream. + * Writes len bytes from the specified byte array starting at offset off to this buffered output stream. * *

- * Ordinarily this method stores bytes from the given array into this - * stream's buffer, flushing the buffer to the underlying output stream as - * needed. If the requested length is at least as large as this stream's - * buffer, however, then this method will flush the buffer and write the - * bytes directly to the underlying output stream. Thus redundant - * BufferedOutputStreams will not copy data unnecessarily. + * Ordinarily this method stores bytes from the given array into this stream's buffer, flushing the buffer to the underlying output stream as needed. If the requested length is at least as large + * as this stream's buffer, however, then this method will flush the buffer and write the bytes directly to the underlying output stream. Thus redundant BufferedOutputStreams will not + * copy data unnecessarily. * * @param b the data. * @param off the start offset in the data. @@ -126,8 +116,7 @@ public class BufferedOutputStream extends FilterOutputStream { } /** - * Flushes this buffered output stream. This forces any buffered output - * bytes to be written out to the underlying output stream. + * Flushes this buffered output stream. This forces any buffered output bytes to be written out to the underlying output stream. * * @exception IOException if an I/O error occurs. * @see java.io.FilterOutputStream#out diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayInputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayInputStream.java index 284cd54837..85c8c4fdd7 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayInputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayInputStream.java @@ -19,55 +19,41 @@ package org.apache.nifi.stream.io; import java.io.InputStream; /** - * This class performs the same function as java.io.ByteArrayInputStream but - * does not mark its methods as synchronized + * This class performs the same function as java.io.ByteArrayInputStream but does not mark its methods as synchronized */ public class ByteArrayInputStream extends InputStream { /** - * An array of bytes that was provided by the creator of the stream. - * Elements buf[0] through buf[count-1] are the - * only bytes that can ever be read from the stream; element - * buf[pos] is the next byte to be read. + * An array of bytes that was provided by the creator of the stream. Elements buf[0] through buf[count-1] are the only bytes that can ever be read from the stream; + * element buf[pos] is the next byte to be read. */ protected byte buf[]; /** - * The index of the next character to read from the input stream buffer. - * This value should always be nonnegative and not larger than the value of - * count. The next byte to be read from the input stream buffer - * will be buf[pos]. + * The index of the next character to read from the input stream buffer. This value should always be nonnegative and not larger than the value of count. The next byte to be read from + * the input stream buffer will be buf[pos]. */ protected int pos; /** - * The currently marked position in the stream. ByteArrayInputStream objects - * are marked at position zero by default when constructed. They may be - * marked at another position within the buffer by the mark() - * method. The current buffer position is set to this point by the - * reset() method. + * The currently marked position in the stream. ByteArrayInputStream objects are marked at position zero by default when constructed. They may be marked at another position within the buffer by + * the mark() method. The current buffer position is set to this point by the reset() method. *

- * If no mark has been set, then the value of mark is the offset passed to - * the constructor (or 0 if the offset was not supplied). + * If no mark has been set, then the value of mark is the offset passed to the constructor (or 0 if the offset was not supplied). * * @since JDK1.1 */ protected int mark = 0; /** - * The index one greater than the last valid character in the input stream - * buffer. This value should always be nonnegative and not larger than the - * length of buf. It is one greater than the position of the - * last byte within buf that can ever be read from the input - * stream buffer. + * The index one greater than the last valid character in the input stream buffer. This value should always be nonnegative and not larger than the length of buf. It is one greater + * than the position of the last byte within buf that can ever be read from the input stream buffer. */ protected int count; /** - * Creates a ByteArrayInputStream so that it uses - * buf as its buffer array. The buffer array is not copied. The - * initial value of pos is 0 and the initial value - * of count is the length of buf. + * Creates a ByteArrayInputStream so that it uses buf as its buffer array. The buffer array is not copied. The initial value of pos is 0 and the + * initial value of count is the length of buf. * * @param buf the input buffer. */ @@ -78,12 +64,8 @@ public class ByteArrayInputStream extends InputStream { } /** - * Creates ByteArrayInputStream that uses buf as - * its buffer array. The initial value of pos is - * offset and the initial value of count is the - * minimum of offset+length and buf.length. The - * buffer array is not copied. The buffer's mark is set to the specified - * offset. + * Creates ByteArrayInputStream that uses buf as its buffer array. The initial value of pos is offset and the initial value of + * count is the minimum of offset+length and buf.length. The buffer array is not copied. The buffer's mark is set to the specified offset. * * @param buf the input buffer. * @param offset the offset in the buffer of the first byte to read. @@ -97,15 +79,12 @@ public class ByteArrayInputStream extends InputStream { } /** - * Reads the next byte of data from this input stream. The value byte is - * returned as an int in the range 0 to - * 255. If no byte is available because the end of the stream - * has been reached, the value -1 is returned. + * Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of + * the stream has been reached, the value -1 is returned. *

* This read method cannot block. * - * @return the next byte of data, or -1 if the end of the - * stream has been reached. + * @return the next byte of data, or -1 if the end of the stream has been reached. */ @Override public int read() { @@ -113,29 +92,19 @@ public class ByteArrayInputStream extends InputStream { } /** - * Reads up to len bytes of data into an array of bytes from - * this input stream. If pos equals count, then - * -1 is returned to indicate end of file. Otherwise, the - * number k of bytes read is equal to the smaller of - * len and count-pos. If k is - * positive, then bytes buf[pos] through - * buf[pos+k-1] are copied into b[off] through - * b[off+k-1] in the manner performed by - * System.arraycopy. The value k is added into - * pos and k is returned. + * Reads up to len bytes of data into an array of bytes from this input stream. If pos equals count, then -1 is returned to indicate end of + * file. Otherwise, the number k of bytes read is equal to the smaller of len and count-pos. If k is positive, then bytes buf[pos] + * through buf[pos+k-1] are copied into b[off] through b[off+k-1] in the manner performed by System.arraycopy. The value k is added + * into pos and k is returned. *

* This read method cannot block. * * @param b the buffer into which the data is read. * @param off the start offset in the destination array b * @param len the maximum number of bytes read. - * @return the total number of bytes read into the buffer, or - * -1 if there is no more data because the end of the stream - * has been reached. + * @return the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached. * @exception NullPointerException If b is null. - * @exception IndexOutOfBoundsException If off is negative, - * len is negative, or len is greater than - * b.length - off + * @exception IndexOutOfBoundsException If off is negative, len is negative, or len is greater than b.length - off */ @Override public int read(byte b[], int off, int len) { @@ -162,11 +131,8 @@ public class ByteArrayInputStream extends InputStream { } /** - * Skips n bytes of input from this input stream. Fewer bytes - * might be skipped if the end of the input stream is reached. The actual - * number k of bytes to be skipped is equal to the smaller of - * n and count-pos. The value k is - * added into pos and k is returned. + * Skips n bytes of input from this input stream. Fewer bytes might be skipped if the end of the input stream is reached. The actual number k of bytes to be skipped is + * equal to the smaller of n and count-pos. The value k is added into pos and k is returned. * * @param n the number of bytes to be skipped. * @return the actual number of bytes skipped. @@ -183,14 +149,11 @@ public class ByteArrayInputStream extends InputStream { } /** - * Returns the number of remaining bytes that can be read (or skipped over) - * from this input stream. + * Returns the number of remaining bytes that can be read (or skipped over) from this input stream. *

- * The value returned is count - pos, which is the number - * of bytes remaining to be read from the input buffer. + * The value returned is count - pos, which is the number of bytes remaining to be read from the input buffer. * - * @return the number of remaining bytes that can be read (or skipped over) - * from this input stream without blocking. + * @return the number of remaining bytes that can be read (or skipped over) from this input stream without blocking. */ @Override public int available() { @@ -198,9 +161,7 @@ public class ByteArrayInputStream extends InputStream { } /** - * Tests if this InputStream supports mark/reset. The - * markSupported method of ByteArrayInputStream - * always returns true. + * Tests if this InputStream supports mark/reset. The markSupported method of ByteArrayInputStream always returns true. * * @since JDK1.1 */ @@ -210,12 +171,10 @@ public class ByteArrayInputStream extends InputStream { } /** - * Set the current marked position in the stream. ByteArrayInputStream - * objects are marked at position zero by default when constructed. They may - * be marked at another position within the buffer by this method. + * Set the current marked position in the stream. ByteArrayInputStream objects are marked at position zero by default when constructed. They may be marked at another position within the buffer by + * this method. *

- * If no mark has been set, then the value of the mark is the offset passed - * to the constructor (or 0 if the offset was not supplied). + * If no mark has been set, then the value of the mark is the offset passed to the constructor (or 0 if the offset was not supplied). * *

* Note: The readAheadLimit for this class has no meaning. @@ -228,9 +187,7 @@ public class ByteArrayInputStream extends InputStream { } /** - * Resets the buffer to the marked position. The marked position is 0 unless - * another position was marked or an offset was specified in the - * constructor. + * Resets the buffer to the marked position. The marked position is 0 unless another position was marked or an offset was specified in the constructor. */ @Override public void reset() { @@ -238,9 +195,7 @@ public class ByteArrayInputStream extends InputStream { } /** - * Closing a ByteArrayInputStream has no effect. The methods in - * this class can be called after the stream has been closed without - * generating an IOException. + * Closing a ByteArrayInputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException. *

*/ @Override diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayOutputStream.java index bbc5cee49c..aade1999b2 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteArrayOutputStream.java @@ -22,14 +22,11 @@ import java.io.UnsupportedEncodingException; import java.util.Arrays; /** - * This class provides a more efficient implementation of the - * java.io.ByteArrayOutputStream. The efficiency is gained in two ways: + * This class provides a more efficient implementation of the java.io.ByteArrayOutputStream. The efficiency is gained in two ways: *

* */ @@ -46,16 +43,14 @@ public class ByteArrayOutputStream extends OutputStream { protected int count; /** - * Creates a new byte array output stream. The buffer capacity is initially - * 32 bytes, though its size increases if necessary. + * Creates a new byte array output stream. The buffer capacity is initially 32 bytes, though its size increases if necessary. */ public ByteArrayOutputStream() { this(32); } /** - * Creates a new byte array output stream, with a buffer capacity of the - * specified size, in bytes. + * Creates a new byte array output stream, with a buffer capacity of the specified size, in bytes. * * @param size the initial size. * @exception IllegalArgumentException if size is negative. @@ -69,13 +64,10 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Increases the capacity if necessary to ensure that it can hold at least - * the number of elements specified by the minimum capacity argument. + * Increases the capacity if necessary to ensure that it can hold at least the number of elements specified by the minimum capacity argument. * * @param minCapacity the desired minimum capacity - * @throws OutOfMemoryError if {@code minCapacity < 0}. This is interpreted - * as a request for the unsatisfiably large capacity - * {@code (long) Integer.MAX_VALUE + (minCapacity - Integer.MAX_VALUE)}. + * @throws OutOfMemoryError if {@code minCapacity < 0}. This is interpreted as a request for the unsatisfiably large capacity {@code (long) Integer.MAX_VALUE + (minCapacity - Integer.MAX_VALUE)}. */ private void ensureCapacity(int minCapacity) { // overflow-conscious code @@ -85,8 +77,7 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Increases the capacity to ensure that it can hold at least the number of - * elements specified by the minimum capacity argument. + * Increases the capacity to ensure that it can hold at least the number of elements specified by the minimum capacity argument. * * @param minCapacity the desired minimum capacity */ @@ -119,8 +110,7 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Writes len bytes from the specified byte array starting at - * offset off to this byte array output stream. + * Writes len bytes from the specified byte array starting at offset off to this byte array output stream. * * @param b the data. * @param off the start offset in the data. @@ -138,9 +128,8 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Writes the complete contents of this byte array output stream to the - * specified output stream argument, as if by calling the output stream's - * write method using out.write(buf, 0, count). + * Writes the complete contents of this byte array output stream to the specified output stream argument, as if by calling the output stream's write method using + * out.write(buf, 0, count). * * @param out the output stream to which to write the data. * @exception IOException if an I/O error occurs. @@ -150,10 +139,8 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Resets the count field of this byte array output stream to - * zero, so that all currently accumulated output in the output stream is - * discarded. The output stream can be used again, reusing the already - * allocated buffer space. + * Resets the count field of this byte array output stream to zero, so that all currently accumulated output in the output stream is discarded. The output stream can be used again, + * reusing the already allocated buffer space. * * @see java.io.ByteArrayInputStream#count */ @@ -162,9 +149,7 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Creates a newly allocated byte array. Its size is the current size of - * this output stream and the valid contents of the buffer have been copied - * into it. + * Creates a newly allocated byte array. Its size is the current size of this output stream and the valid contents of the buffer have been copied into it. * * @return the current contents of this output stream, as a byte array. * @see java.io.ByteArrayOutputStream#size() @@ -176,8 +161,7 @@ public class ByteArrayOutputStream extends OutputStream { /** * Returns the current size of the buffer. * - * @return the value of the count field, which is the number of - * valid bytes in this output stream. + * @return the value of the count field, which is the number of valid bytes in this output stream. * @see java.io.ByteArrayOutputStream#count */ public int size() { @@ -185,16 +169,12 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Converts the buffer's contents into a string decoding bytes using the - * platform's default character set. The length of the new String - * is a function of the character set, and hence may not be equal to the - * size of the buffer. + * Converts the buffer's contents into a string decoding bytes using the platform's default character set. The length of the new String + * is a function of the character set, and hence may not be equal to the size of the buffer. * *

- * This method always replaces malformed-input and unmappable-character - * sequences with the default replacement string for the platform's default - * character set. The {@linkplain java.nio.charset.CharsetDecoder} class - * should be used when more control over the decoding process is required. + * This method always replaces malformed-input and unmappable-character sequences with the default replacement string for the platform's default character set. The + * {@linkplain java.nio.charset.CharsetDecoder} class should be used when more control over the decoding process is required. * * @return String decoded from the buffer's contents. * @since JDK1.1 @@ -205,22 +185,16 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Converts the buffer's contents into a string by decoding the bytes using - * the specified {@link java.nio.charset.Charset charsetName}. The length of - * the new String is a function of the charset, and hence may not - * be equal to the length of the byte array. + * Converts the buffer's contents into a string by decoding the bytes using the specified {@link java.nio.charset.Charset charsetName}. The length of the new String is a function of the + * charset, and hence may not be equal to the length of the byte array. * *

- * This method always replaces malformed-input and unmappable-character - * sequences with this charset's default replacement string. The {@link - * java.nio.charset.CharsetDecoder} class should be used when more control - * over the decoding process is required. + * This method always replaces malformed-input and unmappable-character sequences with this charset's default replacement string. The {@link + * java.nio.charset.CharsetDecoder} class should be used when more control over the decoding process is required. * - * @param charsetName the name of a supported - * {@linkplain java.nio.charset.Charset charset} + * @param charsetName the name of a supported {@linkplain java.nio.charset.Charset charset} * @return String decoded from the buffer's contents. - * @exception UnsupportedEncodingException If the named charset is not - * supported + * @exception UnsupportedEncodingException If the named charset is not supported * @since JDK1.1 */ public String toString(String charsetName) throws UnsupportedEncodingException { @@ -228,9 +202,7 @@ public class ByteArrayOutputStream extends OutputStream { } /** - * Closing a ByteArrayOutputStream has no effect. The methods in - * this class can be called after the stream has been closed without - * generating an IOException. + * Closing a ByteArrayOutputStream has no effect. The methods in this class can be called after the stream has been closed without generating an IOException. *

* */ diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteCountingOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteCountingOutputStream.java index e71937ecc4..9bbd45ed2a 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteCountingOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ByteCountingOutputStream.java @@ -27,13 +27,12 @@ public class ByteCountingOutputStream extends OutputStream { public ByteCountingOutputStream(final OutputStream out) { this.out = out; } - + public ByteCountingOutputStream(final OutputStream out, final long initialByteCount) { this.out = out; this.bytesWritten = initialByteCount; } - @Override public void write(int b) throws IOException { out.write(b); @@ -45,8 +44,6 @@ public class ByteCountingOutputStream extends OutputStream { write(b, 0, b.length); } - ; - @Override public void write(byte[] b, int off, int len) throws IOException { out.write(b, off, len); diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/DataOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/DataOutputStream.java index 1dd90f5ed3..e2059965a3 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/DataOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/DataOutputStream.java @@ -23,14 +23,12 @@ import java.io.OutputStream; import java.io.UTFDataFormatException; /** - * This class is different from java.io.DataOutputStream in that it does - * synchronize on its methods. + * This class is different from java.io.DataOutputStream in that it does synchronize on its methods. */ public class DataOutputStream extends FilterOutputStream implements DataOutput { /** - * The number of bytes written to the data output stream so far. If this - * counter overflows, it will be wrapped to Integer.MAX_VALUE. + * The number of bytes written to the data output stream so far. If this counter overflows, it will be wrapped to Integer.MAX_VALUE. */ protected int written; @@ -40,9 +38,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { private byte[] bytearr = null; /** - * Creates a new data output stream to write data to the specified - * underlying output stream. The counter written is set to - * zero. + * Creates a new data output stream to write data to the specified underlying output stream. The counter written is set to zero. * * @param out the underlying output stream, to be saved for later use. * @see java.io.FilterOutputStream#out @@ -52,8 +48,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Increases the written counter by the specified value until it reaches - * Integer.MAX_VALUE. + * Increases the written counter by the specified value until it reaches Integer.MAX_VALUE. */ private void incCount(int value) { int temp = written + value; @@ -64,9 +59,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes the specified byte (the low eight bits of the argument - * b) to the underlying output stream. If no exception is - * thrown, the counter written is incremented by + * Writes the specified byte (the low eight bits of the argument b) to the underlying output stream. If no exception is thrown, the counter written is incremented by * 1. *

* Implements the write method of OutputStream. @@ -82,10 +75,8 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes len bytes from the specified byte array starting at - * offset off to the underlying output stream. If no exception - * is thrown, the counter written is incremented by - * len. + * Writes len bytes from the specified byte array starting at offset off to the underlying output stream. If no exception is thrown, the counter written is + * incremented by len. * * @param b the data. * @param off the start offset in the data. @@ -100,11 +91,9 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Flushes this data output stream. This forces any buffered output bytes to - * be written out to the stream. + * Flushes this data output stream. This forces any buffered output bytes to be written out to the stream. *

- * The flush method of DataOutputStream calls the - * flush method of its underlying output stream. + * The flush method of DataOutputStream calls the flush method of its underlying output stream. * * @exception IOException if an I/O error occurs. * @see java.io.FilterOutputStream#out @@ -116,11 +105,8 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes a boolean to the underlying output stream as a 1-byte - * value. The value true is written out as the value - * (byte)1; the value false is written out as the - * value (byte)0. If no exception is thrown, the counter - * written is incremented by 1. + * Writes a boolean to the underlying output stream as a 1-byte value. The value true is written out as the value (byte)1; the value false is + * written out as the value (byte)0. If no exception is thrown, the counter written is incremented by 1. * * @param v a boolean value to be written. * @exception IOException if an I/O error occurs. @@ -133,9 +119,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes out a byte to the underlying output stream as a - * 1-byte value. If no exception is thrown, the counter written - * is incremented by 1. + * Writes out a byte to the underlying output stream as a 1-byte value. If no exception is thrown, the counter written is incremented by 1. * * @param v a byte value to be written. * @exception IOException if an I/O error occurs. @@ -148,9 +132,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes a short to the underlying output stream as two bytes, - * high byte first. If no exception is thrown, the counter - * written is incremented by 2. + * Writes a short to the underlying output stream as two bytes, high byte first. If no exception is thrown, the counter written is incremented by 2. * * @param v a short to be written. * @exception IOException if an I/O error occurs. @@ -164,9 +146,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes a char to the underlying output stream as a 2-byte - * value, high byte first. If no exception is thrown, the counter - * written is incremented by 2. + * Writes a char to the underlying output stream as a 2-byte value, high byte first. If no exception is thrown, the counter written is incremented by 2. * * @param v a char value to be written. * @exception IOException if an I/O error occurs. @@ -180,9 +160,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes an int to the underlying output stream as four bytes, - * high byte first. If no exception is thrown, the counter - * written is incremented by 4. + * Writes an int to the underlying output stream as four bytes, high byte first. If no exception is thrown, the counter written is incremented by 4. * * @param v an int to be written. * @exception IOException if an I/O error occurs. @@ -200,9 +178,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { private final byte writeBuffer[] = new byte[8]; /** - * Writes a long to the underlying output stream as eight - * bytes, high byte first. In no exception is thrown, the counter - * written is incremented by 8. + * Writes a long to the underlying output stream as eight bytes, high byte first. In no exception is thrown, the counter written is incremented by 8. * * @param v a long to be written. * @exception IOException if an I/O error occurs. @@ -223,11 +199,8 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Converts the float argument to an int using the - * floatToIntBits method in class Float, and then - * writes that int value to the underlying output stream as a - * 4-byte quantity, high byte first. If no exception is thrown, the counter - * written is incremented by 4. + * Converts the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the underlying output + * stream as a 4-byte quantity, high byte first. If no exception is thrown, the counter written is incremented by 4. * * @param v a float value to be written. * @exception IOException if an I/O error occurs. @@ -240,11 +213,8 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Converts the double argument to a long using the - * doubleToLongBits method in class Double, and - * then writes that long value to the underlying output stream - * as an 8-byte quantity, high byte first. If no exception is thrown, the - * counter written is incremented by 8. + * Converts the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the underlying + * output stream as an 8-byte quantity, high byte first. If no exception is thrown, the counter written is incremented by 8. * * @param v a double value to be written. * @exception IOException if an I/O error occurs. @@ -257,10 +227,8 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes out the string to the underlying output stream as a sequence of - * bytes. Each character in the string is written out, in sequence, by - * discarding its high eight bits. If no exception is thrown, the counter - * written is incremented by the length of s. + * Writes out the string to the underlying output stream as a sequence of bytes. Each character in the string is written out, in sequence, by discarding its high eight bits. If no exception is + * thrown, the counter written is incremented by the length of s. * * @param s a string of bytes to be written. * @exception IOException if an I/O error occurs. @@ -276,11 +244,8 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Writes a string to the underlying output stream as a sequence of - * characters. Each character is written to the data output stream as if by - * the writeChar method. If no exception is thrown, the counter - * written is incremented by twice the length of - * s. + * Writes a string to the underlying output stream as a sequence of characters. Each character is written to the data output stream as if by the writeChar method. If no exception is + * thrown, the counter written is incremented by twice the length of s. * * @param s a String value to be written. * @exception IOException if an I/O error occurs. @@ -303,15 +268,10 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { * modified UTF-8 * encoding in a machine-independent manner. *

- * First, two bytes are written to the output stream as if by the - * writeShort method giving the number of bytes to follow. This - * value is the number of bytes actually written out, not the length of the - * string. Following the length, each character of the string is output, in - * sequence, using the modified UTF-8 encoding for the character. If no - * exception is thrown, the counter written is incremented by - * the total number of bytes written to the output stream. This will be at - * least two plus the length of str, and at most two plus - * thrice the length of str. + * First, two bytes are written to the output stream as if by the writeShort method giving the number of bytes to follow. This value is the number of bytes actually written out, not + * the length of the string. Following the length, each character of the string is output, in sequence, using the modified UTF-8 encoding for the character. If no exception is thrown, the counter + * written is incremented by the total number of bytes written to the output stream. This will be at least two plus the length of str, and at most two plus thrice the + * length of str. * * @param str a string to be written. * @exception IOException if an I/O error occurs. @@ -326,15 +286,10 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { * modified UTF-8 * encoding in a machine-independent manner. *

- * First, two bytes are written to out as if by the writeShort - * method giving the number of bytes to follow. This value is the number of - * bytes actually written out, not the length of the string. Following the - * length, each character of the string is output, in sequence, using the - * modified UTF-8 encoding for the character. If no exception is thrown, the - * counter written is incremented by the total number of bytes - * written to the output stream. This will be at least two plus the length - * of str, and at most two plus thrice the length of - * str. + * First, two bytes are written to out as if by the writeShort method giving the number of bytes to follow. This value is the number of bytes actually written out, not the length of + * the string. Following the length, each character of the string is output, in sequence, using the modified UTF-8 encoding for the character. If no exception is thrown, the counter + * written is incremented by the total number of bytes written to the output stream. This will be at least two plus the length of str, and at most two plus thrice the + * length of str. * * @param str a string to be written. * @param out destination to write to @@ -404,9 +359,7 @@ public class DataOutputStream extends FilterOutputStream implements DataOutput { } /** - * Returns the current value of the counter written, the number - * of bytes written to this data output stream so far. If the counter - * overflows, it will be wrapped to Integer.MAX_VALUE. + * Returns the current value of the counter written, the number of bytes written to this data output stream so far. If the counter overflows, it will be wrapped to Integer.MAX_VALUE. * * @return the value of the written field. * @see java.io.DataOutputStream#written diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/GZIPOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/GZIPOutputStream.java index 2864bbb176..1e2f3c7c76 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/GZIPOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/GZIPOutputStream.java @@ -21,9 +21,7 @@ import java.io.OutputStream; /** *

- * This class extends the {@link java.util.zip.GZIPOutputStream} by allowing the - * constructor to provide a compression level, and uses a default value of 1, - * rather than 5. + * This class extends the {@link java.util.zip.GZIPOutputStream} by allowing the constructor to provide a compression level, and uses a default value of 1, rather than 5. *

*/ public class GZIPOutputStream extends java.util.zip.GZIPOutputStream { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/LeakyBucketStreamThrottler.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/LeakyBucketStreamThrottler.java index ac6322d202..5153db5aff 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/LeakyBucketStreamThrottler.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/LeakyBucketStreamThrottler.java @@ -190,8 +190,7 @@ public class LeakyBucketStreamThrottler implements StreamThrottler { } /** - * This class is responsible for draining water from the leaky bucket. I.e., - * it actually moves the data + * This class is responsible for draining water from the leaky bucket. I.e., it actually moves the data */ private class Drain implements Runnable { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/MinimumLengthInputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/MinimumLengthInputStream.java index 7d6d8d1db3..44e9c2e075 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/MinimumLengthInputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/MinimumLengthInputStream.java @@ -22,8 +22,7 @@ import java.io.IOException; import java.io.InputStream; /** - * An InputStream that will throw EOFException if the underlying InputStream - * runs out of data before reaching the configured minimum amount of data + * An InputStream that will throw EOFException if the underlying InputStream runs out of data before reaching the configured minimum amount of data */ public class MinimumLengthInputStream extends FilterInputStream { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/NonCloseableInputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/NonCloseableInputStream.java index 0e75a22495..27a0c474f4 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/NonCloseableInputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/NonCloseableInputStream.java @@ -21,9 +21,8 @@ import java.io.IOException; import java.io.InputStream; /** - * Wraps and InputStream so that the underlying InputStream cannot be closed. - * This is used so that the InputStream can be wrapped with yet another - * InputStream and prevent the outer layer from closing the inner InputStream + * Wraps and InputStream so that the underlying InputStream cannot be closed. This is used so that the InputStream can be wrapped with yet another InputStream and prevent the outer layer from closing + * the inner InputStream */ public class NonCloseableInputStream extends FilterInputStream { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/StreamUtils.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/StreamUtils.java index 101a546287..64f6eaab57 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/StreamUtils.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/StreamUtils.java @@ -40,9 +40,7 @@ public class StreamUtils { } /** - * Copies numBytes from source to - * destination. If numBytes are not available from - * source, throws EOFException + * Copies numBytes from source to destination. If numBytes are not available from source, throws EOFException * * @param source the source of bytes to copy * @param destination the destination to copy bytes to @@ -64,9 +62,7 @@ public class StreamUtils { } /** - * Reads data from the given input stream, copying it to the destination - * byte array. If the InputStream has less data than the given byte array, - * throws an EOFException + * Reads data from the given input stream, copying it to the destination byte array. If the InputStream has less data than the given byte array, throws an EOFException * * @param source the source to copy bytes from * @param destination the destination to fill @@ -77,15 +73,12 @@ public class StreamUtils { } /** - * Reads data from the given input stream, copying it to the destination - * byte array. If the InputStream has less data than the given byte array, - * throws an EOFException if ensureCapacity is true and - * otherwise returns the number of bytes copied + * Reads data from the given input stream, copying it to the destination byte array. If the InputStream has less data than the given byte array, throws an EOFException if + * ensureCapacity is true and otherwise returns the number of bytes copied * * @param source the source to read bytes from * @param destination the destination to fill - * @param ensureCapacity whether or not to enforce that the InputStream have - * at least as much data as the capacity of the destination byte array + * @param ensureCapacity whether or not to enforce that the InputStream have at least as much data as the capacity of the destination byte array * @return the number of bytes actually filled * @throws IOException if unable to read from the underlying stream */ @@ -109,10 +102,8 @@ public class StreamUtils { } /** - * Copies data from in to out until either we are out of data (returns null) - * or we hit one of the byte patterns identified by the - * stoppers parameter (returns the byte pattern matched). The - * bytes in the stopper will be copied. + * Copies data from in to out until either we are out of data (returns null) or we hit one of the byte patterns identified by the stoppers parameter (returns the byte pattern + * matched). The bytes in the stopper will be copied. * * @param in the source to read bytes from * @param out the destination to write bytes to @@ -151,11 +142,8 @@ public class StreamUtils { } /** - * Copies data from in to out until either we are out of data (returns null) - * or we hit one of the byte patterns identified by the - * stoppers parameter (returns the byte pattern matched). The - * byte pattern matched will NOT be copied to the output and will be un-read - * from the input. + * Copies data from in to out until either we are out of data (returns null) or we hit one of the byte patterns identified by the stoppers parameter (returns the byte pattern + * matched). The byte pattern matched will NOT be copied to the output and will be un-read from the input. * * @param in the source to read bytes from * @param out the destination to write bytes to diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ZipOutputStream.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ZipOutputStream.java index 2b9050d888..d30af76bcd 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ZipOutputStream.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/stream/io/ZipOutputStream.java @@ -19,9 +19,8 @@ package org.apache.nifi.stream.io; import java.io.OutputStream; /** - * This class extends the {@link java.util.zip.ZipOutputStream} by providing a - * constructor that allows the user to specify the compression level. The - * default compression level is 1, as opposed to Java's default of 5. + * This class extends the {@link java.util.zip.ZipOutputStream} by providing a constructor that allows the user to specify the compression level. The default compression level is 1, as opposed to + * Java's default of 5. */ public class ZipOutputStream extends java.util.zip.ZipOutputStream { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/EscapeUtils.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/EscapeUtils.java index b7a663c196..46739e3764 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/EscapeUtils.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/EscapeUtils.java @@ -19,9 +19,7 @@ package org.apache.nifi.util; public class EscapeUtils { /** - * Escapes the specified html by replacing &, <, >, ", ', - * / with their corresponding html entity. If html is null, null is - * returned. + * Escapes the specified html by replacing &, <, >, ", ', / with their corresponding html entity. If html is null, null is returned. * * @param html to escape * @return escaped html diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/LongHolder.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/LongHolder.java index ef70ce805a..fa2d06333d 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/LongHolder.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/LongHolder.java @@ -17,10 +17,8 @@ package org.apache.nifi.util; /** - * Wraps a Long value so that it can be declared final and still be - * accessed from which inner classes; the functionality is similar to that of an - * AtomicLong, but operations on this class are not atomic. This results in - * greater performance when the atomicity is not needed. + * Wraps a Long value so that it can be declared final and still be accessed from which inner classes; the functionality is similar to that of an AtomicLong, but operations on this class + * are not atomic. This results in greater performance when the atomicity is not needed. */ public class LongHolder extends ObjectHolder { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java index b7831de789..0c6c575273 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/NaiveSearchRingBuffer.java @@ -24,9 +24,8 @@ import java.util.Arrays; *

* *

- * This class implements an efficient naive search algorithm, which allows the - * user of the library to identify byte sequences in a stream on-the-fly so that - * the stream can be segmented without having to buffer the data. + * This class implements an efficient naive search algorithm, which allows the user of the library to identify byte sequences in a stream on-the-fly so that the stream can be segmented without having + * to buffer the data. *

* *

@@ -60,10 +59,8 @@ public class NaiveSearchRingBuffer { } /** - * @return the contents of the internal buffer, which represents the last X - * bytes added to the buffer, where X is the minimum of the number of bytes - * added to the buffer or the length of the byte sequence for which we are - * looking + * @return the contents of the internal buffer, which represents the last X bytes added to the buffer, where X is the minimum of the number of bytes added to the buffer or the length of the byte + * sequence for which we are looking */ public byte[] getBufferContents() { final int contentLength = Math.min(lookingFor.length, bufferSize); @@ -83,9 +80,7 @@ public class NaiveSearchRingBuffer { } /** - * @return true if the number of bytes that have been added to - * the buffer is at least equal to the length of the byte sequence for which - * we are searching + * @return true if the number of bytes that have been added to the buffer is at least equal to the length of the byte sequence for which we are searching */ public boolean isFilled() { return bufferSize >= buffer.length; @@ -101,12 +96,10 @@ public class NaiveSearchRingBuffer { } /** - * Add the given byte to the buffer and notify whether or not the byte - * completes the desired byte sequence. + * Add the given byte to the buffer and notify whether or not the byte completes the desired byte sequence. * * @param data the data to add to the buffer - * @return true if this byte completes the byte sequence, - * false otherwise. + * @return true if this byte completes the byte sequence, false otherwise. */ public boolean addAndCompare(final byte data) { buffer[insertionPointer] = data; diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java index b46bae58af..8cadc01775 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/RingBuffer.java @@ -42,8 +42,7 @@ public class RingBuffer { } /** - * Adds the given value to the RingBuffer and returns the value that was - * removed in order to make room. + * Adds the given value to the RingBuffer and returns the value that was removed in order to make room. * * @param value the new value to add * @return value previously in the buffer @@ -202,11 +201,8 @@ public class RingBuffer { } /** - * Iterates over each element in the RingBuffer, calling the - * {@link ForEachEvaluator#evaluate(Object) evaluate} method on each element - * in the RingBuffer. If the Evaluator returns {@code false}, the method - * will skip all remaining elements in the RingBuffer; otherwise, the next - * element will be evaluated until all elements have been evaluated. + * Iterates over each element in the RingBuffer, calling the {@link ForEachEvaluator#evaluate(Object) evaluate} method on each element in the RingBuffer. If the Evaluator returns {@code false}, + * the method will skip all remaining elements in the RingBuffer; otherwise, the next element will be evaluated until all elements have been evaluated. * * @param evaluator used to evaluate each item in the ring buffer */ @@ -215,15 +211,11 @@ public class RingBuffer { } /** - * Iterates over each element in the RingBuffer, calling the - * {@link ForEachEvaluator#evaluate(Object) evaluate} method on each element - * in the RingBuffer. If the Evaluator returns {@code false}, the method - * will skip all remaining elements in the RingBuffer; otherwise, the next - * element will be evaluated until all elements have been evaluated. + * Iterates over each element in the RingBuffer, calling the {@link ForEachEvaluator#evaluate(Object) evaluate} method on each element in the RingBuffer. If the Evaluator returns {@code false}, + * the method will skip all remaining elements in the RingBuffer; otherwise, the next element will be evaluated until all elements have been evaluated. * * @param evaluator the evaluator - * @param iterationDirection the order in which to iterate over the elements - * in the RingBuffer + * @param iterationDirection the order in which to iterate over the elements in the RingBuffer */ public void forEach(final ForEachEvaluator evaluator, final IterationDirection iterationDirection) { readLock.lock(); @@ -266,16 +258,14 @@ public class RingBuffer { } /** - * Defines an interface that can be used to iterate over all of the elements - * in the RingBuffer via the {@link #forEach} method + * Defines an interface that can be used to iterate over all of the elements in the RingBuffer via the {@link #forEach} method * * @param the type to evaluate */ public static interface ForEachEvaluator { /** - * Evaluates the given element and returns {@code true} if the next - * element should be evaluated, {@code false} otherwise + * Evaluates the given element and returns {@code true} if the next element should be evaluated, {@code false} otherwise * * @param value the value to evaluate * @return true if should continue evaluating; false otherwise diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java index bc8ab75466..cffe49ced7 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/StopWatch.java @@ -58,8 +58,7 @@ public final class StopWatch { * @param timeUnit the unit for which the duration should be reported * @return the duration of the stopwatch in the specified unit * - * @throws IllegalStateException if the StopWatch has not been stopped via - * {@link #stop()} + * @throws IllegalStateException if the StopWatch has not been stopped via {@link #stop()} */ public long getDuration(final TimeUnit timeUnit) { if (duration < 0) { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java index 73c8aa05e1..daefd04417 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/FileUtils.java @@ -39,8 +39,7 @@ import java.util.Random; import org.slf4j.Logger; /** - * A utility class containing a few useful static methods to do typical IO - * operations. + * A utility class containing a few useful static methods to do typical IO operations. * * @author unattributed */ @@ -94,12 +93,10 @@ public class FileUtils { } /** - * Deletes the given file. If the given file exists but could not be deleted - * this will be printed as a warning to the given logger + * Deletes the given file. If the given file exists but could not be deleted this will be printed as a warning to the given logger * * @param file the file to delete - * @param logger the logger to provide logging information to about the - * operation + * @param logger the logger to provide logging information to about the operation * @return true if given file no longer exists */ public static boolean deleteFile(final File file, final Logger logger) { @@ -107,13 +104,11 @@ public class FileUtils { } /** - * Deletes the given file. If the given file exists but could not be deleted - * this will be printed as a warning to the given logger + * Deletes the given file. If the given file exists but could not be deleted this will be printed as a warning to the given logger * * @param file the file to delete * @param logger the logger to write to - * @param attempts indicates how many times an attempt to delete should be - * made + * @param attempts indicates how many times an attempt to delete should be made * @return true if given file no longer exists */ public static boolean deleteFile(final File file, final Logger logger, final int attempts) { @@ -143,8 +138,7 @@ public class FileUtils { } /** - * Deletes all of the given files. If any exist and cannot be deleted that - * will be printed at warn to the given logger. + * Deletes all of the given files. If any exist and cannot be deleted that will be printed at warn to the given logger. * * @param files can be null * @param logger can be null @@ -154,13 +148,11 @@ public class FileUtils { } /** - * Deletes all of the given files. If any exist and cannot be deleted that - * will be printed at warn to the given logger. + * Deletes all of the given files. If any exist and cannot be deleted that will be printed at warn to the given logger. * * @param files can be null * @param logger can be null - * @param attempts indicates how many times an attempt should be made to - * delete each file + * @param attempts indicates how many times an attempt should be made to delete each file */ public static void deleteFile(final List files, final Logger logger, final int attempts) { if (null == files || files.isEmpty()) { @@ -188,9 +180,8 @@ public class FileUtils { } /** - * Deletes all files (not directories..) in the given directory (non - * recursive) that match the given filename filter. If any file cannot be - * deleted then this is printed at warn to the given logger. + * Deletes all files (not directories..) in the given directory (non recursive) that match the given filename filter. If any file cannot be deleted then this is printed at warn to the given + * logger. * * @param directory the directory to scan for files to delete * @param filter if null then no filter is used @@ -201,9 +192,7 @@ public class FileUtils { } /** - * Deletes all files (not directories) in the given directory (recursive) - * that match the given filename filter. If any file cannot be deleted then - * this is printed at warn to the given logger. + * Deletes all files (not directories) in the given directory (recursive) that match the given filename filter. If any file cannot be deleted then this is printed at warn to the given logger. * * @param directory the directory to scan * @param filter if null then no filter is used @@ -215,16 +204,13 @@ public class FileUtils { } /** - * Deletes all files (not directories) in the given directory (recursive) - * that match the given filename filter. If any file cannot be deleted then - * this is printed at warn to the given logger. + * Deletes all files (not directories) in the given directory (recursive) that match the given filename filter. If any file cannot be deleted then this is printed at warn to the given logger. * * @param directory the directory to scan * @param filter if null then no filter is used * @param logger the logger * @param recurse whether to recurse subdirectories or not - * @param deleteEmptyDirectories default is false; if true will delete - * directories found that are empty + * @param deleteEmptyDirectories default is false; if true will delete directories found that are empty */ public static void deleteFilesInDir(final File directory, final FilenameFilter filter, final Logger logger, final boolean recurse, final boolean deleteEmptyDirectories) { // ensure the specified directory is actually a directory and that it exists @@ -269,11 +255,9 @@ public class FileUtils { } /** - * Randomly generates a sequence of bytes and overwrites the contents of the - * file a number of times. The file is then deleted. + * Randomly generates a sequence of bytes and overwrites the contents of the file a number of times. The file is then deleted. * - * @param file File to be overwritten a number of times and, ultimately, - * deleted + * @param file File to be overwritten a number of times and, ultimately, deleted * @param passes Number of times file should be overwritten * @throws IOException if something makes shredding or deleting a problem */ @@ -349,29 +333,19 @@ public class FileUtils { } /** - * Copies the given source file to the given destination file. The given - * destination will be overwritten if it already exists. + * Copies the given source file to the given destination file. The given destination will be overwritten if it already exists. * * @param source the file to copy * @param destination the file to copy to - * @param lockInputFile if true will lock input file during copy; if false - * will not - * @param lockOutputFile if true will lock output file during copy; if false - * will not - * @param move if true will perform what is effectively a move operation - * rather than a pure copy. This allows for potentially highly efficient - * movement of the file but if not possible this will revert to a copy then - * delete behavior. If false, then the file is copied and the source file is - * retained. If a true rename/move occurs then no lock is held during that - * time. - * @param logger if failures occur, they will be logged to this logger if - * possible. If this logger is null, an IOException will instead be thrown, - * indicating the problem. + * @param lockInputFile if true will lock input file during copy; if false will not + * @param lockOutputFile if true will lock output file during copy; if false will not + * @param move if true will perform what is effectively a move operation rather than a pure copy. This allows for potentially highly efficient movement of the file but if not possible this will + * revert to a copy then delete behavior. If false, then the file is copied and the source file is retained. If a true rename/move occurs then no lock is held during that time. + * @param logger if failures occur, they will be logged to this logger if possible. If this logger is null, an IOException will instead be thrown, indicating the problem. * @return long number of bytes copied * @throws FileNotFoundException if the source file could not be found * @throws IOException if unable to read or write the underlying streams - * @throws SecurityException if a security manager denies the needed file - * operations + * @throws SecurityException if a security manager denies the needed file operations */ public static long copyFile(final File source, final File destination, final boolean lockInputFile, final boolean lockOutputFile, final boolean move, final Logger logger) throws FileNotFoundException, IOException { @@ -434,21 +408,17 @@ public class FileUtils { } /** - * Copies the given source file to the given destination file. The given - * destination will be overwritten if it already exists. + * Copies the given source file to the given destination file. The given destination will be overwritten if it already exists. * * @param source the file to copy from * @param destination the file to copy to - * @param lockInputFile if true will lock input file during copy; if false - * will not - * @param lockOutputFile if true will lock output file during copy; if false - * will not + * @param lockInputFile if true will lock input file during copy; if false will not + * @param lockOutputFile if true will lock output file during copy; if false will not * @param logger the logger to use * @return long number of bytes copied * @throws FileNotFoundException if the source file could not be found * @throws IOException if unable to read or write to file - * @throws SecurityException if a security manager denies the needed file - * operations + * @throws SecurityException if a security manager denies the needed file operations */ public static long copyFile(final File source, final File destination, final boolean lockInputFile, final boolean lockOutputFile, final Logger logger) throws FileNotFoundException, IOException { return FileUtils.copyFile(source, destination, lockInputFile, lockOutputFile, false, logger); @@ -497,10 +467,8 @@ public class FileUtils { } /** - * Renames the given file from the source path to the destination path. This - * handles multiple attempts. This should only be used to rename within a - * given directory. Renaming across directories might not work well. See the - * File.renameTo for more information. + * Renames the given file from the source path to the destination path. This handles multiple attempts. This should only be used to rename within a given directory. Renaming across directories + * might not work well. See the File.renameTo for more information. * * @param source the file to rename * @param destination the file path to rename to @@ -512,19 +480,14 @@ public class FileUtils { } /** - * Renames the given file from the source path to the destination path. This - * handles multiple attempts. This should only be used to rename within a - * given directory. Renaming across directories might not work well. See the - * File.renameTo for more information. + * Renames the given file from the source path to the destination path. This handles multiple attempts. This should only be used to rename within a given directory. Renaming across directories + * might not work well. See the File.renameTo for more information. * * @param source the file to rename * @param destination the file path to rename to * @param maxAttempts the max number of attempts to attempt the rename - * @param replace if true and a rename attempt fails will check if a file is - * already at the destination path. If so it will delete that file and - * attempt the rename according the remaining maxAttempts. If false, any - * conflicting files will be left as they were and the rename attempts will - * fail if conflicting. + * @param replace if true and a rename attempt fails will check if a file is already at the destination path. If so it will delete that file and attempt the rename according the remaining + * maxAttempts. If false, any conflicting files will be left as they were and the rename attempts will fail if conflicting. * @throws IOException if rename isn't successful */ public static void renameFile(final File source, final File destination, final int maxAttempts, final boolean replace) throws IOException { @@ -553,20 +516,15 @@ public class FileUtils { } /** - * Syncs a primary copy of a file with the copy in the restore directory. If - * the restore directory does not have a file and the primary has a file, - * the the primary's file is copied to the restore directory. Else if the - * restore directory has a file, but the primary does not, then the - * restore's file is copied to the primary directory. Else if the primary - * file is different than the restore file, then an IllegalStateException is - * thrown. Otherwise, if neither file exists, then no syncing is performed. + * Syncs a primary copy of a file with the copy in the restore directory. If the restore directory does not have a file and the primary has a file, the the primary's file is copied to the restore + * directory. Else if the restore directory has a file, but the primary does not, then the restore's file is copied to the primary directory. Else if the primary file is different than the restore + * file, then an IllegalStateException is thrown. Otherwise, if neither file exists, then no syncing is performed. * * @param primaryFile the primary file * @param restoreFile the restore file * @param logger a logger * @throws IOException if an I/O problem was encountered during syncing - * @throws IllegalStateException if the primary and restore copies exist but - * are different + * @throws IllegalStateException if the primary and restore copies exist but are different */ public static void syncWithRestore(final File primaryFile, final File restoreFile, final Logger logger) throws IOException { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/CompoundUpdateMonitor.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/CompoundUpdateMonitor.java index 6f9c61664a..dc60318379 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/CompoundUpdateMonitor.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/CompoundUpdateMonitor.java @@ -22,11 +22,8 @@ import java.util.ArrayList; import java.util.List; /** - * An {@link UpdateMonitor} that combines multiple UpdateMonitors - * such that it will indicate a change in a file only if ALL sub-monitors - * indicate a change. The sub-monitors will be applied in the order given and if - * any indicates that the state has not changed, the subsequent sub-monitors may - * not be given a chance to run + * An {@link UpdateMonitor} that combines multiple UpdateMonitors such that it will indicate a change in a file only if ALL sub-monitors indicate a change. The sub-monitors will be + * applied in the order given and if any indicates that the state has not changed, the subsequent sub-monitors may not be given a chance to run */ public class CompoundUpdateMonitor implements UpdateMonitor { diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java index 270d4d7cb3..0040037ca6 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/file/monitor/SynchronousFileWatcher.java @@ -23,8 +23,7 @@ import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; /** - * Allows the user to configure a {@link java.nio.file.Path Path} to watch for - * modifications and periodically poll to check if the file has been modified + * Allows the user to configure a {@link java.nio.file.Path Path} to watch for modifications and periodically poll to check if the file has been modified */ public class SynchronousFileWatcher { @@ -58,8 +57,7 @@ public class SynchronousFileWatcher { } /** - * Checks if the file has been updated according to the configured - * {@link UpdateMonitor} and resets the state + * Checks if the file has been updated according to the configured {@link UpdateMonitor} and resets the state * * @return true if updated; false otherwise * @throws IOException if failure occurs checking for changes diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java index f93902faf5..b407c4da31 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/Search.java @@ -23,32 +23,26 @@ import java.util.Set; import org.apache.nifi.util.search.ahocorasick.SearchState; /** - * Defines an interface to search for content given a set of search terms. Any - * implementation of search must be thread safe. + * Defines an interface to search for content given a set of search terms. Any implementation of search must be thread safe. * */ public interface Search { /** - * Establishes the dictionary of terms which will be searched in subsequent - * search calls. This can be called only once + * Establishes the dictionary of terms which will be searched in subsequent search calls. This can be called only once * * @param terms the terms to create a dictionary of */ void initializeDictionary(Set> terms); /** - * Searches the given input stream for matches between the already specified - * dictionary and the contents scanned. + * Searches the given input stream for matches between the already specified dictionary and the contents scanned. * * @param haystack the source data to scan for hits - * @param findAll if true will find all matches if false will find only the - * first match - * @return SearchState containing results Map might be empty which indicates - * no matches found but will not be null + * @param findAll if true will find all matches if false will find only the first match + * @return SearchState containing results Map might be empty which indicates no matches found but will not be null * @throws IOException Thrown for any exceptions occurring while searching. - * @throws IllegalStateException if the dictionary has not yet been - * initialized + * @throws IllegalStateException if the dictionary has not yet been initialized */ SearchState search(InputStream haystack, boolean findAll) throws IOException; diff --git a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java index a1d361e984..48f8678411 100644 --- a/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java +++ b/nifi/nifi-commons/nifi-utils/src/main/java/org/apache/nifi/util/search/SearchTerm.java @@ -40,9 +40,8 @@ public class SearchTerm { } /** - * Constructs a search term. Optionally performs a defensive copy of the - * given byte array. If the caller indicates a defensive copy is not - * necessary then they must not change the given arrays state any longer + * Constructs a search term. Optionally performs a defensive copy of the given byte array. If the caller indicates a defensive copy is not necessary then they must not change the given arrays + * state any longer * * @param bytes the bytes of the new search term * @param defensiveCopy if true will make a defensive copy; false otherwise diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java index a71484ee33..5e9440d98f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinBoardDTO.java @@ -24,8 +24,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; import org.apache.nifi.web.api.dto.util.TimeAdapter; /** - * The contents for the bulletin board including the bulletins and the timestamp - * when the board was generated. + * The contents for the bulletin board including the bulletins and the timestamp when the board was generated. */ @XmlType(name = "bulletinBoard") public class BulletinBoardDTO { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java index 239e7102f8..7ae77bbbf6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinDTO.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; import org.apache.nifi.web.api.dto.util.TimeAdapter; /** - * A bulletin that represents a notification about a passing event including, - * the source component (if applicable), the timestamp, the message, and where - * the bulletin originated (if applicable). + * A bulletin that represents a notification about a passing event including, the source component (if applicable), the timestamp, the message, and where the bulletin originated (if applicable). */ @XmlType(name = "bulletin") public class BulletinDTO { @@ -51,8 +49,7 @@ public class BulletinDTO { } /** - * @return When clustered, the address of the node from which this bulletin - * originated + * @return When clustered, the address of the node from which this bulletin originated */ public String getNodeAddress() { return nodeAddress; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java index cf4146dce6..4b060f145c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/BulletinQueryDTO.java @@ -19,8 +19,7 @@ package org.apache.nifi.web.api.dto; import javax.xml.bind.annotation.XmlType; /** - * A query for bulletin board. Will filter the resulting bulletin board - * according to the criteria in this query. + * A query for bulletin board. Will filter the resulting bulletin board according to the criteria in this query. */ @XmlType(name = "bulletinQuery") public class BulletinQueryDTO { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java index 199c73ea93..7432a725dc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectableDTO.java @@ -89,8 +89,7 @@ public class ConnectableDTO { } /** - * @return If this represents a remote port it is used to indicate whether the - * target exists + * @return If this represents a remote port it is used to indicate whether the target exists */ public Boolean getExists() { return exists; @@ -101,8 +100,7 @@ public class ConnectableDTO { } /** - * @return If this represents a remote port it is used to indicate whether is it - * configured to transmit + * @return If this represents a remote port it is used to indicate whether is it configured to transmit */ public Boolean getTransmitting() { return transmitting; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java index 1bd382e5d0..432f80ae09 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ConnectionDTO.java @@ -89,8 +89,7 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * @return The index of control point that the connection label should be placed - * over + * @return The index of control point that the connection label should be placed over */ public Integer getLabelIndex() { return labelIndex; @@ -125,8 +124,7 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * @return relationships that the source of the connection currently supports. - * This property is read only + * @return relationships that the source of the connection currently supports. This property is read only */ public Set getAvailableRelationships() { return availableRelationships; @@ -137,10 +135,8 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * The object count threshold for determining when back pressure is applied. - * Updating this value is a passive change in the sense that it won't impact - * whether existing files over the limit are affected but it does help - * feeder processors to stop pushing too much into this work queue. + * The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are + * affected but it does help feeder processors to stop pushing too much into this work queue. * * @return The back pressure object threshold */ @@ -153,11 +149,8 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * The object data size threshold for determining when back pressure is - * applied. Updating this value is a passive change in the sense that it - * won't impact whether existing files over the limit are affected but it - * does help feeder processors to stop pushing too much into this work - * queue. + * The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are + * affected but it does help feeder processors to stop pushing too much into this work queue. * * @return The back pressure data size threshold */ @@ -170,10 +163,8 @@ public class ConnectionDTO extends NiFiComponentDTO { } /** - * The amount of time a flow file may be in the flow before it will be - * automatically aged out of the flow. Once a flow file reaches this age it - * will be terminated from the flow the next time a processor attempts to - * start work on it. + * The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a + * processor attempts to start work on it. * * @return The flow file expiration in minutes */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java index 8e09fe7b4e..c6f36f3f8b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerConfigurationDTO.java @@ -86,8 +86,7 @@ public class ControllerConfigurationDTO { } /** - * @return interval in seconds between the automatic NiFi refresh requests. This - * value is read only + * @return interval in seconds between the automatic NiFi refresh requests. This value is read only */ public Long getAutoRefreshIntervalSeconds() { return autoRefreshIntervalSeconds; @@ -98,8 +97,7 @@ public class ControllerConfigurationDTO { } /** - * @return Indicates whether or not Site-to-Site communications with this instance - * is secure (2-way authentication). This value is read only + * @return Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication). This value is read only */ public Boolean isSiteToSiteSecure() { return siteToSiteSecure; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java index c5ee057cd4..34008e04ce 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerDTO.java @@ -20,9 +20,7 @@ import java.util.Set; import javax.xml.bind.annotation.XmlType; /** - * Configuration details for a NiFi controller. Primary use of this DTO is for - * consumption by a remote NiFi instance to initiate site to site - * communications. + * Configuration details for a NiFi controller. Primary use of this DTO is for consumption by a remote NiFi instance to initiate site to site communications. */ @XmlType(name = "controller") public class ControllerDTO { @@ -105,8 +103,7 @@ public class ControllerDTO { } /** - * @return Instance ID of the cluster, if this node is connected to a Cluster - * Manager, or of this individual instance of in standalone mode + * @return Instance ID of the cluster, if this node is connected to a Cluster Manager, or of this individual instance of in standalone mode */ public String getInstanceId() { return instanceId; @@ -117,12 +114,9 @@ public class ControllerDTO { } /** - * The Socket Port on which this instance is listening for Remote Transfers - * of Flow Files. If this instance is not configured to receive Flow Files - * from remote instances, this will be null. + * The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null. * - * @return a integer between 1 and 65535, or null, if not configured for - * remote transfer + * @return a integer between 1 and 65535, or null, if not configured for remote transfer */ public Integer getRemoteSiteListeningPort() { return remoteSiteListeningPort; @@ -133,8 +127,7 @@ public class ControllerDTO { } /** - * @return Indicates whether or not Site-to-Site communications with this instance - * is secure (2-way authentication) + * @return Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication) */ public Boolean isSiteToSiteSecure() { return siteToSiteSecure; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java index 02ba2e23b7..8394705400 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceDTO.java @@ -88,8 +88,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO { } /** - * @return The state of this controller service. Possible values are ENABLED, - * ENABLING, DISABLED, DISABLING + * @return The state of this controller service. Possible values are ENABLED, ENABLING, DISABLED, DISABLING */ public String getState() { return state; @@ -122,8 +121,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO { } /** - * @return the URL for this controller services custom configuration UI if - * applicable. Null otherwise + * @return the URL for this controller services custom configuration UI if applicable. Null otherwise */ public String getCustomUiUrl() { return customUiUrl; @@ -156,9 +154,7 @@ public class ControllerServiceDTO extends NiFiComponentDTO { } /** - * Gets the validation errors from this controller service. These validation - * errors represent the problems with the controller service that must be - * resolved before it can be enabled. + * Gets the validation errors from this controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled. * * @return The validation errors */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java index 4b557e1ca7..f9271228f8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ControllerServiceReferencingComponentDTO.java @@ -22,9 +22,7 @@ import java.util.Set; import javax.xml.bind.annotation.XmlType; /** - * A component referencing a controller service. This can either be another - * controller service or a processor. Depending on the type of component - * different properties may be set. + * A component referencing a controller service. This can either be another controller service or a processor. Depending on the type of component different properties may be set. */ @XmlType(name = "controllerServiceReferencingComponent") public class ControllerServiceReferencingComponentDTO { @@ -47,8 +45,7 @@ public class ControllerServiceReferencingComponentDTO { private Set referencingComponents; /** - * @return Group id for this component referencing a controller service. If this - * component is another service, this field is blank + * @return Group id for this component referencing a controller service. If this component is another service, this field is blank */ public String getGroupId() { return groupId; @@ -92,8 +89,7 @@ public class ControllerServiceReferencingComponentDTO { } /** - * @return state of the processor referencing a controller service. If this - * component is another service, this field is blank + * @return state of the processor referencing a controller service. If this component is another service, this field is blank */ public String getState() { return state; @@ -104,8 +100,7 @@ public class ControllerServiceReferencingComponentDTO { } /** - * @return type of reference this is (Processor, ControllerService, or - * ReportingTask) + * @return type of reference this is (Processor, ControllerService, or ReportingTask) */ public String getReferenceType() { return referenceType; @@ -160,8 +155,7 @@ public class ControllerServiceReferencingComponentDTO { } /** - * @return If this referencing component represents a ControllerService, these are - * the components that reference it + * @return If this referencing component represents a ControllerService, these are the components that reference it */ public Set getReferencingComponents() { return referencingComponents; @@ -172,8 +166,7 @@ public class ControllerServiceReferencingComponentDTO { } /** - * @return If this referencing component represents a ControllerService, this - * indicates whether it has already been represented in this hierarchy + * @return If this referencing component represents a ControllerService, this indicates whether it has already been represented in this hierarchy */ public Boolean getReferenceCycle() { return referenceCycle; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java index 2df4dd4612..7f47bf5243 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/CounterDTO.java @@ -19,8 +19,7 @@ package org.apache.nifi.web.api.dto; import javax.xml.bind.annotation.XmlType; /** - * Counter value for a specific component in a specific context. A counter is a - * value that a component can adjust during processing. + * Counter value for a specific component in a specific context. A counter is a value that a component can adjust during processing. */ @XmlType(name = "counter") public class CounterDTO { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java index 9339a07624..d15ceb46bb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/LabelDTO.java @@ -16,7 +16,6 @@ */ package org.apache.nifi.web.api.dto; -import java.util.Collections; import java.util.Map; import javax.xml.bind.annotation.XmlType; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java index 1ed0676efd..074a2e3e24 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/NiFiComponentDTO.java @@ -55,8 +55,7 @@ public class NiFiComponentDTO { } /** - * @return id for the parent group of this component if applicable, null - * otherwise + * @return id for the parent group of this component if applicable, null otherwise */ public String getParentGroupId() { return parentGroupId; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java index 464beafb63..6a90723bc4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PortDTO.java @@ -49,8 +49,7 @@ public class PortDTO extends NiFiComponentDTO { } /** - * @return The state of this port. Possible states are 'RUNNING', 'STOPPED', and - * 'DISABLED' + * @return The state of this port. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED' */ public String getState() { return state; @@ -96,8 +95,7 @@ public class PortDTO extends NiFiComponentDTO { } /** - * @return whether this port has incoming or outgoing connections to a remote NiFi. - * This is only applicable when the port is running on the root group + * @return whether this port has incoming or outgoing connections to a remote NiFi. This is only applicable when the port is running on the root group */ public Boolean isTransmitting() { return transmitting; @@ -130,9 +128,7 @@ public class PortDTO extends NiFiComponentDTO { } /** - * Gets the validation errors from this port. These validation errors - * represent the problems with the port that must be resolved before it can - * be started. + * Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started. * * @return The validation errors */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java index 870c32ad63..f9a655195b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessGroupDTO.java @@ -84,8 +84,7 @@ public class ProcessGroupDTO extends NiFiComponentDTO { } /** - * @return contents of this process group. This field will be populated if the - * request is marked verbose + * @return contents of this process group. This field will be populated if the request is marked verbose */ public FlowSnippetDTO getContents() { return contents; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java index b507033b68..1832ce381a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorConfigDTO.java @@ -54,8 +54,7 @@ public class ProcessorConfigDTO { } /** - * The frequency with which to schedule the processor. The format of the - * value will depend on the value of {@link #getSchedulingStrategy()}. + * The frequency with which to schedule the processor. The format of the value will depend on the value of {@link #getSchedulingStrategy()}. * * @return The scheduling period */ @@ -68,8 +67,7 @@ public class ProcessorConfigDTO { } /** - * Indicates whether the processor should be scheduled to run in - * event-driven mode or timer-driven mode + * Indicates whether the processor should be scheduled to run in event-driven mode or timer-driven mode * * @return scheduling strategy */ @@ -93,8 +91,7 @@ public class ProcessorConfigDTO { } /** - * @return amount of time must elaspe before this processor is - * scheduled again when yielding + * @return amount of time must elaspe before this processor is scheduled again when yielding */ public String getYieldDuration() { return yieldDuration; @@ -116,9 +113,7 @@ public class ProcessorConfigDTO { } /** - * The number of tasks that should be concurrently scheduled for this - * processor. If this processor doesn't allow parallel processing then any - * positive input will be ignored. + * The number of tasks that should be concurrently scheduled for this processor. If this processor doesn't allow parallel processing then any positive input will be ignored. * * @return the concurrently schedulable task count */ @@ -153,11 +148,8 @@ public class ProcessorConfigDTO { } /** - * The properties for this processor. Properties whose value is not set will - * only contain the property name. These properties are (un)marshalled - * differently since we need/want to control the ordering of the properties. - * The descriptors and metadata are used as a lookup when processing these - * properties. + * The properties for this processor. Properties whose value is not set will only contain the property name. These properties are (un)marshalled differently since we need/want to control the + * ordering of the properties. The descriptors and metadata are used as a lookup when processing these properties. * * @return The optional properties */ @@ -194,8 +186,7 @@ public class ProcessorConfigDTO { } /** - * @return the URL for this processors custom configuration UI if - * applicable. Null otherwise. + * @return the URL for this processors custom configuration UI if applicable. Null otherwise. */ public String getCustomUiUrl() { return customUiUrl; @@ -206,8 +197,7 @@ public class ProcessorConfigDTO { } /** - * @return the names of all processor relationships that cause a flow file to be - * terminated if the relationship is not connected to anything + * @return the names of all processor relationships that cause a flow file to be terminated if the relationship is not connected to anything */ public Set getAutoTerminatedRelationships() { return autoTerminatedRelationships; @@ -218,8 +208,7 @@ public class ProcessorConfigDTO { } /** - * @return maps default values for concurrent tasks for each applicable scheduling - * strategy. + * @return maps default values for concurrent tasks for each applicable scheduling strategy. */ public Map getDefaultConcurrentTasks() { return defaultConcurrentTasks; @@ -241,8 +230,7 @@ public class ProcessorConfigDTO { } /** - * @return Maps default values for scheduling period for each applicable scheduling - * strategy + * @return Maps default values for scheduling period for each applicable scheduling strategy */ public Map getDefaultSchedulingPeriod() { return defaultSchedulingPeriod; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java index cda26cdc40..b80db70a45 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ProcessorDTO.java @@ -71,8 +71,7 @@ public class ProcessorDTO extends NiFiComponentDTO { } /** - * @return The state of this processor. Possible states are 'RUNNING', 'STOPPED', - * and 'DISABLED' + * @return The state of this processor. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED' */ public String getState() { return state; @@ -129,8 +128,7 @@ public class ProcessorDTO extends NiFiComponentDTO { } /** - * The configuration details for this processor. These details will be - * included in a response if the verbose flag is set to true. + * The configuration details for this processor. These details will be included in a response if the verbose flag is set to true. * * @return The processor configuration details */ @@ -143,9 +141,7 @@ public class ProcessorDTO extends NiFiComponentDTO { } /** - * Gets the validation errors from this processor. These validation errors - * represent the problems with the processor that must be resolved before it - * can be started. + * Gets the validation errors from this processor. These validation errors represent the problems with the processor that must be resolved before it can be started. * * @return The validation errors */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java index af3de2b91a..02a55a7ecf 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/PropertyDescriptorDTO.java @@ -37,8 +37,7 @@ public class PropertyDescriptorDTO { private String identifiesControllerService; /** - * @return set of allowable values for this property. If empty then the - * allowable values are not constrained + * @return set of allowable values for this property. If empty then the allowable values are not constrained */ public List getAllowableValues() { return allowableValues; @@ -60,9 +59,7 @@ public class PropertyDescriptorDTO { } /** - * @return An explanation of the meaning of the given property. This - * description is meant to be displayed to a user or simply provide a - * mechanism of documenting intent + * @return An explanation of the meaning of the given property. This description is meant to be displayed to a user or simply provide a mechanism of documenting intent */ public String getDescription() { return description; @@ -106,8 +103,7 @@ public class PropertyDescriptorDTO { } /** - * @return indicates that the value for this property should be considered - * sensitive and protected whenever stored or represented + * @return indicates that the value for this property should be considered sensitive and protected whenever stored or represented */ public boolean isSensitive() { return sensitive; @@ -129,8 +125,7 @@ public class PropertyDescriptorDTO { } /** - * @return specifies whether or not this property support expression - * language + * @return specifies whether or not this property support expression language */ public boolean getSupportsEl() { return supportsEl; @@ -141,8 +136,7 @@ public class PropertyDescriptorDTO { } /** - * @return if this property identifies a controller service, this returns - * the fully qualified type, null otherwise + * @return if this property identifies a controller service, this returns the fully qualified type, null otherwise */ public String getIdentifiesControllerService() { return identifiesControllerService; @@ -163,8 +157,7 @@ public class PropertyDescriptorDTO { private String description; /** - * @return the human-readable value that is allowed for this - * PropertyDescriptor + * @return the human-readable value that is allowed for this PropertyDescriptor */ public String getDisplayName() { return displayName; @@ -186,8 +179,7 @@ public class PropertyDescriptorDTO { } /** - * @return a description of this Allowable Value, or null - * if no description is given + * @return a description of this Allowable Value, or null if no description is given */ public String getDescription() { return description; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java index 22bbee0d94..b30320ad44 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupDTO.java @@ -129,8 +129,7 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { } /** - * @return the time period used for the timeout when communicating with this - * RemoteProcessGroup + * @return the time period used for the timeout when communicating with this RemoteProcessGroup */ public String getCommunicationsTimeout() { return communicationsTimeout; @@ -141,8 +140,7 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { } /** - * @return when yielding, this amount of time must elaspe before this remote process - * group is scheduled again + * @return when yielding, this amount of time must elaspe before this remote process group is scheduled again */ public String getYieldDuration() { return yieldDuration; @@ -197,8 +195,7 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { } /** - * @return number of Remote Input Ports currently available in the remote NiFi - * instance + * @return number of Remote Input Ports currently available in the remote NiFi instance */ public Integer getInputPortCount() { return inputPortCount; @@ -209,8 +206,7 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { } /** - * @return number of Remote Output Ports currently available in the remote NiFi - * instance + * @return number of Remote Output Ports currently available in the remote NiFi instance */ public Integer getOutputPortCount() { return outputPortCount; @@ -221,8 +217,7 @@ public class RemoteProcessGroupDTO extends NiFiComponentDTO { } /** - * @return contents of this remote process group. Will contain available - * input/output ports + * @return contents of this remote process group. Will contain available input/output ports */ public RemoteProcessGroupContentsDTO getContents() { return contents; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java index 71d0f661d7..07f8ced880 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RemoteProcessGroupPortDTO.java @@ -47,8 +47,7 @@ public class RemoteProcessGroupPortDTO { } /** - * @return number tasks that may transmit flow files to the target port - * concurrently + * @return number tasks that may transmit flow files to the target port concurrently */ public Integer getConcurrentlySchedulableTaskCount() { return concurrentlySchedulableTaskCount; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java index 6b6558ae4a..4abba4b662 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/ReportingTaskDTO.java @@ -22,8 +22,7 @@ import java.util.Map; import javax.xml.bind.annotation.XmlType; /** - * Component that is capable of reporting internal NiFi state to an external - * service + * Component that is capable of reporting internal NiFi state to an external service */ @XmlType(name = "reportingTask") public class ReportingTaskDTO extends NiFiComponentDTO { @@ -81,8 +80,7 @@ public class ReportingTaskDTO extends NiFiComponentDTO { } /** - * The frequency with which to schedule the reporting task. The format of - * the value will depend on the value of {@link #getSchedulingStrategy()}. + * The frequency with which to schedule the reporting task. The format of the value will depend on the value of {@link #getSchedulingStrategy()}. * * @return The scheduling period */ @@ -106,8 +104,7 @@ public class ReportingTaskDTO extends NiFiComponentDTO { } /** - * @return The scheduling strategy that determines how the - * {@link #getSchedulingPeriod()} value should be interpreted + * @return The scheduling strategy that determines how the {@link #getSchedulingPeriod()} value should be interpreted */ public String getSchedulingStrategy() { return schedulingStrategy; @@ -118,8 +115,7 @@ public class ReportingTaskDTO extends NiFiComponentDTO { } /** - * @return Where this service is available. Possible values are - * CLUSTER_MANAGER_ONLY, NODE_ONLY, BOTH + * @return Where this service is available. Possible values are CLUSTER_MANAGER_ONLY, NODE_ONLY, BOTH */ public String getAvailability() { return availability; @@ -152,8 +148,7 @@ public class ReportingTaskDTO extends NiFiComponentDTO { } /** - * @return the URL for this reporting task custom configuration UI if - * applicable. Null otherwise + * @return the URL for this reporting task custom configuration UI if applicable. Null otherwise */ public String getCustomUiUrl() { return customUiUrl; @@ -175,9 +170,7 @@ public class ReportingTaskDTO extends NiFiComponentDTO { } /** - * Gets the validation errors from this reporting task. These validation - * errors represent the problems with the reporting task that must be - * resolved before it can be scheduled to run. + * Gets the validation errors from this reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run. * * @return The validation errors */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java index 7a60c6edd2..e8f4309de7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/RevisionDTO.java @@ -30,11 +30,8 @@ public class RevisionDTO { /* getters / setters */ /** - * A client identifier used to make a request. By including a client - * identifier, the API can allow multiple requests without needing the - * current revision. Due to the asynchronous nature of requests/responses - * this was implemented to allow the client to make numerous requests - * without having to wait for the previous response to come back. + * A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of + * requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back. * * @return The client id */ @@ -47,9 +44,7 @@ public class RevisionDTO { } /** - * NiFi employs an optimistic locking strategy where the client must include - * a revision in their request when performing an update. In a response, - * this field represents the updated base version. + * NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response, this field represents the updated base version. * * @return The revision */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java index 8e2c21501b..810b7beacd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/SnippetDTO.java @@ -88,10 +88,8 @@ public class SnippetDTO { } /** - * @return the ids of the connections in this snippet. These ids will be populated - * within each response. They can be specified when creating a snippet. - * However, once a snippet has been created its contents cannot be modified - * (these ids are ignored during update requests) + * @return the ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its + * contents cannot be modified (these ids are ignored during update requests) */ public Set getConnections() { return connections; @@ -102,10 +100,8 @@ public class SnippetDTO { } /** - * @return the ids of the funnels in this snippet. These ids will be populated - * within each response. They can be specified when creating a snippet. - * However, once a snippet has been created its contents cannot be modified - * (these ids are ignored during update requests) + * @return the ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its + * contents cannot be modified (these ids are ignored during update requests) */ public Set getFunnels() { return funnels; @@ -116,10 +112,8 @@ public class SnippetDTO { } /** - * @return the ids of the input port in this snippet. These ids will be populated - * within each response. They can be specified when creating a snippet. - * However, once a snippet has been created its contents cannot be modified - * (these ids are ignored during update requests) + * @return the ids of the input port in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its + * contents cannot be modified (these ids are ignored during update requests) */ public Set getInputPorts() { return inputPorts; @@ -130,10 +124,8 @@ public class SnippetDTO { } /** - * @return the ids of the labels in this snippet. These ids will be populated within - * each response. They can be specified when creating a snippet. However, - * once a snippet has been created its contents cannot be modified (these - * ids are ignored during update requests) + * @return the ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its + * contents cannot be modified (these ids are ignored during update requests) */ public Set getLabels() { return labels; @@ -144,10 +136,8 @@ public class SnippetDTO { } /** - * @return the ids of the output ports in this snippet. These ids will be populated - * within each response. They can be specified when creating a snippet. - * However, once a snippet has been created its contents cannot be modified - * (these ids are ignored during update requests) + * @return the ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created + * its contents cannot be modified (these ids are ignored during update requests) */ public Set getOutputPorts() { return outputPorts; @@ -158,10 +148,8 @@ public class SnippetDTO { } /** - * @return The ids of the process groups in this snippet. These ids will be - * populated within each response. They can be specified when creating a - * snippet. However, once a snippet has been created its contents cannot be - * modified (these ids are ignored during update requests) + * @return The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created + * its contents cannot be modified (these ids are ignored during update requests) */ public Set getProcessGroups() { return processGroups; @@ -172,10 +160,8 @@ public class SnippetDTO { } /** - * @return The ids of the processors in this snippet. These ids will be populated - * within each response. They can be specified when creating a snippet. - * However, once a snippet has been created its contents cannot be modified - * (these ids are ignored during update requests) + * @return The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its + * contents cannot be modified (these ids are ignored during update requests) */ public Set getProcessors() { return processors; @@ -186,10 +172,8 @@ public class SnippetDTO { } /** - * @return the ids of the remote process groups in this snippet. These ids will be - * populated within each response. They can be specified when creating a - * snippet. However, once a snippet has been created its contents cannot be - * modified (these ids are ignored during update requests) + * @return the ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been + * created its contents cannot be modified (these ids are ignored during update requests) */ public Set getRemoteProcessGroups() { return remoteProcessGroups; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java index c62f99c2e9..2c564222c4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/UserDTO.java @@ -86,8 +86,7 @@ public class UserDTO { } /** - * @return users name. If the name could not be extracted from the DN, this - * value will be the entire DN + * @return users name. If the name could not be extracted from the DN, this value will be the entire DN */ public String getUserName() { return userName; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java index 333570e9fa..54a5858cd2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceDTO.java @@ -24,8 +24,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; import org.apache.nifi.web.api.dto.util.TimestampAdapter; /** - * A provenance submission. Incorporates the request, its current status, and - * the results. + * A provenance submission. Incorporates the request, its current status, and the results. */ @XmlType(name = "provenance") public class ProvenanceDTO { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java index 883fce8392..46c1074682 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/ProvenanceEventDTO.java @@ -172,8 +172,7 @@ public class ProvenanceEventDTO { } /** - * @return id of the group that this component resides in. If the component is - * no longer in the flow, the group id will not be set + * @return id of the group that this component resides in. If the component is no longer in the flow, the group id will not be set */ public String getGroupId() { return groupId; @@ -316,8 +315,7 @@ public class ProvenanceEventDTO { } /** - * @return If this represents a route event, this is the relationship to which the - * flowfile was routed + * @return If this represents a route event, this is the relationship to which the flowfile was routed */ public String getRelationship() { return relationship; @@ -361,8 +359,7 @@ public class ProvenanceEventDTO { } /** - * @return the Section in which the output Content Claim lives, or - * null if no Content Claim exists + * @return the Section in which the output Content Claim lives, or null if no Content Claim exists */ public String getOutputContentClaimSection() { return outputContentClaimSection; @@ -373,8 +370,7 @@ public class ProvenanceEventDTO { } /** - * @return the Container in which the output Content Claim lives, or - * null if no Content Claim exists + * @return the Container in which the output Content Claim lives, or null if no Content Claim exists */ public String getOutputContentClaimContainer() { return outputContentClaimContainer; @@ -385,8 +381,7 @@ public class ProvenanceEventDTO { } /** - * @return the Identifier of the output Content Claim, or null - * if no Content Claim exists + * @return the Identifier of the output Content Claim, or null if no Content Claim exists */ public String getOutputContentClaimIdentifier() { return outputContentClaimIdentifier; @@ -397,8 +392,7 @@ public class ProvenanceEventDTO { } /** - * @return the offset into the the output Content Claim where the FlowFile's - * content begins, or null if no Content Claim exists + * @return the offset into the the output Content Claim where the FlowFile's content begins, or null if no Content Claim exists */ public Long getOutputContentClaimOffset() { return outputContentClaimOffset; @@ -442,8 +436,7 @@ public class ProvenanceEventDTO { } /** - * @return the Section in which the input Content Claim lives, or - * null if no Content Claim exists + * @return the Section in which the input Content Claim lives, or null if no Content Claim exists */ public String getInputContentClaimSection() { return inputContentClaimSection; @@ -454,8 +447,7 @@ public class ProvenanceEventDTO { } /** - * @return the Container in which the input Content Claim lives, or - * null if no Content Claim exists + * @return the Container in which the input Content Claim lives, or null if no Content Claim exists */ public String getInputContentClaimContainer() { return inputContentClaimContainer; @@ -466,8 +458,7 @@ public class ProvenanceEventDTO { } /** - * @return the Identifier of the input Content Claim, or null - * if no Content Claim exists + * @return the Identifier of the input Content Claim, or null if no Content Claim exists */ public String getInputContentClaimIdentifier() { return inputContentClaimIdentifier; @@ -478,8 +469,7 @@ public class ProvenanceEventDTO { } /** - * @return the offset into the the input Content Claim where the FlowFile's - * content begins, or null if no Content Claim exists + * @return the offset into the the input Content Claim where the FlowFile's content begins, or null if no Content Claim exists */ public Long getInputContentClaimOffset() { return inputContentClaimOffset; @@ -534,9 +524,8 @@ public class ProvenanceEventDTO { } /** - * @return identifier of the FlowFile Queue / Connection from which the - * FlowFile was pulled to generate this event, or null if - * either the queue is unknown or the FlowFile was created by this event + * @return identifier of the FlowFile Queue / Connection from which the FlowFile was pulled to generate this event, or null if either the queue is unknown or the FlowFile was created + * by this event */ public String getSourceConnectionIdentifier() { return sourceConnectionIdentifier; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java index afcea3f062..249496257d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/LineageRequestDTO.java @@ -54,11 +54,8 @@ public class LineageRequestDTO { } /** - * @return type of lineage request. Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. - * PARENTS will return the lineage for the flowfiles that are parents of the - * specified event. CHILDREN will return the lineage of for the flowfiles - * that are children of the specified event. FLOWFILE will return the - * lineage for the specified flowfile. + * @return type of lineage request. Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the + * lineage of for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile. */ public LineageRequestType getLineageRequestType() { return lineageRequestType; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java index 4a7ed9c394..b51775134e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/provenance/lineage/ProvenanceNodeDTO.java @@ -25,8 +25,7 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; import org.apache.nifi.web.api.dto.util.TimestampAdapter; /** - * A node within a provenance lineage. May represent either an event or a - * flowfile. + * A node within a provenance lineage. May represent either an event or a flowfile. */ @XmlType(name = "provenanceNode") public class ProvenanceNodeDTO { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java index adfee2ad6c..bd2eca6e34 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ControllerStatusDTO.java @@ -65,8 +65,7 @@ public class ControllerStatusDTO { } /** - * @return Used in clustering, will report the number of nodes connected vs the - * number of nodes in the cluster + * @return Used in clustering, will report the number of nodes connected vs the number of nodes in the cluster */ public String getConnectedNodes() { return connectedNodes; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java index db03146758..e4cbd34677 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/PortStatusDTO.java @@ -100,8 +100,7 @@ public class PortStatusDTO extends StatusDTO { } /** - * @return The total count and size of flow files that have been accepted in the - * last five minutes + * @return The total count and size of flow files that have been accepted in the last five minutes */ public String getInput() { return input; @@ -112,8 +111,7 @@ public class PortStatusDTO extends StatusDTO { } /** - * @return The total count and size of flow files that have been processed in the - * last five minutes + * @return The total count and size of flow files that have been processed in the last five minutes */ public String getOutput() { return output; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java index 7ad24a94c3..6aa445a260 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessGroupStatusDTO.java @@ -177,8 +177,7 @@ public class ProcessGroupStatusDTO extends StatusDTO { } /** - * The transferred stats for this process group. This represents the - * count/size of flowfiles transferred to/from queues. + * The transferred stats for this process group. This represents the count/size of flowfiles transferred to/from queues. * * @return The transferred status for this process group */ @@ -191,8 +190,7 @@ public class ProcessGroupStatusDTO extends StatusDTO { } /** - * The received stats for this process group. This represents the count/size - * of flowfiles received. + * The received stats for this process group. This represents the count/size of flowfiles received. * * @return The received stats for this process group */ @@ -205,8 +203,7 @@ public class ProcessGroupStatusDTO extends StatusDTO { } /** - * The sent stats for this process group. This represents the count/size of - * flowfiles sent. + * The sent stats for this process group. This represents the count/size of flowfiles sent. * * @return The sent stats for this process group */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java index 18539bed53..21c3d44bbb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/ProcessorStatusDTO.java @@ -86,8 +86,7 @@ public class ProcessorStatusDTO extends StatusDTO { } /** - * @return The total count and size of flow files that have been accepted in the - * last five minutes + * @return The total count and size of flow files that have been accepted in the last five minutes */ public String getInput() { return input; @@ -131,8 +130,7 @@ public class ProcessorStatusDTO extends StatusDTO { } /** - * @return The total count and size of flow files that have been processed in the - * last five minutes + * @return The total count and size of flow files that have been processed in the last five minutes */ public String getOutput() { return output; @@ -165,8 +163,7 @@ public class ProcessorStatusDTO extends StatusDTO { } /** - * @return total duration of all tasks for this connectable over the last 5 - * minutes + * @return total duration of all tasks for this connectable over the last 5 minutes */ public String getTasksDuration() { return tasksDuration; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java index 68aa5d6c47..5f7c2c1588 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/dto/status/RemoteProcessGroupStatusDTO.java @@ -115,8 +115,7 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO { } /** - * @return Formatted description of the amount of data sent to this remote process - * group + * @return Formatted description of the amount of data sent to this remote process group */ public String getSent() { return sent; @@ -127,8 +126,7 @@ public class RemoteProcessGroupStatusDTO extends StatusDTO { } /** - * @return Formatted description of the amount of data received from this remote - * process group + * @return Formatted description of the amount of data received from this remote process group */ public String getReceived() { return received; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AboutEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AboutEntity.java index 36fc163a04..5cdbe1e53b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AboutEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AboutEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.AboutDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a AboutDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a AboutDTO. */ @XmlRootElement(name = "aboutEntity") public class AboutEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ActionEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ActionEntity.java index 1b2c0b63c8..d52f5fbb4c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ActionEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ActionEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.action.ActionDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to an ActionDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to an ActionDTO. */ @XmlRootElement(name = "actionEntity") public class ActionEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AuthorityEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AuthorityEntity.java index 103a93751a..9b023ba302 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AuthorityEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/AuthorityEntity.java @@ -21,9 +21,7 @@ import java.util.Set; import javax.xml.bind.annotation.XmlRootElement; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a set of user - * authorities. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a set of user authorities. */ @XmlRootElement(name = "authoritiesEntity") public class AuthorityEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BannerEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BannerEntity.java index 594707a6df..c9a8cd2048 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BannerEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BannerEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.BannerDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a BannerDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a BannerDTO. */ @XmlRootElement(name = "bannersEntity") public class BannerEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BulletinBoardEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BulletinBoardEntity.java index 4287893ffd..f648d50e88 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BulletinBoardEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/BulletinBoardEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.BulletinBoardDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a BulletinBoardDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a BulletinBoardDTO. */ @XmlRootElement(name = "bulletinBoardEntity") public class BulletinBoardEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterConnectionStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterConnectionStatusEntity.java index 732a4b7077..f211cc40d7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterConnectionStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterConnectionStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterConnectionStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterConnectionStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterConnectionStatusDTO. */ @XmlRootElement(name = "clusterConnectionStatusEntity") public class ClusterConnectionStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterEntity.java index 8306b0f879..c59ce017f5 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ClusterDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterDTO. */ @XmlRootElement(name = "clusterEntity") public class ClusterEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterPortStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterPortStatusEntity.java index 16a249732b..477b6ec7dc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterPortStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterPortStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterPortStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterPortStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterPortStatusDTO. */ @XmlRootElement(name = "clusterPortStatusEntity") public class ClusterPortStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessGroupStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessGroupStatusEntity.java index cddb21ab43..f8b7e11115 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessGroupStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessGroupStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterProcessGroupStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterProcessGroupStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterProcessGroupStatusDTO. */ @XmlRootElement(name = "clusterProcessGroupStatusEntity") public class ClusterProcessGroupStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessorStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessorStatusEntity.java index 68e5c5cac5..2b8220fe88 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessorStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterProcessorStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterProcessorStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterProcessorStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterProcessorStatusDTO. */ @XmlRootElement(name = "clusterProcessorStatusEntity") public class ClusterProcessorStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterRemoteProcessGroupStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterRemoteProcessGroupStatusEntity.java index 8a3da7cbc3..66569c55e9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterRemoteProcessGroupStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterRemoteProcessGroupStatusEntity.java @@ -20,9 +20,8 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterRemoteProcessGroupStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterRemoteProcessGroupStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a + * ClusterRemoteProcessGroupStatusDTO. */ @XmlRootElement(name = "clusterRemoteProcessGroupStatusEntity") public class ClusterRemoteProcessGroupStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterSearchResultsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterSearchResultsEntity.java index ad1c1a5557..48fc01f1df 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterSearchResultsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterSearchResultsEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.search.NodeSearchResultDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to NodeSearchResultDTOs. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to NodeSearchResultDTOs. */ @XmlRootElement(name = "clusterSearchResultsEntity") public class ClusterSearchResultsEntity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusEntity.java index d22d432515..84fffb964d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterStatusDTO. */ @XmlRootElement(name = "clusterStatusEntity") public class ClusterStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusHistoryEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusHistoryEntity.java index 9ed69fd807..b13984a2a4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusHistoryEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ClusterStatusHistoryEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ClusterStatusHistoryDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ClusterStatusHistoryDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ClusterStatusHistoryDTO. */ @XmlRootElement(name = "clusterStatusHistoryEntity") public class ClusterStatusHistoryEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ComponentHistoryEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ComponentHistoryEntity.java index ca682110df..a6e705fd26 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ComponentHistoryEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ComponentHistoryEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ComponentHistoryDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ComponentHistoryDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ComponentHistoryDTO. */ @XmlRootElement(name = "componentHistoryEntity") public class ComponentHistoryEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionEntity.java index 2791bfaa9b..b041e51cfc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ConnectionDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a - * ConnectionDTO. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a ConnectionDTO. */ @XmlRootElement(name = "connectionEntity") public class ConnectionEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionsEntity.java index 7988d120d8..5b2b1b0ed0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ConnectionsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ConnectionDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * ConnectionDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of ConnectionDTOs. */ @XmlRootElement(name = "connectionsEntity") public class ConnectionsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerConfigurationEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerConfigurationEntity.java index e13903b267..22c859e51a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerConfigurationEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerConfigurationEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ControllerConfigurationDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ControllerConfigurationDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ControllerConfigurationDTO. */ @XmlRootElement(name = "controllerConfigurationEntity") public class ControllerConfigurationEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerEntity.java index 62d0409efe..706f538f3a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ControllerDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ControllerDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ControllerDTO. */ @XmlRootElement(name = "controllerEntity") public class ControllerEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceEntity.java index 65c38a979d..8f217b5b28 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ControllerServiceDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a - * controller service. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a controller service. */ @XmlRootElement(name = "controllerServiceEntity") public class ControllerServiceEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceReferencingComponentsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceReferencingComponentsEntity.java index 69999274ef..c6be79dd18 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceReferencingComponentsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceReferencingComponentsEntity.java @@ -21,9 +21,8 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ControllerServiceReferencingComponentDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * controller services referencing components. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of controller services referencing + * components. */ @XmlRootElement(name = "controllerServiceReferencingComponentsEntity") public class ControllerServiceReferencingComponentsEntity extends Entity { @@ -31,8 +30,7 @@ public class ControllerServiceReferencingComponentsEntity extends Entity { private Set controllerServiceReferencingComponents; /** - * @return list of controller service referencing components that are being - * serialized + * @return list of controller service referencing components that are being serialized */ public Set getControllerServiceReferencingComponents() { return controllerServiceReferencingComponents; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceTypesEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceTypesEntity.java index 580a76e4ce..8b8bae48e4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceTypesEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServiceTypesEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.DocumentedTypeDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * controller service types. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of controller service types. */ @XmlRootElement(name = "controllerServiceTypesEntity") public class ControllerServiceTypesEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServicesEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServicesEntity.java index cda93c4ef5..9c2c366276 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServicesEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerServicesEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ControllerServiceDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * controller services. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of controller services. */ @XmlRootElement(name = "controllerServicesEntity") public class ControllerServicesEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerStatusEntity.java index 94d8aca23f..6183546246 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ControllerStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ControllerStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ControllerStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ControllerStatusDTO. */ @XmlRootElement(name = "controllerStatusEntity") public class ControllerStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CounterEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CounterEntity.java index ef329b8293..c84d11eb2e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CounterEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CounterEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.CounterDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response from the API. This particular entity holds a reference to a - * CounterDTO. + * A serialized representation of this class can be placed in the entity body of a response from the API. This particular entity holds a reference to a CounterDTO. */ @XmlRootElement(name = "counterEntity") public class CounterEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CountersEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CountersEntity.java index c1991a1dc0..dabd5a177f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CountersEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/CountersEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.CountersDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response from the API. This particular entity holds a reference to a - * CountersDTO. + * A serialized representation of this class can be placed in the entity body of a response from the API. This particular entity holds a reference to a CountersDTO. */ @XmlRootElement(name = "countersEntity") public class CountersEntity extends Entity { @@ -30,8 +28,7 @@ public class CountersEntity extends Entity { private CountersDTO counters; /** - * @return the counters which contains all the counter groups and a generation - * date + * @return the counters which contains all the counter groups and a generation date */ public CountersDTO getCounters() { return counters; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FlowSnippetEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FlowSnippetEntity.java index a15cc51de3..bff4a51c83 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FlowSnippetEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FlowSnippetEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.FlowSnippetDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a FlowSnippetDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a FlowSnippetDTO. */ @XmlRootElement(name = "flowSnippetEntity") public class FlowSnippetEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelEntity.java index 8b43fb8bbd..241ac51439 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.FunnelDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a FunnelDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a FunnelDTO. */ @XmlRootElement(name = "funnelEntity") public class FunnelEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelsEntity.java index 4586c9d50f..34426db42d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/FunnelsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.FunnelDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * FunnelDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of FunnelDTOs. */ @XmlRootElement(name = "funnelsEntity") public class FunnelsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/HistoryEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/HistoryEntity.java index f817cce4bd..72a46561b6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/HistoryEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/HistoryEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.action.HistoryDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a HistoryDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a HistoryDTO. */ @XmlRootElement(name = "historyEntity") public class HistoryEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortEntity.java index dc497b5eb1..f92c47802f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.PortDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to an input - * PortDTO. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to an input PortDTO. */ @XmlRootElement(name = "inputPortEntity") public class InputPortEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortsEntity.java index a112fdd054..93a03e7127 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/InputPortsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.PortDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * input PortDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of input PortDTOs. */ @XmlRootElement(name = "inputPortsEntity") public class InputPortsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelEntity.java index 867d781402..535240c194 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.LabelDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a LabelDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a LabelDTO. */ @XmlRootElement(name = "labelEntity") public class LabelEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelsEntity.java index d4b9681b3a..05dab6c371 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LabelsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.LabelDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * LabelDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of LabelDTOs. */ @XmlRootElement(name = "labelsEntity") public class LabelsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LineageEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LineageEntity.java index 5d443af89b..6bcf039ff4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LineageEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/LineageEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.provenance.lineage.LineageDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a LineageDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a LineageDTO. */ @XmlRootElement(name = "lineageEntity") public class LineageEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeEntity.java index ac5b306f16..75c9c4ca08 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.NodeDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a NodeDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a NodeDTO. */ @XmlRootElement(name = "nodeEntity") public class NodeEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeStatusEntity.java index d7471dae67..54ba306ee4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.NodeStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a NodeStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a NodeStatusDTO. */ @XmlRootElement(name = "nodeStatusEntity") public class NodeStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeSystemDiagnosticsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeSystemDiagnosticsEntity.java index 59eafa16b7..443276c05a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeSystemDiagnosticsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/NodeSystemDiagnosticsEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.NodeSystemDiagnosticsDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a NodeSystemDiagnosticsDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a NodeSystemDiagnosticsDTO. */ @XmlRootElement(name = "nodeSystemDiagnosticsEntity") public class NodeSystemDiagnosticsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortEntity.java index 7c5145ede8..4f40aec66e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.PortDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to an output - * PortDTO. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to an output PortDTO. */ @XmlRootElement(name = "outputPortEntity") public class OutputPortEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortsEntity.java index 01271905f2..e624c52e02 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/OutputPortsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.PortDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * output PortDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of output PortDTOs. */ @XmlRootElement(name = "outputPortsEntity") public class OutputPortsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PrioritizerTypesEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PrioritizerTypesEntity.java index 2e3f545b62..7f1dfa325a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PrioritizerTypesEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PrioritizerTypesEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.DocumentedTypeDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * prioritizer types. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of prioritizer types. */ @XmlRootElement(name = "prioritizerTypesEntity") public class PrioritizerTypesEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupEntity.java index c677ef1a24..d1ec034271 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ProcessGroupDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ProcessGroupDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ProcessGroupDTO. */ @XmlRootElement(name = "processGroupEntity") public class ProcessGroupEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupStatusEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupStatusEntity.java index f0a6e0f651..d7d857f3a1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupStatusEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupStatusEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.ProcessGroupStatusDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ProcessGroupStatusDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ProcessGroupStatusDTO. */ @XmlRootElement(name = "processGroupStatusEntity") public class ProcessGroupStatusEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupsEntity.java index 1fdf23f839..7acf650e4a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessGroupsEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ProcessGroupDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a set of ProcessGroupDTOs. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a set of ProcessGroupDTOs. */ @XmlRootElement(name = "processGroupsEntity") public class ProcessGroupsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorEntity.java index 21ad431df4..e03bb85ef3 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ProcessorDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ProcessorDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ProcessorDTO. */ @XmlRootElement(name = "processorEntity") public class ProcessorEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorTypesEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorTypesEntity.java index fa584ce25f..17cf7fd226 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorTypesEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorTypesEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.DocumentedTypeDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * processor types. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of processor types. */ @XmlRootElement(name = "processorTypesEntity") public class ProcessorTypesEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorsEntity.java index 201f5aae22..04db99fb32 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProcessorsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ProcessorDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * ProcessorDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of ProcessorDTOs. */ @XmlRootElement(name = "processorsEntity") public class ProcessorsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PropertyDescriptorEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PropertyDescriptorEntity.java index 87ca4a3932..478952c4af 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PropertyDescriptorEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/PropertyDescriptorEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.PropertyDescriptorDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a PropertyDescriptorDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a PropertyDescriptorDTO. */ @XmlRootElement(name = "propertyDescriptor") public class PropertyDescriptorEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceEventEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceEventEntity.java index 0aa0a5528d..0396145cba 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceEventEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceEventEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.provenance.ProvenanceEventDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ProvenanceEventDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ProvenanceEventDTO. */ @XmlRootElement(name = "provenanceEventEntity") public class ProvenanceEventEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceOptionsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceOptionsEntity.java index 01591cb3a8..e4510d62bc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceOptionsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ProvenanceOptionsEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.provenance.ProvenanceOptionsDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a ProvenanceOptionsDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a ProvenanceOptionsDTO. */ @XmlRootElement(name = "provenanceOptionsEntity") public class ProvenanceOptionsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupEntity.java index 62a84d6abb..ba12f40f3f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.RemoteProcessGroupDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a RemoteProcessGroupDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a RemoteProcessGroupDTO. */ @XmlRootElement(name = "remoteProcessGroupEntity") public class RemoteProcessGroupEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupPortEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupPortEntity.java index f310b5e5ec..9d5189af5c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupPortEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupPortEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.RemoteProcessGroupPortDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a RemoteProcessGroupPortDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a RemoteProcessGroupPortDTO. */ @XmlRootElement(name = "remoteProcessGroupPortEntity") public class RemoteProcessGroupPortEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupsEntity.java index a94b42f83b..42abf238a7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/RemoteProcessGroupsEntity.java @@ -22,9 +22,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.RemoteProcessGroupDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * RemoteProcessGroupDTOs. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of RemoteProcessGroupDTOs. */ @XmlRootElement(name = "remoteProcessGroupsEntity") public class RemoteProcessGroupsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskEntity.java index 2177564ff7..3c07dd74bb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ReportingTaskDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a - * reporting task. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a reporting task. */ @XmlRootElement(name = "reportingTaskEntity") public class ReportingTaskEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskTypesEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskTypesEntity.java index c527ec72f0..da995319c3 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskTypesEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTaskTypesEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.DocumentedTypeDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * reporting task types. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of reporting task types. */ @XmlRootElement(name = "reportingTaskTypesEntity") public class ReportingTaskTypesEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTasksEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTasksEntity.java index 4f7be11c71..b493594cb4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTasksEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/ReportingTasksEntity.java @@ -21,9 +21,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.ReportingTaskDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a response to the API. This particular entity holds a reference to a list of - * reporting tasks. + * A serialized representation of this class can be placed in the entity body of a response to the API. This particular entity holds a reference to a list of reporting tasks. */ @XmlRootElement(name = "reportingTasksEntity") public class ReportingTasksEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SearchResultsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SearchResultsEntity.java index 01e6918874..43aa3cfa1b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SearchResultsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SearchResultsEntity.java @@ -20,10 +20,8 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.search.SearchResultsDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to ProcessorSearchResultDTOs, RemoteProcessGroupSearchResultDTOs, - * and ConnectionSearchResultDTOs. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to ProcessorSearchResultDTOs, + * RemoteProcessGroupSearchResultDTOs, and ConnectionSearchResultDTOs. */ @XmlRootElement(name = "searchResultsEntity") public class SearchResultsEntity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SnippetEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SnippetEntity.java index a9b05a1cc3..d20e61dfae 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SnippetEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SnippetEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.SnippetDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a SnippetDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a SnippetDTO. */ @XmlRootElement(name = "snippetEntity") public class SnippetEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/StatusHistoryEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/StatusHistoryEntity.java index d3c2247d3a..98891ffb25 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/StatusHistoryEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/StatusHistoryEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.status.StatusHistoryDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a StatusHistoryDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a StatusHistoryDTO. */ @XmlRootElement(name = "statusHistoryEntity") public class StatusHistoryEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SystemDiagnosticsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SystemDiagnosticsEntity.java index e7baa1606b..8c8b865569 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SystemDiagnosticsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/SystemDiagnosticsEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.SystemDiagnosticsDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a SystemDiagnosticsDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a SystemDiagnosticsDTO. */ @XmlRootElement(name = "systemDiagnosticsEntity") public class SystemDiagnosticsEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplateEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplateEntity.java index 8e9f07a2a8..553d686a27 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplateEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplateEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.TemplateDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a TemplateDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a TemplateDTO. */ @XmlRootElement(name = "templateEntity") public class TemplateEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplatesEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplatesEntity.java index 3ff5bc6d89..3a9f46d70b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplatesEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/TemplatesEntity.java @@ -24,9 +24,7 @@ import org.apache.nifi.web.api.dto.TemplateDTO; import org.apache.nifi.web.api.dto.util.TimeAdapter; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a set of TemplateDTOs. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a set of TemplateDTOs. */ @XmlRootElement(name = "templatesEntity") public class TemplatesEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserEntity.java index 963e853e50..71554dd83d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.UserDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a UserDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a UserDTO. */ @XmlRootElement(name = "userEntity") public class UserEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserGroupEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserGroupEntity.java index a6542c8f8b..35a88d5fe7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserGroupEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserGroupEntity.java @@ -20,9 +20,7 @@ import javax.xml.bind.annotation.XmlRootElement; import org.apache.nifi.web.api.dto.UserGroupDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a UserGroupDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a UserGroupDTO. */ @XmlRootElement(name = "userGroupEntity") public class UserGroupEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserSearchResultsEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserSearchResultsEntity.java index eece172b5f..fcdeee3a20 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserSearchResultsEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UserSearchResultsEntity.java @@ -22,9 +22,8 @@ import org.apache.nifi.web.api.dto.search.UserGroupSearchResultDTO; import org.apache.nifi.web.api.dto.search.UserSearchResultDTO; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to UserSearchResultDTOs and UserGroupSearchResultDTOs. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to UserSearchResultDTOs and + * UserGroupSearchResultDTOs. */ @XmlRootElement(name = "userSearchResultsEntity") public class UserSearchResultsEntity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UsersEntity.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UsersEntity.java index 180b6505c4..4acc7cb534 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UsersEntity.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-client-dto/src/main/java/org/apache/nifi/web/api/entity/UsersEntity.java @@ -24,9 +24,7 @@ import org.apache.nifi.web.api.dto.UserDTO; import org.apache.nifi.web.api.dto.util.TimeAdapter; /** - * A serialized representation of this class can be placed in the entity body of - * a request or response to or from the API. This particular entity holds a - * reference to a collection of UserDTO. + * A serialized representation of this class can be placed in the entity body of a request or response to or from the API. This particular entity holds a reference to a collection of UserDTO. */ @XmlRootElement(name = "usersEntity") public class UsersEntity extends Entity { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/pom.xml b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/pom.xml index d79b0ca6e9..b5cde8d692 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/pom.xml +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/pom.xml @@ -49,6 +49,14 @@ ${project.build.directory}/generated-sources/jaxb + + org.apache.maven.plugins + maven-checkstyle-plugin + + **/user/generated/*.java + + + diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/main/java/org/apache/nifi/authorization/FileAuthorizationProvider.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/main/java/org/apache/nifi/authorization/FileAuthorizationProvider.java index 5657369ff8..9c2cad5fdb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/main/java/org/apache/nifi/authorization/FileAuthorizationProvider.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/main/java/org/apache/nifi/authorization/FileAuthorizationProvider.java @@ -167,23 +167,10 @@ public class FileAuthorizationProvider implements AuthorityProvider { public void preDestruction() { } - /** - * Determines if this provider has a default role. - * - * @return - */ private boolean hasDefaultRoles() { return !defaultAuthorities.isEmpty(); } - /** - * Determines if the specified dn is known to this authority provider. When - * this provider is configured to have default role(s), all dn are - * considered to exist. - * - * @param dn - * @return True if he dn is known, false otherwise - */ @Override public boolean doesDnExist(String dn) throws AuthorityAccessException { if (hasDefaultRoles()) { @@ -194,21 +181,11 @@ public class FileAuthorizationProvider implements AuthorityProvider { return user != null; } - /** - * Loads the authorities for the specified user. If this provider is - * configured for default user role(s) and a non existent dn is specified, a - * new user will be automatically created with the default role(s). - * - * @param dn - * @return - * @throws UnknownIdentityException - * @throws AuthorityAccessException - */ @Override public synchronized Set getAuthorities(String dn) throws UnknownIdentityException, AuthorityAccessException { final Set authorities = EnumSet.noneOf(Authority.class); - // get the user + // get the user final User user = getUser(dn); // ensure the user was located @@ -234,16 +211,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { return authorities; } - /** - * Adds the specified authorities to the specified user. Regardless of - * whether this provider is configured for a default user role, when a non - * existent dn is specified, an UnknownIdentityException will be thrown. - * - * @param dn - * @param authorities - * @throws UnknownIdentityException - * @throws AuthorityAccessException - */ @Override public synchronized void setAuthorities(String dn, Set authorities) throws UnknownIdentityException, AuthorityAccessException { // get the user @@ -265,12 +232,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { } } - /** - * Adds the specified authorities to the specified user. - * - * @param user - * @param authorities - */ private void setUserAuthorities(final User user, final Set authorities) { // clear the existing rules user.getRole().clear(); @@ -286,15 +247,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { } } - /** - * Adds the specified user. If this provider is configured with default - * role(s) they will be added to the new user. - * - * @param dn - * @param group - * @throws UnknownIdentityException - * @throws AuthorityAccessException - */ @Override public synchronized void addUser(String dn, String group) throws IdentityAlreadyExistsException, AuthorityAccessException { final User user = getUser(dn); @@ -334,13 +286,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { } } - /** - * Gets the users for the specified authority. - * - * @param authority - * @return - * @throws AuthorityAccessException - */ @Override public synchronized Set getUsers(Authority authority) throws AuthorityAccessException { final Set userSet = new HashSet<>(); @@ -354,15 +299,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { return userSet; } - /** - * Removes the specified user. Regardless of whether this provider is - * configured for a default user role, when a non existent dn is specified, - * an UnknownIdentityException will be thrown. - * - * @param dn - * @throws UnknownIdentityException - * @throws AuthorityAccessException - */ @Override public synchronized void revokeUser(String dn) throws UnknownIdentityException, AuthorityAccessException { // get the user @@ -496,24 +432,12 @@ public class FileAuthorizationProvider implements AuthorityProvider { /** * Grants access to download content regardless of FlowFile attributes. - * - * @param dnChain - * @param attributes - * @return - * @throws UnknownIdentityException - * @throws AuthorityAccessException */ @Override public DownloadAuthorization authorizeDownload(List dnChain, Map attributes) throws UnknownIdentityException, AuthorityAccessException { return DownloadAuthorization.approved(); } - /** - * Locates the user with the specified DN. - * - * @param dn - * @return - */ private User getUser(String dn) throws UnknownIdentityException { // ensure the DN was specified if (dn == null) { @@ -532,13 +456,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { return desiredUser; } - /** - * Locates all users that are part of the specified group. - * - * @param group - * @return - * @throws UnknownIdentityException - */ private Collection getUserGroup(String group) throws UnknownIdentityException { // ensure the DN was specified if (group == null) { @@ -559,11 +476,6 @@ public class FileAuthorizationProvider implements AuthorityProvider { return userGroup; } - /** - * Saves the users file. - * - * @throws Exception - */ private void save() throws Exception { final Marshaller marshaller = JAXB_CONTEXT.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/test/java/org/apache/nifi/authorization/FileAuthorizationProviderTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/test/java/org/apache/nifi/authorization/FileAuthorizationProviderTest.java index d02d4d7919..74285003b4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/test/java/org/apache/nifi/authorization/FileAuthorizationProviderTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-file-authorization-provider/src/test/java/org/apache/nifi/authorization/FileAuthorizationProviderTest.java @@ -23,105 +23,106 @@ import org.apache.nifi.authorization.exception.ProviderCreationException; import org.apache.nifi.util.file.FileUtils; import org.apache.nifi.util.NiFiProperties; import org.junit.After; +import static org.junit.Assert.assertEquals; import org.junit.Before; import org.junit.Test; -import static org.mockito.Mockito.*; -import static org.junit.Assert.*; import org.junit.Ignore; import org.mockito.Mockito; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; @Ignore public class FileAuthorizationProviderTest { - + private FileAuthorizationProvider provider; - + private File primary; - + private File restore; - + private NiFiProperties mockProperties; - + private AuthorityProviderConfigurationContext mockConfigurationContext; - + @Before public void setup() throws IOException { - + primary = new File("target/primary/users.txt"); restore = new File("target/restore/users.txt"); - + System.out.println("absolute path: " + primary.getAbsolutePath()); - + mockProperties = mock(NiFiProperties.class); when(mockProperties.getRestoreDirectory()).thenReturn(restore.getParentFile()); - + mockConfigurationContext = mock(AuthorityProviderConfigurationContext.class); when(mockConfigurationContext.getProperty(Mockito.eq("Authorized Users File"))).thenReturn(primary.getPath()); - + provider = new FileAuthorizationProvider(); provider.setNiFiProperties(mockProperties); provider.initialize(null); - } - + } + @After public void cleanup() throws Exception { deleteFile(primary); deleteFile(restore); } - + private boolean deleteFile(final File file) { - if(file.isDirectory()) { + if (file.isDirectory()) { FileUtils.deleteFilesInDir(file, null, null, true, true); } return FileUtils.deleteFile(file, null, 10); } - + @Test public void testPostContructionWhenRestoreDoesNotExist() throws Exception { - + byte[] primaryBytes = "".getBytes(); FileOutputStream fos = new FileOutputStream(primary); fos.write(primaryBytes); fos.close(); - + provider.onConfigured(mockConfigurationContext); assertEquals(primary.length(), restore.length()); } - + @Test public void testPostContructionWhenPrimaryDoesNotExist() throws Exception { - + byte[] restoreBytes = "".getBytes(); FileOutputStream fos = new FileOutputStream(restore); fos.write(restoreBytes); fos.close(); - + provider.onConfigured(mockConfigurationContext); assertEquals(restore.length(), primary.length()); - + } - + @Test(expected = ProviderCreationException.class) public void testPostContructionWhenPrimaryDifferentThanRestore() throws Exception { - + byte[] primaryBytes = "".getBytes(); FileOutputStream fos = new FileOutputStream(primary); fos.write(primaryBytes); fos.close(); - + byte[] restoreBytes = "".getBytes(); fos = new FileOutputStream(restore); fos.write(restoreBytes); fos.close(); - + provider.onConfigured(mockConfigurationContext); } - + @Test public void testPostContructionWhenPrimaryAndBackupDoNotExist() throws Exception { - + provider.onConfigured(mockConfigurationContext); assertEquals(0, restore.length()); assertEquals(restore.length(), primary.length()); } - + } diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/Event.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/Event.java index 6bc5d6cc35..aae93ef205 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/Event.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/Event.java @@ -20,8 +20,7 @@ import java.util.Date; import org.apache.commons.lang3.StringUtils; /** - * Events describe the occurrence of something noteworthy. They record the - * event's source, a timestamp, a description, and a category. + * Events describe the occurrence of something noteworthy. They record the event's source, a timestamp, a description, and a category. * * @author unattributed * @@ -45,8 +44,7 @@ public class Event { private final String message; /** - * Creates an event with the current time as the timestamp and a category of - * "INFO". + * Creates an event with the current time as the timestamp and a category of "INFO". * * @param source the source * @param message the description diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/EventManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/EventManager.java index f9dfb00fe1..3c9d441fa1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/EventManager.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/EventManager.java @@ -19,9 +19,8 @@ package org.apache.nifi.cluster.event; import java.util.List; /** - * Manages an ordered list of events. The event history size dictates the total - * number of events to manage for a given source at a given time. When the size - * is exceeded, the oldest event for that source is evicted. + * Manages an ordered list of events. The event history size dictates the total number of events to manage for a given source at a given time. When the size is exceeded, the oldest event for that + * source is evicted. * * @author unattributed */ @@ -35,8 +34,7 @@ public interface EventManager { void addEvent(Event event); /** - * Returns a list of events for a given source sorted by the event's - * timestamp where the most recent event is first in the list. + * Returns a list of events for a given source sorted by the event's timestamp where the most recent event is first in the list. * * @param eventSource the source * diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/impl/EventManagerImpl.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/impl/EventManagerImpl.java index 7fadc78ffa..411d6c3ffc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/impl/EventManagerImpl.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/event/impl/EventManagerImpl.java @@ -36,8 +36,7 @@ import org.apache.nifi.cluster.event.EventManager; public class EventManagerImpl implements EventManager { /** - * associates the source ID with an ordered queue of events, ordered by most - * recent event + * associates the source ID with an ordered queue of events, ordered by most recent event */ private final Map> eventsMap = new HashMap<>(); @@ -49,8 +48,7 @@ public class EventManagerImpl implements EventManager { /** * Creates an instance. * - * @param eventHistorySize the number of events to manage for a given - * source. Value must be positive. + * @param eventHistorySize the number of events to manage for a given source. Value must be positive. */ public EventManagerImpl(final int eventHistorySize) { if (eventHistorySize <= 0) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/ClusterNodeFirewall.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/ClusterNodeFirewall.java index 08d21a5660..b6713d1b06 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/ClusterNodeFirewall.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/ClusterNodeFirewall.java @@ -17,14 +17,12 @@ package org.apache.nifi.cluster.firewall; /** - * Defines the interface for restricting external client connections to a set of - * hosts or IPs. + * Defines the interface for restricting external client connections to a set of hosts or IPs. */ public interface ClusterNodeFirewall { /** - * Returns true if the given host or IP is permissible through the firewall; - * false otherwise. + * Returns true if the given host or IP is permissible through the firewall; false otherwise. * * If an IP is given, then it must be formatted in dotted decimal notation. * diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java index 521962918d..5859e1bd49 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewall.java @@ -32,11 +32,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * 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: + * 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: * * * # hash character is a comment delimiter @@ -46,12 +43,9 @@ import org.slf4j.LoggerFactory; * 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 construction time. + * 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 + * construction time. */ public class FileBasedClusterNodeFirewall implements ClusterNodeFirewall { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowDao.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowDao.java index 9ee5aa80fb..c5134e3a54 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowDao.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowDao.java @@ -42,8 +42,7 @@ public interface DataFlowDao { void saveDataFlow(ClusterDataFlow dataFlow) throws DaoException; /** - * Sets the state of the dataflow. If the dataflow does not exist, then an - * exception is thrown. + * Sets the state of the dataflow. If the dataflow does not exist, then an exception is thrown. * * @param flowState the state of the dataflow * diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowManagementService.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowManagementService.java index f3545075ab..8a2af5430f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowManagementService.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/DataFlowManagementService.java @@ -21,13 +21,9 @@ import java.util.Set; import org.apache.nifi.cluster.protocol.NodeIdentifier; /** - * A service for managing the cluster's flow. The service will attempt to keep - * the cluster's dataflow current while respecting the value of the configured - * retrieval delay. + * A service for managing the cluster's flow. The service will attempt to keep the cluster's dataflow current while respecting the value of the configured retrieval delay. * - * The eligible retrieval time is reset with the configured delay every time the - * flow state is set to STALE. If the state is set to UNKNOWN or CURRENT, then - * the flow will not be retrieved. + * The eligible retrieval time is reset with the configured delay every time the flow state is set to STALE. If the state is set to UNKNOWN or CURRENT, then the flow will not be retrieved. * * Clients must call start() and stop() to initialize and stop the instance. * @@ -35,8 +31,7 @@ import org.apache.nifi.cluster.protocol.NodeIdentifier; public interface DataFlowManagementService { /** - * Starts the instance. Start may only be called if the instance is not - * running. + * Starts the instance. Start may only be called if the instance is not running. */ void start(); @@ -67,8 +62,7 @@ public interface DataFlowManagementService { void updatePrimaryNode(NodeIdentifier nodeId) throws DaoException; /** - * Updates the dataflow with the given serialized form of the Controller - * Services that are to exist on the NCM. + * Updates the dataflow with the given serialized form of the Controller Services that are to exist on the NCM. * * @param serializedControllerServices services * @throws DaoException ex @@ -76,8 +70,7 @@ public interface DataFlowManagementService { void updateControllerServices(byte[] serializedControllerServices) throws DaoException; /** - * Updates the dataflow with the given serialized form of Reporting Tasks - * that are to exist on the NCM. + * Updates the dataflow with the given serialized form of Reporting Tasks that are to exist on the NCM. * * @param serializedReportingTasks tasks * @throws DaoException ex @@ -111,11 +104,9 @@ public interface DataFlowManagementService { void setNodeIds(Set nodeIds); /** - * Returns the set of node identifiers the service is using to retrieve the - * flow. + * Returns the set of node identifiers the service is using to retrieve the flow. * - * @return the set of node identifiers the service is using to retrieve the - * flow. + * @return the set of node identifiers the service is using to retrieve the flow. */ Set getNodeIds(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/StaleFlowException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/StaleFlowException.java index ce5a08b50c..169712a737 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/StaleFlowException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/StaleFlowException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.flow; /** - * Represents the exceptional case when a caller is requesting the current flow, - * but a current flow is not available. + * Represents the exceptional case when a caller is requesting the current flow, but a current flow is not available. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowDaoImpl.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowDaoImpl.java index e2690f759e..e7aafb7aa9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowDaoImpl.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowDaoImpl.java @@ -67,34 +67,22 @@ import org.w3c.dom.Document; import org.w3c.dom.Element; /** - * Implements the FlowDao interface. The implementation tracks the state of the - * dataflow by annotating the filename of the flow state file. Specifically, the - * implementation correlates PersistedFlowState states to filename extensions. - * The correlation is as follows: + * Implements the FlowDao interface. The implementation tracks the state of the dataflow by annotating the filename of the flow state file. Specifically, the implementation correlates + * PersistedFlowState states to filename extensions. The correlation is as follows: *

- * Whenever the flow state changes, the flow state file's name is updated to - * denote its state. + * Whenever the flow state changes, the flow state file's name is updated to denote its state. * - * The implementation also provides for a restore directory that may be - * configured for higher availability. At instance creation, if the primary or - * restore directories have multiple flow state files, an exception is thrown. - * If the primary directory has a current flow state file, but the restore - * directory does not, then the primary flow state file is copied to the restore - * directory. If the restore directory has a current flow state file, but the - * primary directory does not, then the restore flow state file is copied to the - * primary directory. If both the primary and restore directories have a current - * flow state file and the files are different, then an exception is thrown. + * The implementation also provides for a restore directory that may be configured for higher availability. At instance creation, if the primary or restore directories have multiple flow state files, + * an exception is thrown. If the primary directory has a current flow state file, but the restore directory does not, then the primary flow state file is copied to the restore directory. If the + * restore directory has a current flow state file, but the primary directory does not, then the restore flow state file is copied to the primary directory. If both the primary and restore directories + * have a current flow state file and the files are different, then an exception is thrown. * - * When the flow state file is saved, it is always saved first to the restore - * directory followed by a save to the primary directory. When the flow state - * file is loaded, a check is made to verify that the primary and restore flow - * state files are both current. If either is not current, then an exception is - * thrown. The primary flow state file is always read when the load method is - * called. + * When the flow state file is saved, it is always saved first to the restore directory followed by a save to the primary directory. When the flow state file is loaded, a check is made to verify that + * the primary and restore flow state files are both current. If either is not current, then an exception is thrown. The primary flow state file is always read when the load method is called. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowManagementServiceImpl.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowManagementServiceImpl.java index 4fa6504fa2..5a7c1a945d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowManagementServiceImpl.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/flow/impl/DataFlowManagementServiceImpl.java @@ -45,19 +45,13 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Implements FlowManagementService interface. The service tries to keep the - * cluster's flow current with regards to the available nodes. + * Implements FlowManagementService interface. The service tries to keep the cluster's flow current with regards to the available nodes. * - * The instance may be configured with a retrieval delay, which will reduce the - * number of retrievals performed by the service at the expense of increasing - * the chances that the service will not be able to provide a current flow to - * the caller. + * The instance may be configured with a retrieval delay, which will reduce the number of retrievals performed by the service at the expense of increasing the chances that the service will not be able + * to provide a current flow to the caller. * - * By default, the service will try to update the flow as quickly as possible. - * Configuring a delay enables a less aggressive retrieval strategy. - * Specifically, the eligible retrieval time is reset every time the flow state - * is set to STALE. If the state is set to UNKNOWN or CURRENT, then the flow - * will not be retrieved. + * By default, the service will try to update the flow as quickly as possible. Configuring a delay enables a less aggressive retrieval strategy. Specifically, the eligible retrieval time is reset + * every time the flow state is set to STALE. If the state is set to UNKNOWN or CURRENT, then the flow will not be retrieved. * * @author unattributed */ @@ -298,8 +292,7 @@ public class DataFlowManagementServiceImpl implements DataFlowManagementService } /** - * A timer task for issuing FlowRequestMessage messages to nodes to retrieve - * an updated flow. + * A timer task for issuing FlowRequestMessage messages to nodes to retrieve an updated flow. */ private class FlowRetrieverTimerTask extends TimerTask { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/ClusterManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/ClusterManager.java index be52e0f106..be57562d59 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/ClusterManager.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/ClusterManager.java @@ -39,24 +39,15 @@ import org.apache.nifi.remote.cluster.NodeInformant; import org.apache.nifi.reporting.BulletinRepository; /** - * Defines the interface for a ClusterManager. The cluster manager is a - * threadsafe centralized manager for a cluster. Members of a cluster are nodes. - * A member becomes a node by issuing a connection request to the manager. The - * manager maintains the set of nodes. Nodes may be disconnected, reconnected, - * and deleted. + * Defines the interface for a ClusterManager. The cluster manager is a threadsafe centralized manager for a cluster. Members of a cluster are nodes. A member becomes a node by issuing a connection + * request to the manager. The manager maintains the set of nodes. Nodes may be disconnected, reconnected, and deleted. * - * Nodes are responsible for sending heartbeats to the manager to indicate their - * liveliness. A manager may disconnect a node if it does not receive a - * heartbeat within a configurable time period. A cluster manager instance may - * be configured with how often to monitor received heartbeats - * (getHeartbeatMonitoringIntervalSeconds()) and the maximum time that may - * elapse between node heartbeats before disconnecting the node - * (getMaxHeartbeatGapSeconds()). + * Nodes are responsible for sending heartbeats to the manager to indicate their liveliness. A manager may disconnect a node if it does not receive a heartbeat within a configurable time period. A + * cluster manager instance may be configured with how often to monitor received heartbeats (getHeartbeatMonitoringIntervalSeconds()) and the maximum time that may elapse between node heartbeats + * before disconnecting the node (getMaxHeartbeatGapSeconds()). * - * Since only a single node may execute isolated processors, the cluster manager - * maintains the notion of a primary node. The primary node is chosen at cluster - * startup and retains the role until a user requests a different node to be the - * primary node. + * Since only a single node may execute isolated processors, the cluster manager maintains the notion of a primary node. The primary node is chosen at cluster startup and retains the role until a user + * requests a different node to be the primary node. * * @author unattributed */ @@ -78,8 +69,7 @@ public interface ClusterManager extends NodeInformant { /** * @param nodeId node identifier - * @return returns the node with the given identifier or null if node does - * not exist + * @return returns the node with the given identifier or null if node does not exist */ Node getNode(String nodeId); @@ -90,17 +80,13 @@ public interface ClusterManager extends NodeInformant { Set getNodeIds(Status... statuses); /** - * Deletes the node with the given node identifier. If the given node is the - * primary node, then a subsequent request may be made to the manager to set - * a new primary node. + * Deletes the node with the given node identifier. If the given node is the primary node, then a subsequent request may be made to the manager to set a new primary node. * * @param nodeId the node identifier - * @param userDn the Distinguished Name of the user requesting the node be - * deleted from the cluster + * @param userDn the Distinguished Name of the user requesting the node be deleted from the cluster * * @throws UnknownNodeException if the node does not exist - * @throws IllegalNodeDeletionException if the node is not in a disconnected - * state + * @throws IllegalNodeDeletionException if the node is not in a disconnected state */ void deleteNode(String nodeId, String userDn) throws UnknownNodeException, IllegalNodeDeletionException; @@ -114,14 +100,11 @@ public interface ClusterManager extends NodeInformant { ConnectionResponse requestConnection(ConnectionRequest request); /** - * Services reconnection requests for a given node. If the node indicates - * reconnection failure, then the node will be set to disconnected. - * Otherwise, a reconnection request will be sent to the node, initiating - * the connection handshake. + * Services reconnection requests for a given node. If the node indicates reconnection failure, then the node will be set to disconnected. Otherwise, a reconnection request will be sent to the + * node, initiating the connection handshake. * * @param nodeId a node identifier - * @param userDn the Distinguished Name of the user requesting the - * reconnection + * @param userDn the Distinguished Name of the user requesting the reconnection * * @throws UnknownNodeException if the node does not exist * @throws IllegalNodeReconnectionException if the node is not disconnected @@ -132,13 +115,10 @@ public interface ClusterManager extends NodeInformant { * Requests the node with the given identifier be disconnected. * * @param nodeId the node identifier - * @param userDn the Distinguished Name of the user requesting the - * disconnection + * @param userDn the Distinguished Name of the user requesting the disconnection * * @throws UnknownNodeException if the node does not exist - * @throws IllegalNodeDisconnectionException if the node cannot be - * disconnected due to the cluster's state (e.g., node is last connected - * node or node is primary) + * @throws IllegalNodeDisconnectionException if the node cannot be disconnected due to the cluster's state (e.g., node is last connected node or node is primary) * @throws UnknownNodeException if the node does not exist * @throws IllegalNodeDisconnectionException if the node is not disconnected * @throws NodeDisconnectionException if the disconnection failed @@ -146,50 +126,37 @@ public interface ClusterManager extends NodeInformant { void requestDisconnection(String nodeId, String userDn) throws UnknownNodeException, IllegalNodeDisconnectionException, NodeDisconnectionException; /** - * @return the time in seconds to wait between successive executions of - * heartbeat monitoring + * @return the time in seconds to wait between successive executions of heartbeat monitoring */ int getHeartbeatMonitoringIntervalSeconds(); /** - * @return the maximum time in seconds that is allowed between successive - * heartbeats of a node before disconnecting the node + * @return the maximum time in seconds that is allowed between successive heartbeats of a node before disconnecting the node */ int getMaxHeartbeatGapSeconds(); /** - * Returns a list of node events for the node with the given identifier. The - * events will be returned in order of most recent to least recent according - * to the creation date of the event. + * Returns a list of node events for the node with the given identifier. The events will be returned in order of most recent to least recent according to the creation date of the event. * * @param nodeId the node identifier * - * @return the list of events or an empty list if no node exists with the - * given identifier + * @return the list of events or an empty list if no node exists with the given identifier */ List getNodeEvents(final String nodeId); /** - * Revokes the primary role from the current primary node and assigns the - * primary role to given given node ID. + * Revokes the primary role from the current primary node and assigns the primary role to given given node ID. * - * If role revocation fails, then the current primary node is set to - * disconnected while retaining the primary role and no role assignment is - * performed. + * If role revocation fails, then the current primary node is set to disconnected while retaining the primary role and no role assignment is performed. * - * If role assignment fails, then the given node is set to disconnected and - * is given the primary role. + * If role assignment fails, then the given node is set to disconnected and is given the primary role. * * @param nodeId the node identifier - * @param userDn the Distinguished Name of the user requesting that the - * Primary Node be assigned + * @param userDn the Distinguished Name of the user requesting that the Primary Node be assigned * - * @throws UnknownNodeException if the node with the given identifier does - * not exist - * @throws IneligiblePrimaryNodeException if the node with the given - * identifier is not eligible to be the primary node - * @throws PrimaryRoleAssignmentException if the cluster was unable to - * change the primary role to the requested node + * @throws UnknownNodeException if the node with the given identifier does not exist + * @throws IneligiblePrimaryNodeException if the node with the given identifier is not eligible to be the primary node + * @throws PrimaryRoleAssignmentException if the cluster was unable to change the primary role to the requested node */ void setPrimaryNode(String nodeId, String userDn) throws UnknownNodeException, IneligiblePrimaryNodeException, PrimaryRoleAssignmentException; @@ -204,20 +171,13 @@ public interface ClusterManager extends NodeInformant { BulletinRepository getBulletinRepository(); /** - * Returns a {@link ProcessGroupStatus} that represents the status of all - * nodes with the given {@link Status}es for the given ProcessGroup id, or - * null if no nodes exist with the given statuses - * - * @param groupId - * @return + * @param groupId groupId + * @return a {@link ProcessGroupStatus} that represents the status of all nodes with the given {@link Status}es for the given ProcessGroup id, or null if no nodes exist with the given statuses */ ProcessGroupStatus getProcessGroupStatus(String groupId); /** - * Returns a merged representation of the System Diagnostics for all nodes - * in the cluster - * - * @return + * @return a merged representation of the System Diagnostics for all nodes in the cluster */ SystemDiagnostics getSystemDiagnostics(); } diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpClusterManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpClusterManager.java index 2cf5812631..97ae0706bc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpClusterManager.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpClusterManager.java @@ -30,73 +30,53 @@ import java.util.Map; import java.util.Set; /** - * Extends the ClusterManager interface to define how requests issued to the - * cluster manager are federated to the nodes. Specifically, the HTTP protocol - * is used for communicating requests to the cluster manager and to the nodes. + * Extends the ClusterManager interface to define how requests issued to the cluster manager are federated to the nodes. Specifically, the HTTP protocol is used for communicating requests to the + * cluster manager and to the nodes. * * @author unattributed */ public interface HttpClusterManager extends ClusterManager { /** - * Federates the HTTP request to all connected nodes in the cluster. The - * given URI's host and port will not be used and instead will be adjusted - * for each node's host and port. The node URIs are guaranteed to be - * constructed before issuing any requests, so if a UriConstructionException - * is thrown, then it is guaranteed that no request was issued. + * Federates the HTTP request to all connected nodes in the cluster. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are + * guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued. * * @param method the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD) - * @param uri the base request URI (up to, but not including, the query - * string) + * @param uri the base request URI (up to, but not including, the query string) * @param parameters the request parameters * @param headers the request headers * * @return the client response * - * @throws NoConnectedNodesException if no nodes are connected as results of - * the request + * @throws NoConnectedNodesException if no nodes are connected as results of the request * @throws NoResponseFromNodesException if no response could be obtained - * @throws UriConstructionException if there was an issue constructing the - * URIs tailored for each individual node - * @throws ConnectingNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is connecting to the cluster - * @throws DisconnectedNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is disconnected from the cluster - * @throws SafeModeMutableRequestException if the request was a PUT, POST, - * DELETE and a the cluster is in safe mode + * @throws UriConstructionException if there was an issue constructing the URIs tailored for each individual node + * @throws ConnectingNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is connecting to the cluster + * @throws DisconnectedNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is disconnected from the cluster + * @throws SafeModeMutableRequestException if the request was a PUT, POST, DELETE and a the cluster is in safe mode */ NodeResponse applyRequest(String method, URI uri, Map> parameters, Map headers) throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException; /** - * Federates the HTTP request to the nodes specified. The given URI's host - * and port will not be used and instead will be adjusted for each node's - * host and port. The node URIs are guaranteed to be constructed before - * issuing any requests, so if a UriConstructionException is thrown, then it - * is guaranteed that no request was issued. + * Federates the HTTP request to the nodes specified. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be + * constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued. * * @param method the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD) - * @param uri the base request URI (up to, but not including, the query - * string) + * @param uri the base request URI (up to, but not including, the query string) * @param parameters the request parameters * @param headers the request headers - * @param nodeIdentifiers the NodeIdentifier for each node that the request - * should be replaced to + * @param nodeIdentifiers the NodeIdentifier for each node that the request should be replaced to * * @return the client response * - * @throws NoConnectedNodesException if no nodes are connected as results of - * the request + * @throws NoConnectedNodesException if no nodes are connected as results of the request * @throws NoResponseFromNodesException if no response could be obtained - * @throws UriConstructionException if there was an issue constructing the - * URIs tailored for each individual node - * @throws ConnectingNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is connecting to the cluster - * @throws DisconnectedNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is disconnected from the cluster - * @throws SafeModeMutableRequestException if the request was a PUT, POST, - * DELETE and a the cluster is in safe mode + * @throws UriConstructionException if there was an issue constructing the URIs tailored for each individual node + * @throws ConnectingNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is connecting to the cluster + * @throws DisconnectedNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is disconnected from the cluster + * @throws SafeModeMutableRequestException if the request was a PUT, POST, DELETE and a the cluster is in safe mode */ NodeResponse applyRequest(String method, URI uri, Map> parameters, Map headers, Set nodeIdentifiers) @@ -104,64 +84,45 @@ public interface HttpClusterManager extends ClusterManager { DisconnectedNodeMutableRequestException, SafeModeMutableRequestException; /** - * Federates the HTTP request to all connected nodes in the cluster. The - * given URI's host and port will not be used and instead will be adjusted - * for each node's host and port. The node URIs are guaranteed to be - * constructed before issuing any requests, so if a UriConstructionException - * is thrown, then it is guaranteed that no request was issued. + * Federates the HTTP request to all connected nodes in the cluster. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are + * guaranteed to be constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued. * * @param method the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD) - * @param uri the base request URI (up to, but not including, the query - * string) + * @param uri the base request URI (up to, but not including, the query string) * @param entity the HTTP request entity * @param headers the request headers * * @return the client response * - * @throws NoConnectedNodesException if no nodes are connected as results of - * the request + * @throws NoConnectedNodesException if no nodes are connected as results of the request * @throws NoResponseFromNodesException if no response could be obtained - * @throws UriConstructionException if there was an issue constructing the - * URIs tailored for each individual node - * @throws ConnectingNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is connecting to the cluster - * @throws DisconnectedNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is disconnected from the cluster - * @throws SafeModeMutableRequestException if the request was a PUT, POST, - * DELETE and a the cluster is in safe mode + * @throws UriConstructionException if there was an issue constructing the URIs tailored for each individual node + * @throws ConnectingNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is connecting to the cluster + * @throws DisconnectedNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is disconnected from the cluster + * @throws SafeModeMutableRequestException if the request was a PUT, POST, DELETE and a the cluster is in safe mode */ NodeResponse applyRequest(String method, URI uri, Object entity, Map headers) throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException; /** - * Federates the HTTP request to the nodes specified. The given URI's host - * and port will not be used and instead will be adjusted for each node's - * host and port. The node URIs are guaranteed to be constructed before - * issuing any requests, so if a UriConstructionException is thrown, then it - * is guaranteed that no request was issued. + * Federates the HTTP request to the nodes specified. The given URI's host and port will not be used and instead will be adjusted for each node's host and port. The node URIs are guaranteed to be + * constructed before issuing any requests, so if a UriConstructionException is thrown, then it is guaranteed that no request was issued. * * @param method the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD) - * @param uri the base request URI (up to, but not including, the query - * string) + * @param uri the base request URI (up to, but not including, the query string) * @param entity the HTTP request entity * @param headers the request headers - * @param nodeIdentifiers the NodeIdentifier for each node that the request - * should be replaced to + * @param nodeIdentifiers the NodeIdentifier for each node that the request should be replaced to * * @return the client response * - * @throws NoConnectedNodesException if no nodes are connected as results of - * the request + * @throws NoConnectedNodesException if no nodes are connected as results of the request * @throws NoResponseFromNodesException if no response could be obtained - * @throws UriConstructionException if there was an issue constructing the - * URIs tailored for each individual node - * @throws ConnectingNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is connecting to the cluster - * @throws DisconnectedNodeMutableRequestException if the request was a PUT, - * POST, DELETE and a node is disconnected from the cluster - * @throws SafeModeMutableRequestException if the request was a PUT, POST, - * DELETE and a the cluster is in safe mode + * @throws UriConstructionException if there was an issue constructing the URIs tailored for each individual node + * @throws ConnectingNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is connecting to the cluster + * @throws DisconnectedNodeMutableRequestException if the request was a PUT, POST, DELETE and a node is disconnected from the cluster + * @throws SafeModeMutableRequestException if the request was a PUT, POST, DELETE and a the cluster is in safe mode */ NodeResponse applyRequest(String method, URI uri, Object entity, Map headers, Set nodeIdentifiers) throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpRequestReplicator.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpRequestReplicator.java index fb57622ddf..2b91dbdf8d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpRequestReplicator.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpRequestReplicator.java @@ -24,25 +24,21 @@ import java.util.Set; import org.apache.nifi.cluster.protocol.NodeIdentifier; /** - * A service for managing the replication of requests to nodes. It is up to the - * implementing class to decide if requests are sent concurrently or serially. + * A service for managing the replication of requests to nodes. It is up to the implementing class to decide if requests are sent concurrently or serially. * - * Clients must call start() and stop() to initialize and shutdown the instance. - * The instance must be started before issuing any replication requests. + * Clients must call start() and stop() to initialize and shutdown the instance. The instance must be started before issuing any replication requests. * * @author unattributed */ public interface HttpRequestReplicator { /** - * Starts the instance for replicating requests. Start may only be called if - * the instance is not running. + * Starts the instance for replicating requests. Start may only be called if the instance is not running. */ void start(); /** - * Stops the instance from replicating requests. Stop may only be called if - * the instance is running. + * Stops the instance from replicating requests. Stop may only be called if the instance is running. */ void stop(); @@ -52,47 +48,36 @@ public interface HttpRequestReplicator { boolean isRunning(); /** - * Requests are sent to each node in the cluster. If the request results in - * an exception, then the NodeResourceResponse will contain the exception. + * Requests are sent to each node in the cluster. If the request results in an exception, then the NodeResourceResponse will contain the exception. * - * HTTP DELETE and OPTIONS methods must supply an empty parameters map or - * else and IllegalArgumentException is thrown. + * HTTP DELETE and OPTIONS methods must supply an empty parameters map or else and IllegalArgumentException is thrown. * * @param nodeIds the node identifiers - * @param method the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD, - * OPTIONS) - * @param uri the base request URI (up to, but not including, the query - * string) + * @param method the HTTP method (e.g., GET, POST, PUT, DELETE, HEAD, OPTIONS) + * @param uri the base request URI (up to, but not including, the query string) * @param parameters any request parameters * @param headers any HTTP headers * * @return the set of node responses * - * @throws UriConstructionException if a request for a node failed to be - * constructed from the given prototype URI. If thrown, it is guaranteed - * that no request was sent. + * @throws UriConstructionException if a request for a node failed to be constructed from the given prototype URI. If thrown, it is guaranteed that no request was sent. */ Set replicate(Set nodeIds, String method, URI uri, Map> parameters, Map headers) throws UriConstructionException; /** - * Requests are sent to each node in the cluster. If the request results in - * an exception, then the NodeResourceResponse will contain the exception. + * Requests are sent to each node in the cluster. If the request results in an exception, then the NodeResourceResponse will contain the exception. * - * HTTP DELETE, GET, HEAD, and OPTIONS methods will throw an - * IllegalArgumentException if used. + * HTTP DELETE, GET, HEAD, and OPTIONS methods will throw an IllegalArgumentException if used. * * @param nodeIds the node identifiers * @param method the HTTP method (e.g., POST, PUT) - * @param uri the base request URI (up to, but not including, the query - * string) + * @param uri the base request URI (up to, but not including, the query string) * @param entity an entity * @param headers any HTTP headers * * @return the set of node responses * - * @throws UriConstructionException if a request for a node failed to be - * constructed from the given prototype URI. If thrown, it is guaranteed - * that no request was sent. + * @throws UriConstructionException if a request for a node failed to be constructed from the given prototype URI. If thrown, it is guaranteed that no request was sent. */ Set replicate(Set nodeIds, String method, URI uri, Object entity, Map headers) throws UriConstructionException; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpResponseMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpResponseMapper.java index 843a6667db..64c9d757ee 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpResponseMapper.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/HttpResponseMapper.java @@ -29,8 +29,7 @@ import org.apache.nifi.cluster.node.Node.Status; public interface HttpResponseMapper { /** - * Maps a HTTP response to a node response and the corresponding node - * status. + * Maps a HTTP response to a node response and the corresponding node status. * * @param requestURI the original request URI * @param nodeResponses a set of node resource responses diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/NodeResponse.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/NodeResponse.java index 958d60069b..ae113f4a1e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/NodeResponse.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/NodeResponse.java @@ -40,23 +40,15 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Encapsulates a node's response in regards to receiving a external API - * request. + * Encapsulates a node's response in regards to receiving a external API request. * - * Both the ClientResponse and (server) Response may be obtained from this - * instance. The ClientResponse is stored as it is received from the node. This - * includes the entity input stream. The Response is constructed on demand when - * mapping a ClientResponse to the Response. The ClientResponse to Response - * mapping includes copying the ClientResponse's input stream to the Response. - * Therefore, the getResponse() method should not be called more than once. - * Furthermore, the method should not be called if the caller has already read - * the ClientResponse's input stream. + * Both the ClientResponse and (server) Response may be obtained from this instance. The ClientResponse is stored as it is received from the node. This includes the entity input stream. The Response + * is constructed on demand when mapping a ClientResponse to the Response. The ClientResponse to Response mapping includes copying the ClientResponse's input stream to the Response. Therefore, the + * getResponse() method should not be called more than once. Furthermore, the method should not be called if the caller has already read the ClientResponse's input stream. * - * If a ClientResponse was unable to be created, then a NodeResponse will store - * the Throwable, which may be obtained by calling getThrowable(). + * If a ClientResponse was unable to be created, then a NodeResponse will store the Throwable, which may be obtained by calling getThrowable(). * - * This class overrides hashCode and equals and considers two instances to be - * equal if they have the equal NodeIdentifiers. + * This class overrides hashCode and equals and considers two instances to be equal if they have the equal NodeIdentifiers. * * @author unattributed */ @@ -145,14 +137,14 @@ public class NodeResponse { public int getStatus() { if (hasThrowable()) { /* - * since there is a throwable, there is no client input stream to + * since there is a throwable, there is no client input stream to * worry about maintaining, so we can call getResponse() method */ return getResponse().getStatus(); } else { /* * use client response's status instead of calling getResponse().getStatus() - * so that we don't read the client's input stream as part of creating + * so that we don't read the client's input stream as part of creating * the response in the getResponse() method */ return clientResponse.getStatus(); @@ -160,9 +152,7 @@ public class NodeResponse { } /** - * Returns true if the response status is 2xx, false otherwise. - * - * @return + * @return true if the response status is 2xx, false otherwise. */ public boolean is2xx() { final int statusCode = getStatus(); @@ -170,9 +160,7 @@ public class NodeResponse { } /** - * Returns true if the response status is 5xx, false otherwise. - * - * @return + * @return true if the response status is 5xx, false otherwise. */ public boolean is5xx() { final int statusCode = getStatus(); @@ -180,8 +168,7 @@ public class NodeResponse { } /** - * Returns null if hasThrowable() is true; otherwise the client's response - * is returned. + * Returns null if hasThrowable() is true; otherwise the client's response is returned. * * The ClientResponse's input stream can only be read once. * @@ -192,24 +179,18 @@ public class NodeResponse { } /** - * If this node response has been merged returns the updated entity, - * otherwise null. Also returns null if hasThrowable() is true. The intent - * of this method is to support getting the response entity when it was - * already consumed during the merge operation. In this case the client - * response rom getClientResponse() will not support a getEntity(...) or - * getEntityInputStream() call. + * If this node response has been merged returns the updated entity, otherwise null. Also returns null if hasThrowable() is true. The intent of this method is to support getting the response + * entity when it was already consumed during the merge operation. In this case the client response rom getClientResponse() will not support a getEntity(...) or getEntityInputStream() call. * - * @return + * @return If this node response has been merged returns the updated entity, otherwise null. Also returns null if hasThrowable() is true */ public Entity getUpdatedEntity() { return updatedEntity; } /** - * Creates a Response by mapping the ClientResponse values to it. Since the - * ClientResponse's input stream can only be read once, this method should - * only be called once. Furthermore, the caller should not have already read - * the ClientResponse's input stream. + * Creates a Response by mapping the ClientResponse values to it. Since the ClientResponse's input stream can only be read once, this method should only be called once. Furthermore, the caller + * should not have already read the ClientResponse's input stream. * * @return the response */ @@ -232,11 +213,9 @@ public class NodeResponse { } /** - * Returns true if a throwable was thrown and a response was not able to be - * created; false otherwise. + * Returns true if a throwable was thrown and a response was not able to be created; false otherwise. * - * @return true if a throwable was thrown and a response was not able to be - * created; false otherwise + * @return true if a throwable was thrown and a response was not able to be created; false otherwise */ public boolean hasThrowable() { return getThrowable() != null; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/ConnectingNodeMutableRequestException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/ConnectingNodeMutableRequestException.java index 365b5f0b48..964cdfcf52 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/ConnectingNodeMutableRequestException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/ConnectingNodeMutableRequestException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a HTTP request that may change a node's - * dataflow is to be replicated while a node is connecting to the cluster. + * Represents the exceptional case when a HTTP request that may change a node's dataflow is to be replicated while a node is connecting to the cluster. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/DisconnectedNodeMutableRequestException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/DisconnectedNodeMutableRequestException.java index 412a555e32..e0f343397a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/DisconnectedNodeMutableRequestException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/DisconnectedNodeMutableRequestException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a HTTP request that may change a node's - * dataflow is to be replicated while one or more nodes are disconnected. + * Represents the exceptional case when a HTTP request that may change a node's dataflow is to be replicated while one or more nodes are disconnected. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalClusterStateException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalClusterStateException.java index 6c4e67087f..b3d2826b28 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalClusterStateException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalClusterStateException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Signals that an operation to be performed on a cluster has been invoked at an - * illegal or inappropriate time. + * Signals that an operation to be performed on a cluster has been invoked at an illegal or inappropriate time. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDeletionException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDeletionException.java index adef62a823..3e1c031e09 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDeletionException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDeletionException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a deletion request is issued to a node - * that cannot be deleted (e.g., the node is not disconnected). + * Represents the exceptional case when a deletion request is issued to a node that cannot be deleted (e.g., the node is not disconnected). * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDisconnectionException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDisconnectionException.java index 7e61b24f76..71fe0448ad 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDisconnectionException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeDisconnectionException.java @@ -17,9 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a disconnection request is issued to a - * node that cannot be disconnected (e.g., last node in cluster, node is primary - * node). + * Represents the exceptional case when a disconnection request is issued to a node that cannot be disconnected (e.g., last node in cluster, node is primary node). * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeReconnectionException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeReconnectionException.java index 96c76bcb35..63242d0c33 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeReconnectionException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IllegalNodeReconnectionException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a reconnection request is issued to a - * node that cannot be reconnected (e.g., the node is not disconnected). + * Represents the exceptional case when a reconnection request is issued to a node that cannot be reconnected (e.g., the node is not disconnected). * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IneligiblePrimaryNodeException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IneligiblePrimaryNodeException.java index 4b0097a4b8..a2240782c7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IneligiblePrimaryNodeException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/IneligiblePrimaryNodeException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when the primary role cannot be assigned to a - * node because the node is ineligible for the role. + * Represents the exceptional case when the primary role cannot be assigned to a node because the node is ineligible for the role. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/MutableRequestException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/MutableRequestException.java index d1605874ba..2c0ba5fddb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/MutableRequestException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/MutableRequestException.java @@ -17,9 +17,8 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a HTTP request that may change a node's - * state is to be replicated while the cluster or connected nodes are unable to - * change their state (e.g., a new node is connecting to the cluster). + * Represents the exceptional case when a HTTP request that may change a node's state is to be replicated while the cluster or connected nodes are unable to change their state (e.g., a new node is + * connecting to the cluster). * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoConnectedNodesException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoConnectedNodesException.java index 8d704b968d..b350015678 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoConnectedNodesException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoConnectedNodesException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when the cluster is unable to service a - * request because no nodes are connected. + * Represents the exceptional case when the cluster is unable to service a request because no nodes are connected. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoResponseFromNodesException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoResponseFromNodesException.java index 9e17a232dc..6b03c746e6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoResponseFromNodesException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NoResponseFromNodesException.java @@ -17,9 +17,8 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when the cluster is unable to service a - * request because no nodes returned a response. When the given request is not - * mutable the nodes are left in their previous state. + * Represents the exceptional case when the cluster is unable to service a request because no nodes returned a response. When the given request is not mutable the nodes are left in their previous + * state. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NodeDisconnectionException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NodeDisconnectionException.java index 3bd2f4b93f..b2102ff6b8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NodeDisconnectionException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/NodeDisconnectionException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a disconnection request to a node - * failed. + * Represents the exceptional case when a disconnection request to a node failed. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/PrimaryRoleAssignmentException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/PrimaryRoleAssignmentException.java index 403f7a5ce1..0fbaebcf72 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/PrimaryRoleAssignmentException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/PrimaryRoleAssignmentException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when the cluster is unable to update the - * primary role of a node. + * Represents the exceptional case when the cluster is unable to update the primary role of a node. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/SafeModeMutableRequestException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/SafeModeMutableRequestException.java index f544f26908..03710f5b30 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/SafeModeMutableRequestException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/SafeModeMutableRequestException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a HTTP request that may change a node's - * dataflow is to be replicated while the cluster is in safe mode. + * Represents the exceptional case when a HTTP request that may change a node's dataflow is to be replicated while the cluster is in safe mode. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UnknownNodeException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UnknownNodeException.java index 914bb56a84..d2070d1602 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UnknownNodeException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UnknownNodeException.java @@ -17,8 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a request is made for a node that does - * not exist. + * Represents the exceptional case when a request is made for a node that does not exist. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UriConstructionException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UriConstructionException.java index 773d7b58f2..27b5312dda 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UriConstructionException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/exception/UriConstructionException.java @@ -17,9 +17,7 @@ package org.apache.nifi.cluster.manager.exception; /** - * Represents the exceptional case when a URI cannot be constructed from the - * given information. This exception is similar to Java's URISyntaxException - * except that it extends RuntimeException. + * Represents the exceptional case when a URI cannot be constructed from the given information. This exception is similar to Java's URISyntaxException except that it extends RuntimeException. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImpl.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImpl.java index 81bb7a75d4..32181e38a8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImpl.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImpl.java @@ -59,21 +59,14 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An implementation of the HttpRequestReplicator interface. This - * implementation parallelizes the node HTTP requests using the given - * ExecutorService instance. Individual requests may have - * connection and read timeouts set, which may be set during instance - * construction. Otherwise, the default is not to timeout. + * An implementation of the HttpRequestReplicator interface. This implementation parallelizes the node HTTP requests using the given ExecutorService instance. Individual + * requests may have connection and read timeouts set, which may be set during instance construction. Otherwise, the default is not to timeout. * - * If a node protocol scheme is provided during construction, then all requests - * will be replicated using the given scheme. If null is provided as the scheme - * (the default), then the requests will be replicated using the scheme of the - * original URI. + * If a node protocol scheme is provided during construction, then all requests will be replicated using the given scheme. If null is provided as the scheme (the default), then the requests will be + * replicated using the scheme of the original URI. * - * Clients must call start() and stop() to initialize and shutdown the instance. - * The instance must be started before issuing any replication requests. + * Clients must call start() and stop() to initialize and shutdown the instance. The instance must be started before issuing any replication requests. * - * @author unattributed */ public class HttpRequestReplicatorImpl implements HttpRequestReplicator { @@ -97,11 +90,9 @@ public class HttpRequestReplicatorImpl implements HttpRequestReplicator { private String nodeProtocolScheme = null; /** - * Creates an instance. The connection timeout and read timeout will be - * infinite. + * Creates an instance. The connection timeout and read timeout will be infinite. * - * @param numThreads the number of threads to use when parallelizing - * requests + * @param numThreads the number of threads to use when parallelizing requests * @param client a client for making requests */ public HttpRequestReplicatorImpl(final int numThreads, final Client client) { @@ -111,12 +102,10 @@ public class HttpRequestReplicatorImpl implements HttpRequestReplicator { /** * Creates an instance. * - * @param numThreads the number of threads to use when parallelizing - * requests + * @param numThreads the number of threads to use when parallelizing requests * @param client a client for making requests - * @param connectionTimeoutMs the connection timeout specified in - * milliseconds - * @param readTimeoutMs the read timeout specified in milliseconds + * @param connectionTimeout the connection timeout specified in milliseconds + * @param readTimeout the read timeout specified in milliseconds */ public HttpRequestReplicatorImpl(final int numThreads, final Client client, final String connectionTimeout, final String readTimeout) { @@ -178,9 +167,7 @@ public class HttpRequestReplicatorImpl implements HttpRequestReplicator { /** * Sets the protocol scheme to use when issuing requests to nodes. * - * @param nodeProtocolScheme the scheme. Valid values are "http", "https", - * or null. If null is specified, then the scheme of the originating request - * is used when replicating that request. + * @param nodeProtocolScheme the scheme. Valid values are "http", "https", or null. If null is specified, then the scheme of the originating request is used when replicating that request. */ public synchronized void setNodeProtocolScheme(final String nodeProtocolScheme) { if (StringUtils.isNotBlank(nodeProtocolScheme)) { @@ -368,9 +355,7 @@ public class HttpRequestReplicatorImpl implements HttpRequestReplicator { } /** - * Wraps a future node response with info from originating request. This - * coupling allows for futures that encountered exceptions to be linked back - * to the failing node and better reported. + * Wraps a future node response with info from originating request. This coupling allows for futures that encountered exceptions to be linked back to the failing node and better reported. */ private class NodeHttpRequestFutureWrapper { @@ -417,8 +402,7 @@ public class HttpRequestReplicatorImpl implements HttpRequestReplicator { } /** - * A Callable for making an HTTP request to a single node and returning its - * response. + * A Callable for making an HTTP request to a single node and returning its response. */ private class NodeHttpRequestCallable implements Callable { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImpl.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImpl.java index afade7edce..de274b1742 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImpl.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImpl.java @@ -33,12 +33,9 @@ import org.slf4j.LoggerFactory; * * The algorithm is as follows. * - * If any HTTP responses were 2XX, then disconnect non-2XX responses. This is - * because 2XX may have changed a node's flow. + * If any HTTP responses were 2XX, then disconnect non-2XX responses. This is because 2XX may have changed a node's flow. * - * If no 2XX responses were received, then the node's flow has not changed. - * Instead of disconnecting everything, we only disconnect the nodes with - * internal errors, i.e., 5XX responses. + * If no 2XX responses were received, then the node's flow has not changed. Instead of disconnecting everything, we only disconnect the nodes with internal errors, i.e., 5XX responses. * * @author unattributed */ @@ -60,7 +57,7 @@ public class HttpResponseMapperImpl implements HttpResponseMapper { } } - // determine the status of each node + // determine the status of each node for (final NodeResponse nodeResponse : nodeResponses) { final Node.Status status; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/WebClusterManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/WebClusterManager.java index 2cf026a591..d3a24e7378 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/WebClusterManager.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/manager/impl/WebClusterManager.java @@ -232,20 +232,14 @@ import org.apache.nifi.web.api.entity.ReportingTaskEntity; import org.apache.nifi.web.api.entity.ReportingTasksEntity; /** - * Provides a cluster manager implementation. The manager federates incoming - * HTTP client requests to the nodes' external API using the HTTP protocol. The - * manager also communicates with nodes using the nodes' internal socket - * protocol. + * Provides a cluster manager implementation. The manager federates incoming HTTP client requests to the nodes' external API using the HTTP protocol. The manager also communicates with nodes using the + * nodes' internal socket protocol. * - * The manager's socket address may broadcasted using multicast if a - * MulticastServiceBroadcaster instance is set on this instance. The manager - * instance must be started after setting the broadcaster. + * The manager's socket address may broadcasted using multicast if a MulticastServiceBroadcaster instance is set on this instance. The manager instance must be started after setting the broadcaster. * - * The manager may be configured with an EventManager for recording noteworthy - * lifecycle events (e.g., first heartbeat received, node status change). + * The manager may be configured with an EventManager for recording noteworthy lifecycle events (e.g., first heartbeat received, node status change). * - * The start() and stop() methods must be called to initialize and stop the - * instance. + * The start() and stop() methods must be called to initialize and stop the instance. * * @author unattributed */ @@ -258,47 +252,38 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C private static final Logger heartbeatLogger = new NiFiLog(LoggerFactory.getLogger("org.apache.nifi.cluster.heartbeat")); /** - * The HTTP header to store a cluster context. An example of what may be - * stored in the context is a node's auditable actions in response to a - * cluster request. The cluster context is serialized using Java's - * serialization mechanism and hex encoded. + * The HTTP header to store a cluster context. An example of what may be stored in the context is a node's auditable actions in response to a cluster request. The cluster context is serialized + * using Java's serialization mechanism and hex encoded. */ public static final String CLUSTER_CONTEXT_HTTP_HEADER = "X-ClusterContext"; /** - * HTTP Header that stores a unique ID for each request that is replicated - * to the nodes. This is used for logging purposes so that request - * information, such as timing, can be correlated between the NCM and the - * nodes + * HTTP Header that stores a unique ID for each request that is replicated to the nodes. This is used for logging purposes so that request information, such as timing, can be correlated between + * the NCM and the nodes */ public static final String REQUEST_ID_HEADER = "X-RequestID"; /** - * The HTTP header that the NCM specifies to ask a node if they are able to - * process a given request. The value is always 150-NodeContinue. The node - * will respond with 150 CONTINUE if it is able to process the request, 417 - * EXPECTATION_FAILED otherwise. + * The HTTP header that the NCM specifies to ask a node if they are able to process a given request. The value is always 150-NodeContinue. The node will respond with 150 CONTINUE if it is able to + * process the request, 417 EXPECTATION_FAILED otherwise. */ public static final String NCM_EXPECTS_HTTP_HEADER = "X-NcmExpects"; public static final int NODE_CONTINUE_STATUS_CODE = 150; /** - * The HTTP header that the NCM specifies to indicate that a node should - * invalidate the specified user group. This is done to ensure that user - * cache is not stale when an administrator modifies a group through the UI. + * The HTTP header that the NCM specifies to indicate that a node should invalidate the specified user group. This is done to ensure that user cache is not stale when an administrator modifies a + * group through the UI. */ public static final String CLUSTER_INVALIDATE_USER_GROUP_HEADER = "X-ClusterInvalidateUserGroup"; /** - * The HTTP header that the NCM specifies to indicate that a node should - * invalidate the specified user. This is done to ensure that user cache is - * not stale when an administrator modifies a user through the UI. + * The HTTP header that the NCM specifies to indicate that a node should invalidate the specified user. This is done to ensure that user cache is not stale when an administrator modifies a user + * through the UI. */ public static final String CLUSTER_INVALIDATE_USER_HEADER = "X-ClusterInvalidateUser"; /** - * The default number of seconds to respond to a connecting node if the - * manager cannot provide it with a current data flow. + * The default number of seconds to respond to a connecting node if the manager cannot provide it with a current data flow. */ private static final int DEFAULT_CONNECTION_REQUEST_TRY_AGAIN_SECONDS = 5; @@ -398,7 +383,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C snapshotMillis = FormatUtils.getTimeDuration(NiFiProperties.DEFAULT_COMPONENT_STATUS_SNAPSHOT_FREQUENCY, TimeUnit.MILLISECONDS); } componentStatusSnapshotMillis = snapshotMillis; - + Executors.newSingleThreadScheduledExecutor().scheduleWithFixedDelay(new Runnable() { @Override public void run() { @@ -411,7 +396,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C statusRepository = createComponentStatusRepository(); componentMetricsRepositoryMap.put(node.getNodeId(), statusRepository); } - + // ensure this node has a payload if (node.getHeartbeat() != null && node.getHeartbeatPayload() != null) { // if nothing has been captured or the current heartbeat is newer, capture it - comparing the heatbeat created timestamp @@ -422,7 +407,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } } } - } catch(final Throwable t) { + } catch (final Throwable t) { logger.warn("Unable to capture component metrics from Node heartbeats: " + t); if (logger.isDebugEnabled()) { logger.warn("", t); @@ -667,14 +652,10 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Services connection requests. If the data flow management service is - * unable to provide a current copy of the data flow, then the returned - * connection response will indicate the node should try later. Otherwise, - * the connection response will contain the the flow and the node - * identifier. + * Services connection requests. If the data flow management service is unable to provide a current copy of the data flow, then the returned connection response will indicate the node should try + * later. Otherwise, the connection response will contain the the flow and the node identifier. * - * If this instance is configured with a firewall and the request is - * blocked, then the response will not contain a node identifier. + * If this instance is configured with a firewall and the request is blocked, then the response will not contain a node identifier. * * @param request a connection request * @@ -754,14 +735,14 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /* - * The manager does not have a current copy of the data flow, - * so it will instruct the node to try connecting at a later - * time. Meanwhile, the flow will be locked down from user + * The manager does not have a current copy of the data flow, + * so it will instruct the node to try connecting at a later + * time. Meanwhile, the flow will be locked down from user * changes because the node is marked as connecting. */ /* - * Create try-later response based on flow retrieval delay to give + * Create try-later response based on flow retrieval delay to give * the flow management service a chance to retrieve a curren flow */ final int tryAgainSeconds; @@ -783,20 +764,14 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Services reconnection requests for a given node. If the node indicates - * reconnection failure, then the node will be set to disconnected and if - * the node has primary role, then the role will be revoked. Otherwise, a - * reconnection request will be sent to the node, initiating the connection - * handshake. + * Services reconnection requests for a given node. If the node indicates reconnection failure, then the node will be set to disconnected and if the node has primary role, then the role will be + * revoked. Otherwise, a reconnection request will be sent to the node, initiating the connection handshake. * * @param nodeId a node identifier * * @throws UnknownNodeException if the node does not exist - * @throws IllegalNodeReconnectionException if the node cannot be - * reconnected because the node is not disconnected - * @throws NodeReconnectionException if the reconnection message failed to - * be sent or the cluster could not provide a current data flow for the - * reconnection request + * @throws IllegalNodeReconnectionException if the node cannot be reconnected because the node is not disconnected + * @throws NodeReconnectionException if the reconnection message failed to be sent or the cluster could not provide a current data flow for the reconnection request */ @Override public void requestReconnection(final String nodeId, final String userDn) throws UnknownNodeException, IllegalNodeReconnectionException { @@ -1163,11 +1138,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C * @param userDn the DN of the user requesting the disconnection * * @throws UnknownNodeException if the node does not exist - * @throws IllegalNodeDisconnectionException if the node cannot be - * disconnected due to the cluster's state (e.g., node is last connected - * node or node is primary) - * @throws NodeDisconnectionException if the disconnection message fails to - * be sent. + * @throws IllegalNodeDisconnectionException if the node cannot be disconnected due to the cluster's state (e.g., node is last connected node or node is primary) + * @throws NodeDisconnectionException if the disconnection message fails to be sent. */ @Override public void requestDisconnection(final String nodeId, final String userDn) throws UnknownNodeException, IllegalNodeDisconnectionException, NodeDisconnectionException { @@ -1185,8 +1157,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Requests a disconnection to the node with the given node ID, but any - * exception thrown is suppressed. + * Requests a disconnection to the node with the given node ID, but any exception thrown is suppressed. * * @param nodeId the node ID */ @@ -1197,28 +1168,19 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Issues a disconnection message to the node identified by the given node - * ID. If the node is not known, then a UnknownNodeException is thrown. If - * the node cannot be disconnected due to the cluster's state and - * ignoreLastNodeCheck is false, then a IllegalNodeDisconnectionException is - * thrown. Otherwise, a disconnection message is issued to the node. + * Issues a disconnection message to the node identified by the given node ID. If the node is not known, then a UnknownNodeException is thrown. If the node cannot be disconnected due to the + * cluster's state and ignoreLastNodeCheck is false, then a IllegalNodeDisconnectionException is thrown. Otherwise, a disconnection message is issued to the node. * - * Whether the disconnection message is successfully sent to the node, the - * node is marked as disconnected and if the node is the primary node, then - * the primary role is revoked. + * Whether the disconnection message is successfully sent to the node, the node is marked as disconnected and if the node is the primary node, then the primary role is revoked. * * @param nodeId the ID of the node - * @param ignoreNodeChecks if false, checks will be made to ensure the - * cluster supports the node's disconnection (e.g., the node is not the last - * connected node in the cluster; the node is not the primary); otherwise, - * the request is made regardless of the cluster state + * @param ignoreNodeChecks if false, checks will be made to ensure the cluster supports the node's disconnection (e.g., the node is not the last connected node in the cluster; the node is not the + * primary); otherwise, the request is made regardless of the cluster state * @param explanation * - * @throws IllegalNodeDisconnectionException if the node cannot be - * disconnected due to the cluster's state (e.g., node is last connected - * node or node is primary). Not thrown if ignoreNodeChecks is true. - * @throws NodeDisconnectionException if the disconnection message fails to - * be sent. + * @throws IllegalNodeDisconnectionException if the node cannot be disconnected due to the cluster's state (e.g., node is last connected node or node is primary). Not thrown if ignoreNodeChecks is + * true. + * @throws NodeDisconnectionException if the disconnection message fails to be sent. */ private void requestDisconnection(final NodeIdentifier nodeId, final boolean ignoreNodeChecks, final String explanation) throws IllegalNodeDisconnectionException, NodeDisconnectionException { @@ -1276,8 +1238,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Messages the node to have the primary role. If the messaging fails, then - * the node is marked as disconnected. + * Messages the node to have the primary role. If the messaging fails, then the node is marked as disconnected. * * @param nodeId the node ID to assign primary role * @@ -1292,7 +1253,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C msg.setPrimary(true); logger.info("Attempting to assign primary role to node: " + nodeId); - // message + // message senderListener.assignPrimaryRole(msg); logger.info("Assigned primary role to node: " + nodeId); @@ -1321,11 +1282,9 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Messages the node with the given node ID to no longer have the primary - * role. If the messaging fails, then the node is marked as disconnected. + * Messages the node with the given node ID to no longer have the primary role. If the messaging fails, then the node is marked as disconnected. * - * @return true if the primary role was revoked from the node; false - * otherwise + * @return true if the primary role was revoked from the node; false otherwise */ private boolean revokePrimaryRole(final NodeIdentifier nodeId) { writeLock.lock(); @@ -1382,8 +1341,10 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C final Node node = getRawNode(msg.getNodeId().getId()); if (node != null) { node.setStatus(Status.DISCONNECTED); - addEvent(msg.getNodeId(), "Node could not join cluster because it failed to start up properly. Setting node to Disconnected. Node reported the following error: " + msg.getExceptionMessage()); - addBulletin(node, Severity.ERROR, "Node could not join cluster because it failed to start up properly. Setting node to Disconnected. Node reported the following error: " + msg.getExceptionMessage()); + addEvent(msg.getNodeId(), "Node could not join cluster because it failed to start up properly. Setting node to Disconnected. Node reported " + + "the following error: " + msg.getExceptionMessage()); + addBulletin(node, Severity.ERROR, "Node could not join cluster because it failed to start up properly. Setting node to Disconnected. Node " + + "reported the following error: " + msg.getExceptionMessage()); } } finally { writeLock.unlock("handleControllerStartupFailure"); @@ -1405,14 +1366,6 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } } - /** - * Adds an instance of a specified controller service. - * - * @param type - * @param id - * @param properties - * @return - */ @Override public ControllerServiceNode createControllerService(final String type, final String id, final boolean firstTimeAdded) { return controllerServiceProvider.createControllerService(type, id, firstTimeAdded); @@ -1666,7 +1619,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C /** * Handle a bulletins message. * - * @param bulletins + * @param bulletins bulletins */ public void handleBulletins(final NodeBulletins bulletins) { final NodeIdentifier nodeIdentifier = bulletins.getNodeIdentifier(); @@ -1681,15 +1634,9 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Handles a node's heartbeat. If this heartbeat is a node's first heartbeat - * since its connection request, then the manager will mark the node as - * connected. If the node was previously disconnected due to a lack of - * heartbeat, then a reconnection request is issued. If the node was - * disconnected for other reasons, then a disconnection request is issued. - * If this instance is configured with a firewall and the heartbeat is - * blocked, then a disconnection request is issued. - * - * @param heartbeat + * Handles a node's heartbeat. If this heartbeat is a node's first heartbeat since its connection request, then the manager will mark the node as connected. If the node was previously disconnected + * due to a lack of heartbeat, then a reconnection request is issued. If the node was disconnected for other reasons, then a disconnection request is issued. If this instance is configured with a + * firewall and the heartbeat is blocked, then a disconnection request is issued. */ @Override public void handleHeartbeat(final Heartbeat heartbeat) { @@ -1703,9 +1650,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C /* * Processing a heartbeat requires a write lock, which may take a while * to obtain. Only the last heartbeat is necessary to process per node. - * Futhermore, since many could pile up, heartbeats are processed in + * Futhermore, since many could pile up, heartbeats are processed in * bulk. - * * The below queue stores the pending heartbeats. */ pendingHeartbeats.add(heartbeat); @@ -1782,7 +1728,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } else if (heartbeatIndicatesNotYetConnected) { if (Status.CONNECTED == node.getStatus()) { // record event - addEvent(node.getNodeId(), "Received heartbeat from node that thinks it is not yet part of the cluster, though the Manager thought it was. Marking as Disconnected and issuing reconnection request."); + addEvent(node.getNodeId(), "Received heartbeat from node that thinks it is not yet part of the cluster, though the Manager thought it " + + "was. Marking as Disconnected and issuing reconnection request."); // record heartbeat node.setHeartbeat(null); @@ -1843,7 +1790,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C node.setHeartbeat(mostRecentHeartbeat); } } catch (final Exception e) { - logger.error("Failed to process heartbeat from {}:{} due to {}", mostRecentHeartbeat.getNodeIdentifier().getApiAddress(), mostRecentHeartbeat.getNodeIdentifier().getApiPort(), e.toString()); + logger.error("Failed to process heartbeat from {}:{} due to {}", + mostRecentHeartbeat.getNodeIdentifier().getApiAddress(), mostRecentHeartbeat.getNodeIdentifier().getApiPort(), e.toString()); if (logger.isDebugEnabled()) { logger.error("", e); } @@ -2043,13 +1991,15 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C @Override public NodeResponse applyRequest(final String method, final URI uri, final Map> parameters, final Map headers) - throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { + throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, + ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { return applyRequest(method, uri, parameters, headers, getNodeIds(Status.CONNECTED)); } @Override public NodeResponse applyRequest(final String method, final URI uri, final Map> parameters, final Map headers, final Set nodeIdentifiers) - throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { + throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, + ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { final boolean mutableRequest = canChangeNodeState(method, uri); final ClusterManagerLock lock = mutableRequest ? writeLock : readLock; @@ -2085,13 +2035,15 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C @Override public NodeResponse applyRequest(final String method, final URI uri, final Object entity, final Map headers) - throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { + throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, + ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { return applyRequest(method, uri, entity, headers, getNodeIds(Status.CONNECTED)); } @Override public NodeResponse applyRequest(final String method, final URI uri, final Object entity, final Map headers, final Set nodeIdentifiers) - throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { + throws NoConnectedNodesException, NoResponseFromNodesException, UriConstructionException, + ConnectingNodeMutableRequestException, DisconnectedNodeMutableRequestException, SafeModeMutableRequestException { final boolean mutableRequest = canChangeNodeState(method, uri); final ClusterManagerLock lock = mutableRequest ? writeLock : readLock; @@ -2270,7 +2222,9 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } // requires write lock to already be acquired unless method cannot change node state - private NodeResponse federateRequest(final String method, final URI uri, final Map> parameters, final Object entity, final Map headers, final Set nodeIds) throws UriConstructionException { + private NodeResponse federateRequest( + final String method, final URI uri, final Map> parameters, final Object entity, final Map headers, final Set nodeIds) + throws UriConstructionException { // ensure some nodes are connected if (nodeIds.isEmpty()) { throw new NoConnectedNodesException("Cannot apply " + method + " request to " + uri + " because there are currently no connected Nodes"); @@ -2399,7 +2353,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } private static boolean isProcessorEndpoint(final URI uri, final String method) { - if (("GET".equalsIgnoreCase(method) || "PUT".equalsIgnoreCase(method)) && (PROCESSOR_URI_PATTERN.matcher(uri.getPath()).matches() || CLUSTER_PROCESSOR_URI_PATTERN.matcher(uri.getPath()).matches())) { + if (("GET".equalsIgnoreCase(method) || "PUT".equalsIgnoreCase(method)) + && (PROCESSOR_URI_PATTERN.matcher(uri.getPath()).matches() || CLUSTER_PROCESSOR_URI_PATTERN.matcher(uri.getPath()).matches())) { return true; } else if ("POST".equalsIgnoreCase(method) && PROCESSORS_URI_PATTERN.matcher(uri.getPath()).matches()) { return true; @@ -2674,7 +2629,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } } - private void mergeControllerServiceReferences(final Set referencingComponents, final Map> referencingComponentMap) { + private void mergeControllerServiceReferences( + final Set referencingComponents, final Map> referencingComponentMap) { final Map activeThreadCounts = new HashMap<>(); final Map states = new HashMap<>(); for (final Map.Entry> nodeEntry : referencingComponentMap.entrySet()) { @@ -2782,12 +2738,11 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Merges the validation errors into the specified map, recording the - * corresponding node identifier. + * Merges the validation errors into the specified map, recording the corresponding node identifier. * - * @param validationErrorMap - * @param nodeId - * @param nodeValidationErrors + * @param validationErrorMap map + * @param nodeId id + * @param nodeValidationErrors errors */ public void mergeValidationErrors(final Map> validationErrorMap, final NodeIdentifier nodeId, final Collection nodeValidationErrors) { if (nodeValidationErrors != null) { @@ -2803,12 +2758,11 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Normalizes the validation errors by prepending the corresponding nodes - * when the error does not exist across all nodes. + * Normalizes the validation errors by prepending the corresponding nodes when the error does not exist across all nodes. * - * @param validationErrorMap - * @param totalNodes - * @return + * @param validationErrorMap map + * @param totalNodes total + * @return normalized errors */ public Set normalizedMergedValidationErrors(final Map> validationErrorMap, int totalNodes) { final Set normalizedValidationErrors = new HashSet<>(); @@ -2862,7 +2816,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C final boolean hasClientResponse = clientResponse != null; final boolean hasSuccessfulClientResponse = hasClientResponse && clientResponse.is2xx(); - // drain the responses from the socket for those responses not being sent to the client + // drain the responses from the socket for those responses not being sent to the client final Set nodeResponsesToDrain = new HashSet<>(updatedNodesMap.values()); nodeResponsesToDrain.remove(clientResponse); @@ -3177,7 +3131,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C continue; } - final ControllerServiceReferencingComponentsEntity nodeResponseEntity = (nodeResponse == clientResponse) ? responseEntity : nodeResponse.getClientResponse().getEntity(ControllerServiceReferencingComponentsEntity.class); + final ControllerServiceReferencingComponentsEntity nodeResponseEntity = + (nodeResponse == clientResponse) ? responseEntity : nodeResponse.getClientResponse().getEntity(ControllerServiceReferencingComponentsEntity.class); final Set nodeReferencingComponents = nodeResponseEntity.getControllerServiceReferencingComponents(); resultsMap.put(nodeResponse.getNodeId(), nodeReferencingComponents); @@ -3243,9 +3198,9 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /* - * Nodes that encountered issues handling the request are marked as - * disconnected for mutable requests (e.g., post, put, delete). For - * other requests (e.g., get, head), the nodes remain in their current + * Nodes that encountered issues handling the request are marked as + * disconnected for mutable requests (e.g., post, put, delete). For + * other requests (e.g., get, head), the nodes remain in their current * state even if they had problems handling the request. */ if (mutableRequest) { @@ -3260,7 +3215,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C // mark flow as stale since this request could have changed the flow notifyDataFlowManagmentServiceOfFlowStateChange(PersistedFlowState.STALE); - // disconnect problematic nodes + // disconnect problematic nodes if (!problematicNodeResponses.isEmpty()) { if (problematicNodeResponses.size() < nodeResponses.size()) { logger.warn(String.format("One or more nodes failed to process URI '%s'. Requesting each node to disconnect from cluster.", uri)); @@ -3275,8 +3230,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Drains the node responses off of the socket to ensure that the socket is - * appropriately cleaned-up. + * Drains the node responses off of the socket to ensure that the socket is appropriately cleaned-up. * * @param nodeResponses the collection of node responses */ @@ -3313,11 +3267,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * A helper method to disconnect nodes that returned unsuccessful HTTP - * responses because of a replicated request. Disconnection requests are - * sent concurrently. + * A helper method to disconnect nodes that returned unsuccessful HTTP responses because of a replicated request. Disconnection requests are sent concurrently. * - * @param nodeResponses */ private void disconnectNodes(final Set nodeResponses, final String explanation) { // return fast if nothing to do @@ -3363,14 +3314,11 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Returns false if an internal protocol message was received by a node - * listed in the firewall. If no firewall is configured, then false is - * always returned. + * Returns false if an internal protocol message was received by a node listed in the firewall. If no firewall is configured, then false is always returned. * * @param ip the IP of the remote machine * - * @return false if the IP is listed in the firewall or if the firewall is - * not configured; true otherwise + * @return false if the IP is listed in the firewall or if the firewall is not configured; true otherwise */ private boolean isBlockedByFirewall(final String ip) { if (isFirewallConfigured()) { @@ -3417,10 +3365,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * Resolves a proposed node identifier to a node identifier that the manager - * approves. If the proposed node identifier conflicts with an existing node - * identifier, then an approved node identifier is generated and returned to - * the caller. + * Resolves a proposed node identifier to a node identifier that the manager approves. If the proposed node identifier conflicts with an existing node identifier, then an approved node identifier + * is generated and returned to the caller. * * @param proposedNodeId a proposed identifier * @@ -3579,11 +3525,8 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * This timer task simply processes any pending heartbeats. This timer task - * is not strictly needed, as HeartbeatMonitoringTimerTask will do this. - * However, this task is scheduled much more frequently and by processing - * the heartbeats more frequently, the stats that we report have less of a - * delay. + * This timer task simply processes any pending heartbeats. This timer task is not strictly needed, as HeartbeatMonitoringTimerTask will do this. However, this task is scheduled much more + * frequently and by processing the heartbeats more frequently, the stats that we report have less of a delay. */ private class ProcessPendingHeartbeatsTask extends TimerTask { @@ -3599,13 +3542,9 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C } /** - * A timer task to detect nodes that have not sent a heartbeat in a while. - * The "problem" nodes are marked as disconnected due to lack of heartbeat - * by the task. No disconnection request is sent to the node. This is - * because either the node is not functioning in which case sending the - * request is futile or the node is running a bit slow. In the latter case, - * we'll wait for the next heartbeat and send a reconnection request when we - * process the heartbeat in the heartbeatHandler() method. + * A timer task to detect nodes that have not sent a heartbeat in a while. The "problem" nodes are marked as disconnected due to lack of heartbeat by the task. No disconnection request is sent to + * the node. This is because either the node is not functioning in which case sending the request is futile or the node is running a bit slow. In the latter case, we'll wait for the next heartbeat + * and send a reconnection request when we process the heartbeat in the heartbeatHandler() method. */ private class HeartbeatMonitoringTimerTask extends TimerTask { @@ -3899,7 +3838,7 @@ public class WebClusterManager implements HttpClusterManager, ProtocolHandler, C for (final Map.Entry> entry : snapshotsToAggregate.entrySet()) { final List snapshots = entry.getValue(); final StatusSnapshot reducedSnapshot = snapshots.get(0).getValueReducer().reduce(snapshots); - + final StatusSnapshotDTO dto = new StatusSnapshotDTO(); dto.setTimestamp(reducedSnapshot.getTimestamp()); dto.setStatusMetrics(StatusHistoryUtil.createStatusSnapshotDto(reducedSnapshot).getStatusMetrics()); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/node/Node.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/node/Node.java index 1b128f729d..bc05b89af2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/node/Node.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/node/Node.java @@ -27,13 +27,11 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a connected flow controller. Nodes always have an immutable - * identifier and a status. The status may be changed, but never null. + * Represents a connected flow controller. Nodes always have an immutable identifier and a status. The status may be changed, but never null. * * A Node may be cloned, but the cloning is a shallow copy of the instance. * - * This class overrides hashCode and equals and considers two instances to be - * equal if they have the equal NodeIdentifiers. + * This class overrides hashCode and equals and considers two instances to be equal if they have the equal NodeIdentifiers. * * @author unattributed */ @@ -44,19 +42,12 @@ public class Node implements Cloneable, Comparable { /** * The semantics of a Node status are as follows: *
    - *
  • CONNECTED -- a flow controller that is connected to the cluster. A - * connecting node transitions to connected after the cluster receives the - * flow controller's first heartbeat. A connected node can transition to - * disconnecting.
    • - *
  • CONNECTING -- a flow controller has issued a connection request to - * the cluster, but has not yet sent a heartbeat. A connecting node can - * transition to disconnecting or connected. The cluster will not accept any - * external requests to change the flow while any node is connecting.
    • - *
  • DISCONNECTED -- a flow controller that is not connected to the - * cluster. A disconnected node can transition to connecting.
    • - *
  • DISCONNECTING -- a flow controller that is in the process of - * disconnecting from the cluster. A disconnecting node will always - * transition to disconnected.
    • + *
  • CONNECTED -- a flow controller that is connected to the cluster. A connecting node transitions to connected after the cluster receives the flow controller's first heartbeat. A connected + * node can transition to disconnecting.
    • + *
  • CONNECTING -- a flow controller has issued a connection request to the cluster, but has not yet sent a heartbeat. A connecting node can transition to disconnecting or connected. The cluster + * will not accept any external requests to change the flow while any node is connecting.
    • + *
  • DISCONNECTED -- a flow controller that is not connected to the cluster. A disconnected node can transition to connecting.
    • + *
  • DISCONNECTING -- a flow controller that is in the process of disconnecting from the cluster. A disconnecting node will always transition to disconnected.
    • *
*/ public static enum Status { @@ -93,8 +84,7 @@ public class Node implements Cloneable, Comparable { private AtomicLong connectionRequestedTimestamp = new AtomicLong(0L); /** - * a flag to indicate this node was disconnected because of a lack of - * heartbeat + * a flag to indicate this node was disconnected because of a lack of heartbeat */ private boolean heartbeatDisconnection; @@ -156,8 +146,7 @@ public class Node implements Cloneable, Comparable { } /** - * Sets the time when the connection request for this node was last - * received. + * Sets the time when the connection request for this node was last received. * * This method is thread-safe and may be called without obtaining any lock. * @@ -168,19 +157,16 @@ public class Node implements Cloneable, Comparable { } /** - * Returns true if the node was disconnected due to lack of heartbeat; false - * otherwise. + * Returns true if the node was disconnected due to lack of heartbeat; false otherwise. * - * @return true if the node was disconnected due to lack of heartbeat; false - * otherwise. + * @return true if the node was disconnected due to lack of heartbeat; false otherwise. */ public boolean isHeartbeatDisconnection() { return heartbeatDisconnection; } /** - * Sets the status to disconnected and flags the node as being disconnected - * by lack of heartbeat. + * Sets the status to disconnected and flags the node as being disconnected by lack of heartbeat. */ public void setHeartbeatDisconnection() { setStatus(Status.DISCONNECTED); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/ClusterManagerProtocolServiceLocatorFactoryBean.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/ClusterManagerProtocolServiceLocatorFactoryBean.java index c369a7f44a..2136dad1a0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/ClusterManagerProtocolServiceLocatorFactoryBean.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/ClusterManagerProtocolServiceLocatorFactoryBean.java @@ -33,12 +33,10 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; /** - * Factory bean for creating a singleton ClusterManagerProtocolServiceLocator - * instance. If the application is configured to act as the cluster manager, - * then null is always returned as the created instance. + * Factory bean for creating a singleton ClusterManagerProtocolServiceLocator instance. If the application is configured to act as the cluster manager, then null is always returned as the created + * instance. * - * The cluster manager protocol service represents the socket endpoint for - * sending internal socket messages to the cluster manager. + * The cluster manager protocol service represents the socket endpoint for sending internal socket messages to the cluster manager. */ public class ClusterManagerProtocolServiceLocatorFactoryBean implements FactoryBean, ApplicationContextAware, DisposableBean { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/WebClusterManagerFactoryBean.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/WebClusterManagerFactoryBean.java index 7bcb2033c8..2b3bff96b8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/WebClusterManagerFactoryBean.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/main/java/org/apache/nifi/cluster/spring/WebClusterManagerFactoryBean.java @@ -36,9 +36,7 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; /** - * Factory bean for creating a singleton WebClusterManager instance. If the - * application is not configured to act as the cluster manager, then null is - * always returned as the created instance. + * Factory bean for creating a singleton WebClusterManager instance. If the application is not configured to act as the cluster manager, then null is always returned as the created instance. */ public class WebClusterManagerFactoryBean implements FactoryBean, ApplicationContextAware { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/event/impl/EventManagerImplTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/event/impl/EventManagerImplTest.java index 09ea44b383..99c0a5ad6d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/event/impl/EventManagerImplTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/event/impl/EventManagerImplTest.java @@ -16,15 +16,16 @@ */ package org.apache.nifi.cluster.event.impl; -import org.apache.nifi.cluster.event.impl.EventManagerImpl; import java.util.Arrays; import java.util.Collections; import java.util.List; import org.apache.nifi.cluster.event.Event; import org.apache.nifi.cluster.event.Event.Category; import org.apache.nifi.cluster.event.EventManager; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; import org.junit.Test; -import static org.junit.Assert.*; /** * @author unattributed diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewallTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewallTest.java index e5db7cac69..441a3b2a47 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewallTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/firewall/impl/FileBasedClusterNodeFirewallTest.java @@ -20,8 +20,10 @@ import java.io.File; import java.io.IOException; import org.apache.nifi.util.file.FileUtils; import org.junit.After; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; import org.junit.Before; -import static org.junit.Assert.*; import org.junit.Test; public class FileBasedClusterNodeFirewallTest { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImplTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImplTest.java index 0c65aba218..a7e877e7db 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImplTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpRequestReplicatorImplTest.java @@ -16,7 +16,6 @@ */ package org.apache.nifi.cluster.manager.impl; -import org.apache.nifi.cluster.manager.impl.HttpRequestReplicatorImpl; import javax.ws.rs.core.Response; import javax.xml.bind.annotation.XmlRootElement; import javax.ws.rs.HttpMethod; @@ -43,7 +42,9 @@ import org.junit.Before; import org.junit.Test; import org.apache.nifi.cluster.manager.testutils.HttpResponseAction; import org.apache.nifi.cluster.protocol.NodeIdentifier; -import static org.junit.Assert.*; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertTrue; /** * @author unattributed diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImplTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImplTest.java index d45a4d1d15..048ef2f781 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImplTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/impl/HttpResponseMapperImplTest.java @@ -16,7 +16,6 @@ */ package org.apache.nifi.cluster.manager.impl; -import org.apache.nifi.cluster.manager.impl.HttpResponseMapperImpl; import com.sun.jersey.api.client.ClientResponse; import com.sun.jersey.core.util.MultivaluedMapImpl; import java.io.ByteArrayInputStream; @@ -29,10 +28,11 @@ import org.apache.nifi.cluster.manager.NodeResponse; import org.apache.nifi.cluster.node.Node; import org.apache.nifi.cluster.node.Node.Status; import org.apache.nifi.cluster.protocol.NodeIdentifier; +import static org.junit.Assert.assertTrue; import org.junit.Before; import org.junit.Test; -import static org.junit.Assert.*; -import static org.mockito.Mockito.*; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; /** * @author unattributed diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpRequest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpRequest.java index 35380ddb57..544cd58b5d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpRequest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpRequest.java @@ -30,8 +30,7 @@ import javax.ws.rs.core.MediaType; import org.apache.commons.lang3.StringUtils; /** - * Encapsulates an HTTP request. The toString method returns the - * specification-compliant request. + * Encapsulates an HTTP request. The toString method returns the specification-compliant request. * * @author unattributed */ @@ -97,9 +96,7 @@ public class HttpRequest { } /** - * A builder for constructing basic HTTP requests. It handles only enough of - * the HTTP specification to support basic unit testing, and it should not - * be used otherwise. + * A builder for constructing basic HTTP requests. It handles only enough of the HTTP specification to support basic unit testing, and it should not be used otherwise. */ public static class HttpRequestBuilder { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponse.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponse.java index 3aa29318a3..e8fd620ca4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponse.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponse.java @@ -22,8 +22,7 @@ import java.util.Map; import javax.ws.rs.core.Response.Status; /** - * Encapsulates an HTTP response. The toString method returns the - * specification-compliant response. + * Encapsulates an HTTP response. The toString method returns the specification-compliant response. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponseAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponseAction.java index 28615d0348..d4f9f96281 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponseAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpResponseAction.java @@ -17,9 +17,7 @@ package org.apache.nifi.cluster.manager.testutils; /** - * Wraps a HttpResponse with a time-delay. When the action is applied, the - * currently executing thread sleeps for the given delay before returning the - * response to the caller. + * Wraps a HttpResponse with a time-delay. When the action is applied, the currently executing thread sleeps for the given delay before returning the response to the caller. * * This class is good for simulating network latency. * diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpServer.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpServer.java index f17a66c3eb..bab3ca0c8e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpServer.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/manager/testutils/HttpServer.java @@ -37,8 +37,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * A simple HTTP web server that allows clients to register canned-responses to - * respond to received requests. + * A simple HTTP web server that allows clients to register canned-responses to respond to received requests. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterManagerProtocolSenderImplTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterManagerProtocolSenderImplTest.java index 96943c2462..1a3fdb6f38 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterManagerProtocolSenderImplTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterManagerProtocolSenderImplTest.java @@ -31,11 +31,13 @@ import org.apache.nifi.cluster.protocol.message.ProtocolMessage; import org.apache.nifi.io.socket.ServerSocketConfiguration; import org.apache.nifi.io.socket.SocketConfiguration; import org.junit.After; -import static org.junit.Assert.*; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.fail; import org.junit.Before; import org.junit.Test; import static org.mockito.Matchers.any; -import static org.mockito.Mockito.*; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServiceLocatorTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServiceLocatorTest.java index 4a6957105e..ea4015044d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServiceLocatorTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServiceLocatorTest.java @@ -20,10 +20,12 @@ import java.net.InetSocketAddress; import java.util.concurrent.TimeUnit; import org.apache.nifi.io.socket.multicast.DiscoverableService; import org.apache.nifi.io.socket.multicast.DiscoverableServiceImpl; -import static org.junit.Assert.*; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; import org.junit.Before; import org.junit.Test; -import static org.mockito.Mockito.*; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; import org.mockito.stubbing.OngoingStubbing; public class ClusterServiceLocatorTest { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServicesBroadcasterTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServicesBroadcasterTest.java index 4d85d1a130..0f834fcf50 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServicesBroadcasterTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/ClusterServicesBroadcasterTest.java @@ -28,7 +28,8 @@ import org.apache.nifi.io.socket.multicast.DiscoverableService; import org.apache.nifi.io.socket.multicast.DiscoverableServiceImpl; import org.apache.nifi.io.socket.multicast.MulticastConfiguration; import org.junit.After; -import static org.junit.Assert.*; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; import org.junit.Before; import org.junit.Ignore; import org.junit.Test; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/MulticastProtocolListenerTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/MulticastProtocolListenerTest.java index 6c79b9073d..f5037a8ebb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/MulticastProtocolListenerTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/MulticastProtocolListenerTest.java @@ -35,7 +35,7 @@ import org.apache.nifi.cluster.protocol.message.ProtocolMessage; import org.apache.nifi.io.socket.multicast.MulticastConfiguration; import org.apache.nifi.io.socket.multicast.MulticastUtils; import org.junit.After; -import static org.junit.Assert.*; +import static org.junit.Assert.assertEquals; import org.junit.Before; import org.junit.Ignore; import org.junit.Test; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/NodeProtocolSenderImplTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/NodeProtocolSenderImplTest.java index 7c62d2f984..a759b86ad7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/NodeProtocolSenderImplTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/NodeProtocolSenderImplTest.java @@ -111,7 +111,8 @@ public class NodeProtocolSenderImplTest { when(mockServiceLocator.getService()).thenReturn(service); when(mockHandler.canHandle(any(ProtocolMessage.class))).thenReturn(Boolean.TRUE); ConnectionResponseMessage mockMessage = new ConnectionResponseMessage(); - mockMessage.setConnectionResponse(new ConnectionResponse(nodeIdentifier, new StandardDataFlow("flow".getBytes("UTF-8"), new byte[0], new byte[0]), false, null, null, UUID.randomUUID().toString())); + mockMessage.setConnectionResponse(new ConnectionResponse(nodeIdentifier, + new StandardDataFlow("flow".getBytes("UTF-8"), new byte[0], new byte[0]), false, null, null, UUID.randomUUID().toString())); when(mockHandler.handle(any(ProtocolMessage.class))).thenReturn(mockMessage); ConnectionRequestMessage request = new ConnectionRequestMessage(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/SocketProtocolListenerTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/SocketProtocolListenerTest.java index 92a7d2a943..7a91c2987e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/SocketProtocolListenerTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster/src/test/java/org/apache/nifi/cluster/protocol/impl/SocketProtocolListenerTest.java @@ -33,7 +33,8 @@ import org.apache.nifi.io.socket.ServerSocketConfiguration; import org.apache.nifi.io.socket.SocketConfiguration; import org.apache.nifi.io.socket.SocketUtils; import org.junit.After; -import static org.junit.Assert.*; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.fail; import org.junit.Before; import org.junit.Test; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/cluster/HeartbeatPayload.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/cluster/HeartbeatPayload.java index 093b238551..668c5e0a61 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/cluster/HeartbeatPayload.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/cluster/HeartbeatPayload.java @@ -34,8 +34,7 @@ import org.apache.nifi.diagnostics.SystemDiagnostics; import org.apache.nifi.jaxb.CounterAdapter; /** - * The payload of the heartbeat. The payload contains status to inform the - * cluster manager the current workload of this node. + * The payload of the heartbeat. The payload contains status to inform the cluster manager the current workload of this node. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/LocalPort.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/LocalPort.java index f0739c2291..ceb85f25b7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/LocalPort.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/LocalPort.java @@ -37,9 +37,8 @@ import org.apache.nifi.processor.Relationship; import org.apache.nifi.scheduling.SchedulingStrategy; /** - * Provides a mechanism by which FlowFiles can be transferred into - * and out of a ProcessGroup to and/or from another - * ProcessGroup within the same instance of NiFi. + * Provides a mechanism by which FlowFiles can be transferred into and out of a ProcessGroup to and/or from another ProcessGroup within the same instance of + * NiFi. */ public class LocalPort extends AbstractPort { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/StandardConnection.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/StandardConnection.java index b2feab5659..86c9320ff2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/StandardConnection.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/connectable/StandardConnection.java @@ -39,9 +39,7 @@ import org.apache.commons.lang3.builder.EqualsBuilder; import org.apache.commons.lang3.builder.HashCodeBuilder; /** - * Models a connection between connectable components. A connection may contain - * one or more relationships that map the source component to the destination - * component. + * Models a connection between connectable components. A connection may contain one or more relationships that map the source component to the destination component. */ public final class StandardConnection implements Connection { @@ -231,10 +229,8 @@ public final class StandardConnection implements Connection { } /** - * Gives this Connection ownership of the given FlowFile and allows the - * Connection to hold on to the FlowFile but NOT provide the FlowFile to - * consumers. This allows us to ensure that the Connection is not deleted - * during the middle of a Session commit. + * Gives this Connection ownership of the given FlowFile and allows the Connection to hold on to the FlowFile but NOT provide the FlowFile to consumers. This allows us to ensure that the + * Connection is not deleted during the middle of a Session commit. * * @param flowFile to add */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FileSystemSwapManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FileSystemSwapManager.java index 3041adafff..604dba94b7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FileSystemSwapManager.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FileSystemSwapManager.java @@ -74,8 +74,7 @@ import org.slf4j.LoggerFactory; /** *

- * An implementation of the {@link FlowFileSwapManager} that swaps FlowFiles - * to/from local disk + * An implementation of the {@link FlowFileSwapManager} that swaps FlowFiles to/from local disk *

*/ public class FileSystemSwapManager implements FlowFileSwapManager { @@ -562,8 +561,7 @@ public class FileSystemSwapManager implements FlowFileSwapManager { } /** - * Recovers FlowFiles from all Swap Files, returning the largest FlowFile ID - * that was recovered. + * Recovers FlowFiles from all Swap Files, returning the largest FlowFile ID that was recovered. * * @param queueProvider provider * @return the largest FlowFile ID that was recovered diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowController.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowController.java index cf8f38d8a2..e9eeaf2d1e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowController.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowController.java @@ -584,8 +584,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R /** *

- * Causes any processors that were added to the flow with a 'delayStart' - * flag of true to now start + * Causes any processors that were added to the flow with a 'delayStart' flag of true to now start *

* * @param startDelayedComponents true if start @@ -699,17 +698,14 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R * Creates a connection between two Connectable objects. * * @param id required ID of the connection - * @param name the name of the connection, or null to leave the - * connection unnamed + * @param name the name of the connection, or null to leave the connection unnamed * @param source required source * @param destination required destination * @param relationshipNames required collection of relationship names * @return * - * @throws NullPointerException if the ID, source, destination, or set of - * relationships is null. - * @throws IllegalArgumentException if relationships is an - * empty collection + * @throws NullPointerException if the ID, source, destination, or set of relationships is null. + * @throws IllegalArgumentException if relationships is an empty collection */ public Connection createConnection(final String id, final String name, final Connectable source, final Connectable destination, final Collection relationshipNames) { final StandardConnection.Builder builder = new StandardConnection.Builder(processScheduler); @@ -751,8 +747,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R * @param name port name * @return new port * @throws NullPointerException if the ID or name is not unique - * @throws IllegalStateException if an Input Port already exists with the - * same name or id. + * @throws IllegalStateException if an Input Port already exists with the same name or id. */ public Port createLocalInputPort(String id, String name) { id = requireNonNull(id).intern(); @@ -768,8 +763,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R * @param name port name * @return new port * @throws NullPointerException if the ID or name is not unique - * @throws IllegalStateException if an Input Port already exists with the - * same name or id. + * @throws IllegalStateException if an Input Port already exists with the same name or id. */ public Port createLocalOutputPort(String id, String name) { id = requireNonNull(id).intern(); @@ -791,16 +785,14 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R /** *

- * Creates a new ProcessorNode with the given type and identifier and - * initializes it invoking the methods annotated with {@link OnAdded}. + * Creates a new ProcessorNode with the given type and identifier and initializes it invoking the methods annotated with {@link OnAdded}. *

* * @param type processor type * @param id processor id * @return new processor * @throws NullPointerException if either arg is null - * @throws ProcessorInstantiationException if the processor cannot be - * instantiated for any reason + * @throws ProcessorInstantiationException if the processor cannot be instantiated for any reason */ public ProcessorNode createProcessor(final String type, String id) throws ProcessorInstantiationException { return createProcessor(type, id, true); @@ -808,19 +800,15 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R /** *

- * Creates a new ProcessorNode with the given type and identifier and - * optionally initializes it. + * Creates a new ProcessorNode with the given type and identifier and optionally initializes it. *

* * @param type the fully qualified Processor class name * @param id the unique ID of the Processor - * @param firstTimeAdded whether or not this is the first time this - * Processor is added to the graph. If {@code true}, will invoke methods - * annotated with the {@link OnAdded} annotation. + * @param firstTimeAdded whether or not this is the first time this Processor is added to the graph. If {@code true}, will invoke methods annotated with the {@link OnAdded} annotation. * @return new processor node * @throws NullPointerException if either arg is null - * @throws ProcessorInstantiationException if the processor cannot be - * instantiated for any reason + * @throws ProcessorInstantiationException if the processor cannot be instantiated for any reason */ @SuppressWarnings("deprecation") public ProcessorNode createProcessor(final String type, String id, final boolean firstTimeAdded) throws ProcessorInstantiationException { @@ -876,8 +864,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return the ExtensionManager used for instantiating Processors, - * Prioritizers, etc. + * @return the ExtensionManager used for instantiating Processors, Prioritizers, etc. */ public ExtensionManager getExtensionManager() { return extensionManager; @@ -904,15 +891,13 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Creates a Port to use as an Input Port for the root Process Group, which - * is used for Site-to-Site communications + * Creates a Port to use as an Input Port for the root Process Group, which is used for Site-to-Site communications * * @param id port id * @param name port name * @return new port * @throws NullPointerException if the ID or name is not unique - * @throws IllegalStateException if an Input Port already exists with the - * same name or id. + * @throws IllegalStateException if an Input Port already exists with the same name or id. */ public Port createRemoteInputPort(String id, String name) { id = requireNonNull(id).intern(); @@ -923,16 +908,13 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Creates a Port to use as an Output Port for the root Process Group, which - * is used for Site-to-Site communications and will queue flow files waiting - * to be delivered to remote instances + * Creates a Port to use as an Output Port for the root Process Group, which is used for Site-to-Site communications and will queue flow files waiting to be delivered to remote instances * * @param id port id * @param name port name * @return new port * @throws NullPointerException if the ID or name is not unique - * @throws IllegalStateException if an Input Port already exists with the - * same name or id. + * @throws IllegalStateException if an Input Port already exists with the same name or id. */ public Port createRemoteOutputPort(String id, String name) { id = requireNonNull(id).intern(); @@ -943,8 +925,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Creates a new Remote Process Group with the given ID that points to the - * given URI + * Creates a new Remote Process Group with the given ID that points to the given URI * * @param id group id * @param uri group uri @@ -957,8 +938,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Verifies that no output port exists with the given id or name. If this - * does not hold true, throws an IllegalStateException + * Verifies that no output port exists with the given id or name. If this does not hold true, throws an IllegalStateException * * @param id port identifier * @throws IllegalStateException port already exists @@ -975,8 +955,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return the name of this controller, which is also the name of the Root - * Group. + * @return the name of this controller, which is also the name of the Root Group. */ public String getName() { readLock.lock(); @@ -988,8 +967,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Sets the name for the Root Group, which also changes the name for the - * controller. + * Sets the name for the Root Group, which also changes the name for the controller. * * @param name of root group */ @@ -1003,8 +981,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return the comments of this controller, which is also the comment of the - * Root Group + * @return the comments of this controller, which is also the comment of the Root Group */ public String getComments() { readLock.lock(); @@ -1018,8 +995,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R /** * Sets the comments * - * @param comments for the Root Group, which also changes the comment for - * the controller + * @param comments for the Root Group, which also changes the comment for the controller */ public void setComments(final String comments) { readLock.lock(); @@ -1031,8 +1007,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return true if the scheduling engine for this controller - * has been terminated. + * @return true if the scheduling engine for this controller has been terminated. */ public boolean isTerminated() { this.readLock.lock(); @@ -1044,16 +1019,12 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Triggers the controller to begin shutdown, stopping all processors and - * terminating the scheduling engine. After calling this method, the - * {@link #isTerminated()} method will indicate whether or not the shutdown - * has finished. + * Triggers the controller to begin shutdown, stopping all processors and terminating the scheduling engine. After calling this method, the {@link #isTerminated()} method will indicate whether or + * not the shutdown has finished. * - * @param kill if true, attempts to stop all active threads, - * but makes no guarantee that this will happen + * @param kill if true, attempts to stop all active threads, but makes no guarantee that this will happen * - * @throws IllegalStateException if the controller is already stopped or - * currently in the processor of stopping + * @throws IllegalStateException if the controller is already stopped or currently in the processor of stopping */ public void shutdown(final boolean kill) { this.shutdown = true; @@ -1152,8 +1123,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R * * @param serializer serializer * @param os stream - * @throws FlowSerializationException if serialization of the flow fails for - * any reason + * @throws FlowSerializationException if serialization of the flow fails for any reason */ public void serialize(final FlowSerializer serializer, final OutputStream os) throws FlowSerializationException { readLock.lock(); @@ -1167,21 +1137,14 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R /** * Synchronizes this controller with the proposed flow. * - * For more details, see - * {@link FlowSynchronizer#sync(FlowController, DataFlow)}. + * For more details, see {@link FlowSynchronizer#sync(FlowController, DataFlow)}. * * @param synchronizer synchronizer - * @param dataFlow the flow to load the controller with. If the flow is null - * or zero length, then the controller must not have a flow or else an - * UninheritableFlowException will be thrown. + * @param dataFlow the flow to load the controller with. If the flow is null or zero length, then the controller must not have a flow or else an UninheritableFlowException will be thrown. * - * @throws FlowSerializationException if proposed flow is not a valid flow - * configuration file - * @throws UninheritableFlowException if the proposed flow cannot be loaded - * by the controller because in doing so would risk orphaning flow files - * @throws FlowSynchronizationException if updates to the controller failed. - * If this exception is thrown, then the controller should be considered - * unsafe to be used + * @throws FlowSerializationException if proposed flow is not a valid flow configuration file + * @throws UninheritableFlowException if the proposed flow cannot be loaded by the controller because in doing so would risk orphaning flow files + * @throws FlowSynchronizationException if updates to the controller failed. If this exception is thrown, then the controller should be considered unsafe to be used */ public void synchronize(final FlowSynchronizer synchronizer, final DataFlow dataFlow) throws FlowSerializationException, FlowSynchronizationException, UninheritableFlowException { @@ -1196,8 +1159,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return the currently configured maximum number of threads that can be - * used for executing processors at any given time. + * @return the currently configured maximum number of threads that can be used for executing processors at any given time. */ public int getMaxTimerDrivenThreadCount() { return maxTimerDrivenThreads.get(); @@ -1227,8 +1189,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Updates the number of threads that can be simultaneously used for - * executing processors. + * Updates the number of threads that can be simultaneously used for executing processors. * * @param maxThreadCount * @@ -1263,8 +1224,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R * @param group the ProcessGroup that is to become the new Root Group * * @throws IllegalArgumentException if the ProcessGroup has a parent - * @throws IllegalStateException if the FlowController does not know about - * the given process group + * @throws IllegalStateException if the FlowController does not know about the given process group */ void setRootGroup(final ProcessGroup group) { if (requireNonNull(group).getParent() != null) { @@ -1295,17 +1255,13 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R // ProcessGroup access // /** - * Updates the process group corresponding to the specified DTO. Any field - * in DTO that is null (with the exception of the required ID) - * will be ignored. + * Updates the process group corresponding to the specified DTO. Any field in DTO that is null (with the exception of the required ID) will be ignored. * * @param dto group * @throws ProcessorInstantiationException * - * @throws IllegalStateException if no process group can be found with the - * ID of DTO or with the ID of the DTO's parentGroupId, if the template ID - * specified is invalid, or if the DTO's Parent Group ID changes but the - * parent group has incoming or outgoing connections + * @throws IllegalStateException if no process group can be found with the ID of DTO or with the ID of the DTO's parentGroupId, if the template ID specified is invalid, or if the DTO's Parent + * Group ID changes but the parent group has incoming or outgoing connections * * @throws NullPointerException if the DTO or its ID is null */ @@ -1331,17 +1287,13 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R // Template access // /** - * Adds a template to this controller. The contents of this template must be - * part of the current flow. This is going create a template based on a - * snippet of this flow. + * Adds a template to this controller. The contents of this template must be part of the current flow. This is going create a template based on a snippet of this flow. * * @param dto template * @return a copy of the given DTO * @throws IOException if an I/O error occurs when persisting the Template * @throws NullPointerException if the DTO is null - * @throws IllegalArgumentException if does not contain all required - * information, such as the template name or a processor's configuration - * element + * @throws IllegalArgumentException if does not contain all required information, such as the template name or a processor's configuration element */ public Template addTemplate(final TemplateDTO dto) throws IOException { return templateManager.addTemplate(dto); @@ -1357,8 +1309,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Imports the specified template into this controller. The contents of this - * template may have come from another NiFi instance. + * Imports the specified template into this controller. The contents of this template may have come from another NiFi instance. * * @param dto dto * @return template @@ -1370,8 +1321,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R /** * @param id identifier - * @return the template with the given ID, or null if no - * template exists with the given ID + * @return the template with the given ID, or null if no template exists with the given ID */ public Template getTemplate(final String id) { return templateManager.getTemplate(id); @@ -1408,21 +1358,15 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R // Snippet // /** - * Creates an instance of the given snippet and adds the components to the - * given group + * Creates an instance of the given snippet and adds the components to the given group * * @param group group * @param dto dto * * @throws NullPointerException if either argument is null - * @throws IllegalStateException if the snippet is not valid because a - * component in the snippet has an ID that is not unique to this flow, or - * because it shares an Input Port or Output Port at the root level whose - * name already exists in the given ProcessGroup, or because the Template - * contains a Processor or a Prioritizer whose class is not valid within - * this instance of NiFi. - * @throws ProcessorInstantiationException if unable to instantiate a - * processor + * @throws IllegalStateException if the snippet is not valid because a component in the snippet has an ID that is not unique to this flow, or because it shares an Input Port or Output Port at the + * root level whose name already exists in the given ProcessGroup, or because the Template contains a Processor or a Prioritizer whose class is not valid within this instance of NiFi. + * @throws ProcessorInstantiationException if unable to instantiate a processor */ public void instantiateSnippet(final ProcessGroup group, final FlowSnippetDTO dto) throws ProcessorInstantiationException { writeLock.lock(); @@ -1734,8 +1678,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Returns the parent of the specified Connectable. This only considers this - * group and any direct child sub groups. + * Returns the parent of the specified Connectable. This only considers this group and any direct child sub groups. * * @param parentGroupId group id * @return parent group @@ -1753,20 +1696,16 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R * Verifies that the given DTO is valid, according to the following: * *
    - *
  • None of the ID's in any component of the DTO can be used in this - * flow.
    • - *
  • The ProcessGroup to which the template's contents will be added must - * not contain any InputPort or OutputPort with the same name as one of the - * corresponding components in the root level of the template.
    • + *
  • None of the ID's in any component of the DTO can be used in this flow.
    • + *
  • The ProcessGroup to which the template's contents will be added must not contain any InputPort or OutputPort with the same name as one of the corresponding components in the root level of + * the template.
    • *
  • All Processors' classes must exist in this instance.
    • *
  • All Flow File Prioritizers' classes must exist in this instance.
    • *
*

* *

- * If any of the above statements does not hold true, an - * {@link IllegalStateException} or a - * {@link ProcessorInstantiationException} will be thrown. + * If any of the above statements does not hold true, an {@link IllegalStateException} or a {@link ProcessorInstantiationException} will be thrown. *

* * @param group group @@ -1877,8 +1816,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R // Processor access // /** - * Indicates whether or not the two ID's point to the same ProcessGroup. If - * either id is null, will return false. + * Indicates whether or not the two ID's point to the same ProcessGroup. If either id is null, will return false. * * @param id1 group id * @param id2 other group id @@ -2848,8 +2786,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R // Clustering methods // /** - * Starts heartbeating to the cluster. May only be called if the instance - * was constructed for a clustered environment. + * Starts heartbeating to the cluster. May only be called if the instance was constructed for a clustered environment. * * @throws IllegalStateException if not configured for clustering */ @@ -2876,31 +2813,23 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Notifies controller that the sending of heartbeats should be temporarily - * suspended. This method does not cancel any background tasks as does - * {@link #stopHeartbeating()} and does not require any lock on the - * FlowController. Background tasks will still generate heartbeat messages - * and any background task currently in the process of sending a Heartbeat - * to the cluster will continue. + * Notifies controller that the sending of heartbeats should be temporarily suspended. This method does not cancel any background tasks as does {@link #stopHeartbeating()} and does not require any + * lock on the FlowController. Background tasks will still generate heartbeat messages and any background task currently in the process of sending a Heartbeat to the cluster will continue. */ public void suspendHeartbeats() { heartbeatsSuspended.set(true); } /** - * Notifies controller that the sending of heartbeats should be re-enabled. - * This method does not submit any background tasks to take affect as does - * {@link #startHeartbeating()} and does not require any lock on the - * FlowController. + * Notifies controller that the sending of heartbeats should be re-enabled. This method does not submit any background tasks to take affect as does {@link #startHeartbeating()} and does not + * require any lock on the FlowController. */ public void resumeHeartbeats() { heartbeatsSuspended.set(false); } /** - * Stops heartbeating to the cluster. May only be called if the instance was - * constructed for a clustered environment. If the controller was not - * heartbeating, then this method has no effect. + * Stops heartbeating to the cluster. May only be called if the instance was constructed for a clustered environment. If the controller was not heartbeating, then this method has no effect. * * @throws IllegalStateException if not clustered */ @@ -2987,9 +2916,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return true if this instance is clustered; false otherwise. Clustered - * means that a node is either connected or trying to connect to the - * cluster. + * @return true if this instance is clustered; false otherwise. Clustered means that a node is either connected or trying to connect to the cluster. */ public boolean isClustered() { readLock.lock(); @@ -3001,10 +2928,8 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return the DN of the Cluster Manager that we are currently connected to, - * if available. This will return null if the instance is not clustered or - * if the instance is clustered but the NCM's DN is not available - for - * instance, if cluster communications are not secure + * @return the DN of the Cluster Manager that we are currently connected to, if available. This will return null if the instance is not clustered or if the instance is clustered but the NCM's DN + * is not available - for instance, if cluster communications are not secure */ public String getClusterManagerDN() { readLock.lock(); @@ -3016,24 +2941,20 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * Sets whether this instance is clustered. Clustered means that a node is - * either connected or trying to connect to the cluster. + * Sets whether this instance is clustered. Clustered means that a node is either connected or trying to connect to the cluster. * * @param clustered true if clustered - * @param clusterInstanceId if clustered is true, indicates the InstanceID - * of the Cluster Manager + * @param clusterInstanceId if clustered is true, indicates the InstanceID of the Cluster Manager */ public void setClustered(final boolean clustered, final String clusterInstanceId) { setClustered(clustered, clusterInstanceId, null); } /** - * Sets whether this instance is clustered. Clustered means that a node is - * either connected or trying to connect to the cluster. + * Sets whether this instance is clustered. Clustered means that a node is either connected or trying to connect to the cluster. * * @param clustered true if clustered - * @param clusterInstanceId if clustered is true, indicates the InstanceID - * of the Cluster Manager + * @param clusterInstanceId if clustered is true, indicates the InstanceID of the Cluster Manager * @param clusterManagerDn the DN of the NCM */ public void setClustered(final boolean clustered, final String clusterInstanceId, final String clusterManagerDn) { @@ -3079,8 +3000,7 @@ public class FlowController implements EventAccess, ControllerServiceProvider, R } /** - * @return true if this instance is the primary node in the cluster; false - * otherwise + * @return true if this instance is the primary node in the cluster; false otherwise */ public boolean isPrimary() { rwLock.readLock().lock(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializationException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializationException.java index f1ee76082e..444b9e5365 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializationException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializationException.java @@ -17,8 +17,7 @@ package org.apache.nifi.controller; /** - * Represents the exceptional case when flow configuration is malformed and - * therefore, cannot be serialized or deserialized. + * Represents the exceptional case when flow configuration is malformed and therefore, cannot be serialized or deserialized. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializer.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializer.java index 331b26cee8..0528674efe 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializer.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSerializer.java @@ -19,8 +19,7 @@ package org.apache.nifi.controller; import java.io.OutputStream; /** - * Serializes the flow configuration of a controller instance to an output - * stream. + * Serializes the flow configuration of a controller instance to an output stream. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizationException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizationException.java index 706ac460f3..68673b4064 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizationException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizationException.java @@ -17,8 +17,7 @@ package org.apache.nifi.controller; /** - * Represents the exceptional case when a controller managing an existing flow - * fails to fully load a different flow. + * Represents the exceptional case when a controller managing an existing flow fails to fully load a different flow. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizer.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizer.java index f6889fe67d..275f81688e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizer.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowSynchronizer.java @@ -25,27 +25,18 @@ import org.apache.nifi.encrypt.StringEncryptor; public interface FlowSynchronizer { /** - * Synchronizes the given controller with the given flow configuration. If - * loading the proposed flow configuration would cause the controller to - * orphan flow files, then an UninheritableFlowException is thrown. + * Synchronizes the given controller with the given flow configuration. If loading the proposed flow configuration would cause the controller to orphan flow files, then an + * UninheritableFlowException is thrown. * - * If the FlowSynchronizationException is thrown, then the controller may - * have changed some of its state and should no longer be used. + * If the FlowSynchronizationException is thrown, then the controller may have changed some of its state and should no longer be used. * * @param controller the flow controller - * @param dataFlow the flow to load the controller with. If the flow is null - * or zero length, then the controller must not have a flow or else an - * UninheritableFlowException will be thrown. - * @param encryptor used for the encryption/decryption of sensitive property - * values + * @param dataFlow the flow to load the controller with. If the flow is null or zero length, then the controller must not have a flow or else an UninheritableFlowException will be thrown. + * @param encryptor used for the encryption/decryption of sensitive property values * - * @throws FlowSerializationException if proposed flow is not a valid flow - * configuration file - * @throws UninheritableFlowException if the proposed flow cannot be loaded - * by the controller because in doing so would risk orphaning flow files - * @throws FlowSynchronizationException if updates to the controller failed. - * If this exception is thrown, then the controller should be considered - * unsafe to be used + * @throws FlowSerializationException if proposed flow is not a valid flow configuration file + * @throws UninheritableFlowException if the proposed flow cannot be loaded by the controller because in doing so would risk orphaning flow files + * @throws FlowSynchronizationException if updates to the controller failed. If this exception is thrown, then the controller should be considered unsafe to be used */ void sync(FlowController controller, DataFlow dataFlow, StringEncryptor encryptor) throws FlowSerializationException, UninheritableFlowException, FlowSynchronizationException; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowUnmarshaller.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowUnmarshaller.java index 7cc30396ec..cddb798b41 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowUnmarshaller.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/FlowUnmarshaller.java @@ -38,9 +38,7 @@ import org.xml.sax.SAXException; public class FlowUnmarshaller { /** - * Interprets the given byte array as an XML document that conforms to the - * Flow Configuration schema and returns a FlowSnippetDTO representing the - * flow + * Interprets the given byte array as an XML document that conforms to the Flow Configuration schema and returns a FlowSnippetDTO representing the flow * * @param flowContents contents * @param encryptor encryptor diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardFlowSynchronizer.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardFlowSynchronizer.java index b66bedcba6..5448174038 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardFlowSynchronizer.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardFlowSynchronizer.java @@ -1030,15 +1030,13 @@ public class StandardFlowSynchronizer implements FlowSynchronizer { } /** - * Returns true if the given controller can inherit the proposed flow - * without orphaning flow files. + * Returns true if the given controller can inherit the proposed flow without orphaning flow files. * * @param existingFlow flow * @param controller the running controller * @param proposedFlow the flow to inherit * - * @return null if the controller can inherit the specified flow, an - * explanation of why it cannot be inherited otherwise + * @return null if the controller can inherit the specified flow, an explanation of why it cannot be inherited otherwise * * @throws FingerprintException if flow fingerprints could not be generated */ @@ -1080,14 +1078,12 @@ public class StandardFlowSynchronizer implements FlowSynchronizer { } /** - * Returns true if the given controller can inherit the proposed flow - * without orphaning flow files. + * Returns true if the given controller can inherit the proposed flow without orphaning flow files. * * @param existingFlow flow * @param proposedFlow the flow to inherit * - * @return null if the controller can inherit the specified flow, an - * explanation of why it cannot be inherited otherwise + * @return null if the controller can inherit the specified flow, an explanation of why it cannot be inherited otherwise * * @throws FingerprintException if flow fingerprints could not be generated */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java index eb7ec83a49..7820b7b201 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/StandardProcessorNode.java @@ -67,10 +67,8 @@ import org.quartz.CronExpression; import org.slf4j.LoggerFactory; /** - * ProcessorNode provides thread-safe access to a FlowFileProcessor as it exists - * within a controlled flow. This node keeps track of the processor, its - * scheduling information and its relationships to other processors and whatever - * scheduled futures exist for it. Must be thread safe. + * ProcessorNode provides thread-safe access to a FlowFileProcessor as it exists within a controlled flow. This node keeps track of the processor, its scheduling information and its relationships to + * other processors and whatever scheduled futures exist for it. Must be thread safe. * * @author none */ @@ -171,8 +169,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * Provides and opportunity to retain information about this particular - * processor instance + * Provides and opportunity to retain information about this particular processor instance * * @param comments new comments */ @@ -222,8 +219,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return if true flow file content generated by this processor is - * considered loss tolerant + * @return if true flow file content generated by this processor is considered loss tolerant */ @Override public boolean isLossTolerant() { @@ -236,8 +232,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return true if the processor has the {@link TriggerWhenEmpty} - * annotation, false otherwise. + * @return true if the processor has the {@link TriggerWhenEmpty} annotation, false otherwise. */ @Override public boolean isTriggerWhenEmpty() { @@ -245,8 +240,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return true if the processor has the {@link SideEffectFree} annotation, - * false otherwise. + * @return true if the processor has the {@link SideEffectFree} annotation, false otherwise. */ @Override public boolean isSideEffectFree() { @@ -259,8 +253,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return true if the processor has the - * {@link TriggerWhenAnyDestinationAvailable} annotation, false otherwise. + * @return true if the processor has the {@link TriggerWhenAnyDestinationAvailable} annotation, false otherwise. */ @Override public boolean isTriggerWhenAnyDestinationAvailable() { @@ -268,8 +261,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * Indicates whether flow file content made by this processor must be - * persisted + * Indicates whether flow file content made by this processor must be persisted * * @param lossTolerant tolerant */ @@ -332,8 +324,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return an unmodifiable Set that contains all of the - * ProcessorRelationship objects that are configured to be auto-terminated + * @return an unmodifiable Set that contains all of the ProcessorRelationship objects that are configured to be auto-terminated */ @Override public Set getAutoTerminatedRelationships() { @@ -350,8 +341,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return the value of the processor's {@link CapabilityDescription} - * annotation, if one exists, else null. + * @return the value of the processor's {@link CapabilityDescription} annotation, if one exists, else null. */ @SuppressWarnings("deprecation") public String getProcessorDescription() { @@ -384,11 +374,8 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @param timeUnit determines the unit of time to represent the scheduling - * period. If null will be reported in units of - * {@link #DEFAULT_SCHEDULING_TIME_UNIT} - * @return the schedule period that should elapse before subsequent cycles - * of this processor's tasks + * @param timeUnit determines the unit of time to represent the scheduling period. If null will be reported in units of {@link #DEFAULT_SCHEDULING_TIME_UNIT} + * @return the schedule period that should elapse before subsequent cycles of this processor's tasks */ @Override public long getSchedulingPeriod(final TimeUnit timeUnit) { @@ -410,8 +397,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable * * @param schedulingStrategy strategy * - * @throws IllegalArgumentException if the SchedulingStrategy is not not - * applicable for this Processor + * @throws IllegalArgumentException if the SchedulingStrategy is not not applicable for this Processor */ @Override public void setSchedulingStrategy(final SchedulingStrategy schedulingStrategy) { @@ -538,10 +524,8 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * Causes the processor not to be scheduled for some period of time. This - * duration can be obtained and set via the - * {@link #getYieldPeriod(TimeUnit)} and - * {@link #setYieldPeriod(long, TimeUnit)} methods. + * Causes the processor not to be scheduled for some period of time. This duration can be obtained and set via the {@link #getYieldPeriod(TimeUnit)} and {@link #setYieldPeriod(long, TimeUnit)} + * methods. */ @Override public void yield() { @@ -561,8 +545,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return the number of milliseconds since Epoch at which time this - * processor is to once again be scheduled. + * @return the number of milliseconds since Epoch at which time this processor is to once again be scheduled. */ @Override public long getYieldExpiration() { @@ -597,11 +580,9 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * Determines the number of concurrent tasks that may be running for this - * processor. + * Determines the number of concurrent tasks that may be running for this processor. * - * @param taskCount a number of concurrent tasks this processor may have - * running + * @param taskCount a number of concurrent tasks this processor may have running * @throws IllegalArgumentException if the given value is less than 1 */ @Override @@ -628,8 +609,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return the number of tasks that may execute concurrently for this - * processor + * @return the number of tasks that may execute concurrently for this processor */ @Override public int getMaxConcurrentTasks() { @@ -857,8 +837,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable /** * @param relationshipName name - * @return the relationship for this nodes processor for the given name or - * creates a new relationship for the given name + * @return the relationship for this nodes processor for the given name or creates a new relationship for the given name */ @Override public Relationship getRelationship(final String relationshipName) { @@ -885,8 +864,7 @@ public class StandardProcessorNode extends ProcessorNode implements Connectable } /** - * @return the Set of destination processors for all relationships excluding - * any destinations that are this processor itself (self-loops) + * @return the Set of destination processors for all relationships excluding any destinations that are this processor itself (self-loops) */ public Set getDestinations() { final Set nonSelfDestinations = new HashSet<>(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/TemplateManager.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/TemplateManager.java index 6a11a334f8..7b8e173ff0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/TemplateManager.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/TemplateManager.java @@ -98,18 +98,14 @@ public class TemplateManager { } /** - * Adds a template to this manager. The contents of this template must be - * part of the current flow. This is going create a template based on a - * snippet of this flow. Any sensitive properties in the TemplateDTO will be - * removed. + * Adds a template to this manager. The contents of this template must be part of the current flow. This is going create a template based on a snippet of this flow. Any sensitive properties in the + * TemplateDTO will be removed. * * @param dto dto * @return a copy of the given DTO * @throws IOException if an I/O error occurs when persisting the Template * @throws NullPointerException if the DTO is null - * @throws IllegalArgumentException if does not contain all required - * information, such as the template name or a processor's configuration - * element + * @throws IllegalArgumentException if does not contain all required information, such as the template name or a processor's configuration element */ public Template addTemplate(final TemplateDTO dto) throws IOException { scrubTemplate(dto.getSnippet()); @@ -246,8 +242,7 @@ public class TemplateManager { } /** - * Scrubs the template prior to persisting in order to remove fields that - * shouldn't be included or are unnecessary. + * Scrubs the template prior to persisting in order to remove fields that shouldn't be included or are unnecessary. * * @param snippet snippet */ @@ -294,8 +289,7 @@ public class TemplateManager { } /** - * Scrubs processors prior to saving. This includes removing sensitive - * properties, validation errors, property descriptors, etc. + * Scrubs processors prior to saving. This includes removing sensitive properties, validation errors, property descriptors, etc. * * @param processors procs */ @@ -348,8 +342,7 @@ public class TemplateManager { } /** - * Scrubs connections prior to saving. This includes removing available - * relationships. + * Scrubs connections prior to saving. This includes removing available relationships. * * @param connections conns */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/UninheritableFlowException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/UninheritableFlowException.java index ac6fc5f3bb..2f9f0f8759 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/UninheritableFlowException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/UninheritableFlowException.java @@ -17,8 +17,7 @@ package org.apache.nifi.controller; /** - * Represents the exceptional case when a controller is to be loaded with a flow - * that is fundamentally different than its existing flow. + * Represents the exceptional case when a controller is to be loaded with a flow that is fundamentally different than its existing flow. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/FileSystemRepository.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/FileSystemRepository.java index d69b417932..e212bdbf38 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/FileSystemRepository.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/FileSystemRepository.java @@ -1280,9 +1280,7 @@ public class FileSystemRepository implements ContentRepository { } /** - * @return {@code true} if wait is required to create claims against - * this Container, based on whether or not the container has reached its - * back pressure threshold + * @return {@code true} if wait is required to create claims against this Container, based on whether or not the container has reached its back pressure threshold */ public boolean isWaitRequired() { if (!archiveEnabled) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProcessContext.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProcessContext.java index 7502641eec..1937d0de89 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProcessContext.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProcessContext.java @@ -77,9 +77,7 @@ public class ProcessContext { } /** - * @return an unmodifiable list containing a copy of all incoming - * connections for the processor from which FlowFiles are allowed to be - * pulled + * @return an unmodifiable list containing a copy of all incoming connections for the processor from which FlowFiles are allowed to be pulled */ List getPollableConnections() { if (pollFromSelfLoopsOnly()) { @@ -106,9 +104,7 @@ public class ProcessContext { } /** - * @return true if we are allowed to take FlowFiles only from self-loops. - * This is the case when no Relationships are available except for - * self-looping Connections + * @return true if we are allowed to take FlowFiles only from self-loops. This is the case when no Relationships are available except for self-looping Connections */ private boolean pollFromSelfLoopsOnly() { if (isTriggerWhenAnyDestinationAvailable()) { @@ -217,14 +213,10 @@ public class ProcessContext { } /** - * A Relationship is said to be Available if and only if all Connections for - * that Relationship are either self-loops or have non-full queues. + * A Relationship is said to be Available if and only if all Connections for that Relationship are either self-loops or have non-full queues. * - * @param requiredNumber minimum number of relationships that must have - * availability - * @return Checks if at least requiredNumber of - * Relationationships are "available." If so, returns true, - * otherwise returns false + * @param requiredNumber minimum number of relationships that must have availability + * @return Checks if at least requiredNumber of Relationationships are "available." If so, returns true, otherwise returns false */ public boolean isRelationshipAvailabilitySatisfied(final int requiredNumber) { int unavailable = 0; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProvenanceEventEnricher.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProvenanceEventEnricher.java index db098fcd6f..323bfb0b51 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProvenanceEventEnricher.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/ProvenanceEventEnricher.java @@ -22,8 +22,7 @@ import org.apache.nifi.provenance.ProvenanceEventRecord; public interface ProvenanceEventEnricher { /** - * Returns a new Provenance event that has been updated to contain the - * original and updated FlowFile attributes and content claim information. + * Returns a new Provenance event that has been updated to contain the original and updated FlowFile attributes and content claim information. * * @param record record * @param flowFile flowfile diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/RepositoryPurgeException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/RepositoryPurgeException.java index e668be3b52..710bb79a4a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/RepositoryPurgeException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/RepositoryPurgeException.java @@ -17,8 +17,7 @@ package org.apache.nifi.controller.repository; /** - * This exception is thrown when a flow file repository was unable to be - * properly purged. + * This exception is thrown when a flow file repository was unable to be properly purged. * * */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardFlowFileRecord.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardFlowFileRecord.java index 433c3d2599..6bb5e358e9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardFlowFileRecord.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardFlowFileRecord.java @@ -37,9 +37,7 @@ import org.apache.commons.lang3.builder.ToStringStyle; /** *

- * A flow file is a logical notion of an item in a flow with its associated - * attributes and identity which can be used as a reference for its actual - * content.

+ * A flow file is a logical notion of an item in a flow with its associated attributes and identity which can be used as a reference for its actual content.

* * Immutable - Thread Safe * @@ -127,8 +125,7 @@ public final class StandardFlowFileRecord implements FlowFile, FlowFileRecord { } /** - * Provides the natural ordering for FlowFile objects which is based on - * their identifier. + * Provides the natural ordering for FlowFile objects which is based on their identifier. * * @param other other * @return standard compare contract diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProcessSession.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProcessSession.java index 4827ab7ff8..d3b0690bfc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProcessSession.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProcessSession.java @@ -81,9 +81,7 @@ import org.slf4j.LoggerFactory; /** *

- * Provides a ProcessSession that ensures all accesses, changes and transfers - * occur in an atomic manner for all FlowFiles including their contents and - * attributes

+ * Provides a ProcessSession that ensures all accesses, changes and transfers occur in an atomic manner for all FlowFiles including their contents and attributes

*

* NOT THREAD SAFE

*

@@ -770,10 +768,8 @@ public final class StandardProcessSession implements ProcessSession, ProvenanceE } /** - * Checks if the given event is a spurious FORK, meaning that the FORK has a - * single child and that child was removed in this session. This happens - * when a Processor calls #create(FlowFile) and then removes the created - * FlowFile. + * Checks if the given event is a spurious FORK, meaning that the FORK has a single child and that child was removed in this session. This happens when a Processor calls #create(FlowFile) and then + * removes the created FlowFile. * * @param event event * @return true if spurious fork @@ -790,10 +786,8 @@ public final class StandardProcessSession implements ProcessSession, ProvenanceE } /** - * Checks if the given event is a spurious ROUTE, meaning that the ROUTE - * indicates that a FlowFile was routed to a relationship with only 1 - * connection and that Connection is the Connection from which the FlowFile - * was pulled. I.e., the FlowFile was really routed nowhere. + * Checks if the given event is a spurious ROUTE, meaning that the ROUTE indicates that a FlowFile was routed to a relationship with only 1 connection and that Connection is the Connection from + * which the FlowFile was pulled. I.e., the FlowFile was really routed nowhere. * * @param event event * @param records records @@ -2085,13 +2079,10 @@ public final class StandardProcessSession implements ProcessSession, ProvenanceE } /** - * Checks if the ContentClaim associated with this record should be removed, - * since the record is about to be updated to point to a new content claim. - * If so, removes the working claim. + * Checks if the ContentClaim associated with this record should be removed, since the record is about to be updated to point to a new content claim. If so, removes the working claim. * - * This happens if & only if the content of this FlowFile has been modified - * since it was last committed to the FlowFile repository, because this - * indicates that the content is no longer needed and should be cleaned up. + * This happens if & only if the content of this FlowFile has been modified since it was last committed to the FlowFile repository, because this indicates that the content is no longer needed and + * should be cleaned up. * * @param record record */ @@ -2155,8 +2146,7 @@ public final class StandardProcessSession implements ProcessSession, ProvenanceE } /** - * @return Indicates whether or not multiple FlowFiles should be merged into - * a single ContentClaim + * @return Indicates whether or not multiple FlowFiles should be merged into a single ContentClaim */ private boolean isMergeContent() { if (writeRecursionLevel > 0) { @@ -2573,8 +2563,7 @@ public final class StandardProcessSession implements ProcessSession, ProvenanceE } /** - * Returns the attributes that are common to every FlowFile given. The key - * and value must match exactly. + * Returns the attributes that are common to every FlowFile given. The key and value must match exactly. * * @param flowFileList a list of FlowFiles * @@ -2629,8 +2618,7 @@ public final class StandardProcessSession implements ProcessSession, ProvenanceE } /** - * Callback interface used to poll a FlowFileQueue, in order to perform - * functional programming-type of polling a queue + * Callback interface used to poll a FlowFileQueue, in order to perform functional programming-type of polling a queue */ private static interface QueuePoller { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProvenanceReporter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProvenanceReporter.java index 5e8bb3ea21..a55fb258b0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProvenanceReporter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardProvenanceReporter.java @@ -67,10 +67,8 @@ public class StandardProvenanceReporter implements ProvenanceReporter { } /** - * Generates a Fork event for the given child and parents but does not - * register the event. This is useful so that a ProcessSession has the - * ability to de-dupe events, since one or more events may be created by the - * session itself, as well as by the Processor + * Generates a Fork event for the given child and parents but does not register the event. This is useful so that a ProcessSession has the ability to de-dupe events, since one or more events may + * be created by the session itself, as well as by the Processor * * @param parents parents * @param child child diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryRecord.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryRecord.java index c965ed8315..5fcb35a030 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryRecord.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryRecord.java @@ -37,8 +37,7 @@ public class StandardRepositoryRecord implements RepositoryRecord { private final Map originalAttributes; /** - * Creates a new record which has no original claim or flow file - it is - * entirely new + * Creates a new record which has no original claim or flow file - it is entirely new * * @param originalQueue queue */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryStatusReport.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryStatusReport.java index 4e41de1b3c..3e3005956d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryStatusReport.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/StandardRepositoryStatusReport.java @@ -21,8 +21,7 @@ import java.util.HashMap; import java.util.Map; /** - * Encapsulates the status of the processor data transfers as stored in the - * repository. + * Encapsulates the status of the processor data transfers as stored in the repository. */ public class StandardRepositoryStatusReport implements RepositoryStatusReport { @@ -30,8 +29,7 @@ public class StandardRepositoryStatusReport implements RepositoryStatusReport { } /** - * Returns a map where the key is the processor ID and the value is the - * status entry for the processor. + * Returns a map where the key is the processor ID and the value is the status entry for the processor. * * @return a map of report entries */ @@ -41,11 +39,9 @@ public class StandardRepositoryStatusReport implements RepositoryStatusReport { } /** - * Returns a particular entry for a given processor ID. If the processor ID - * does not exist, then null is returned. + * Returns a particular entry for a given processor ID. If the processor ID does not exist, then null is returned. * - * @param componentId the ID of a component; that component may be a - * Processor, a Connection, a ProcessGroup, etc. + * @param componentId the ID of a component; that component may be a Processor, a Connection, a ProcessGroup, etc. * * @return a status entry */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileContentRepository.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileContentRepository.java index 65756f448a..597186547c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileContentRepository.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileContentRepository.java @@ -54,33 +54,24 @@ import org.slf4j.LoggerFactory; /** *

- * An in-memory implementation of the {@link ContentRepository} interface. This - * implementation stores FlowFile content in the Java heap and keeps track of - * the number of bytes used. If the number of bytes used by FlowFile content - * exceeds some threshold (configured via the - * nifi.volatile.content.repository.max.size property in the NiFi - * properties with a default of 100 MB), one of two situations will occur: + * An in-memory implementation of the {@link ContentRepository} interface. This implementation stores FlowFile content in the Java heap and keeps track of the number of bytes used. If the number of + * bytes used by FlowFile content exceeds some threshold (configured via the nifi.volatile.content.repository.max.size property in the NiFi properties with a default of 100 MB), one of + * two situations will occur: *

* *
    - *
  • Backup Repository: If a Backup Repository has been specified (via - * the {@link #setBackupRepository(ContentRepository)} method), the content will - * be stored in the backup repository and all access to the FlowFile content - * will automatically and transparently be proxied to the backup repository. + *
  • Backup Repository: If a Backup Repository has been specified (via the {@link #setBackupRepository(ContentRepository)} method), the content will be stored in the backup repository and all + * access to the FlowFile content will automatically and transparently be proxied to the backup repository. *
    • *
  • - * Without Backup Repository: If no Backup Repository has been specified, - * when the threshold is exceeded, an IOException will be thrown. + * Without Backup Repository: If no Backup Repository has been specified, when the threshold is exceeded, an IOException will be thrown. *
    • *
* *

- * When a Content Claim is created via the {@link #create(boolean)} method, if - * the lossTolerant flag is set to false, the Backup - * Repository will be used to create the Content Claim and any accesses to the - * ContentClaim will be proxied to the Backup Repository. If the Backup - * Repository has not been specified, attempting to create a non-loss-tolerant - * ContentClaim will result in an {@link IllegalStateException} being thrown. + * When a Content Claim is created via the {@link #create(boolean)} method, if the lossTolerant flag is set to false, the Backup Repository will be used to create the Content + * Claim and any accesses to the ContentClaim will be proxied to the Backup Repository. If the Backup Repository has not been specified, attempting to create a non-loss-tolerant ContentClaim will + * result in an {@link IllegalStateException} being thrown. *

*/ public class VolatileContentRepository implements ContentRepository { @@ -144,8 +135,7 @@ public class VolatileContentRepository implements ContentRepository { } /** - * Specifies a Backup Repository where data should be written if this - * Repository fills up + * Specifies a Backup Repository where data should be written if this Repository fills up * * @param backup repo backup */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileFlowFileRepository.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileFlowFileRepository.java index 9e429d6b50..fe34fe05a8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileFlowFileRepository.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/VolatileFlowFileRepository.java @@ -26,9 +26,7 @@ import org.apache.nifi.controller.repository.claim.ContentClaimManager; /** *

- * An in-memory implementation of the {@link FlowFileRepository}. Upon restart, - * all FlowFiles will be discarded, including those that have been swapped out - * by a {@link FlowFileSwapManager}. + * An in-memory implementation of the {@link FlowFileRepository}. Upon restart, all FlowFiles will be discarded, including those that have been swapped out by a {@link FlowFileSwapManager}. *

*/ public class VolatileFlowFileRepository implements FlowFileRepository { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/WriteAheadFlowFileRepository.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/WriteAheadFlowFileRepository.java index 0779c4dbde..f2df8216a9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/WriteAheadFlowFileRepository.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/WriteAheadFlowFileRepository.java @@ -62,21 +62,12 @@ import org.wali.WriteAheadRepository; *

* *

- * We expose a property named nifi.flowfile.repository.always.sync - * that is a boolean value indicating whether or not to force WALI to sync with - * disk on each update. By default, the value is false. This is - * needed only in situations in which power loss is expected and not mitigated - * by Uninterruptable Power Sources (UPS) or when running in an unstable Virtual - * Machine for instance. Otherwise, we will flush the data that is written to - * the Operating System and the Operating System will be responsible to flush - * its buffers when appropriate. The Operating System can be configured to hold - * only a certain buffer size or not to buffer at all, as well. When using a - * UPS, this is generally not an issue, as the machine is typically notified - * before dying, in which case the Operating System will flush the data to disk. - * Additionally, most disks on enterprise servers also have battery backups that - * can power the disks long enough to flush their buffers. For this reason, we - * choose instead to not sync to disk for every write but instead sync only when - * we checkpoint. + * We expose a property named nifi.flowfile.repository.always.sync that is a boolean value indicating whether or not to force WALI to sync with disk on each update. By default, the value + * is false. This is needed only in situations in which power loss is expected and not mitigated by Uninterruptable Power Sources (UPS) or when running in an unstable Virtual Machine for + * instance. Otherwise, we will flush the data that is written to the Operating System and the Operating System will be responsible to flush its buffers when appropriate. The Operating System can be + * configured to hold only a certain buffer size or not to buffer at all, as well. When using a UPS, this is generally not an issue, as the machine is typically notified before dying, in which case + * the Operating System will flush the data to disk. Additionally, most disks on enterprise servers also have battery backups that can power the disks long enough to flush their buffers. For this + * reason, we choose instead to not sync to disk for every write but instead sync only when we checkpoint. *

*/ public class WriteAheadFlowFileRepository implements FlowFileRepository, SyncListener { @@ -263,9 +254,7 @@ public class WriteAheadFlowFileRepository implements FlowFileRepository, SyncLis } /** - * Swaps the FlowFiles that live on the given Connection out to disk, using - * the specified Swap File and returns the number of FlowFiles that were - * persisted. + * Swaps the FlowFiles that live on the given Connection out to disk, using the specified Swap File and returns the number of FlowFiles that were persisted. * * @param queue queue to swap out * @param swapLocation location to swap to diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/ContentDirection.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/ContentDirection.java index b5d70b2d93..83901ef0b3 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/ContentDirection.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/ContentDirection.java @@ -17,19 +17,16 @@ package org.apache.nifi.controller.repository.claim; /** - * Specifies one side of the Provenance Event for which the Content Claim is - * being referenced + * Specifies one side of the Provenance Event for which the Content Claim is being referenced */ public enum ContentDirection { /** - * Indicates the Content Claim that was the Input to the Process that - * generating a Provenance Event + * Indicates the Content Claim that was the Input to the Process that generating a Provenance Event */ INPUT, /** - * Indicates the Content Claim that is the Output of the process that - * generated the Provenance Event. + * Indicates the Content Claim that is the Output of the process that generated the Provenance Event. */ OUTPUT; } diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/StandardContentClaim.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/StandardContentClaim.java index 54a1b2c3e0..a8a69639fd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/StandardContentClaim.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/claim/StandardContentClaim.java @@ -20,9 +20,7 @@ import java.util.concurrent.atomic.AtomicInteger; /** *

- * A ContentClaim is a reference to a given flow file's content. Multiple flow - * files may reference the same content by both having the same content - * claim.

+ * A ContentClaim is a reference to a given flow file's content. Multiple flow files may reference the same content by both having the same content claim.

* *

* Must be thread safe

@@ -88,8 +86,7 @@ public final class StandardContentClaim implements ContentClaim, Comparable - * Wraps an InputStream so that if any IOException is thrown, it will be wrapped - * in a FlowFileAccessException. We do this to isolate IOExceptions thrown by - * the framework from those thrown by user code. If thrown by the framework, it - * generally indicates a problem communicating with the Content Repository and - * session rollback is often appropriate so that the FlowFile can be processed - * again. + * Wraps an InputStream so that if any IOException is thrown, it will be wrapped in a FlowFileAccessException. We do this to isolate IOExceptions thrown by the framework from those thrown by user + * code. If thrown by the framework, it generally indicates a problem communicating with the Content Repository and session rollback is often appropriate so that the FlowFile can be processed again. *

*/ public class FlowFileAccessInputStream extends FilterInputStream { @@ -56,8 +52,7 @@ public class FlowFileAccessInputStream extends FilterInputStream { } /** - * @return the ContentNotFoundException that was thrown by this stream, or - * null if no such Exception was thrown + * @return the ContentNotFoundException that was thrown by this stream, or null if no such Exception was thrown */ public ContentNotFoundException getContentNotFoundException() { return thrown; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/FlowFileAccessOutputStream.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/FlowFileAccessOutputStream.java index 744e3a609c..f4edcfeb88 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/FlowFileAccessOutputStream.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/FlowFileAccessOutputStream.java @@ -25,12 +25,9 @@ import org.apache.nifi.processor.exception.FlowFileAccessException; /** *

- * Wraps an OutputStream so that if any IOException is thrown, it will be - * wrapped in a FlowFileAccessException. We do this to isolate IOExceptions - * thrown by the framework from those thrown by user code. If thrown by the - * framework, it generally indicates a problem communicating with the Content - * Repository (such as out of disk space) and session rollback is often - * appropriate so that the FlowFile can be processed again. + * Wraps an OutputStream so that if any IOException is thrown, it will be wrapped in a FlowFileAccessException. We do this to isolate IOExceptions thrown by the framework from those thrown by user + * code. If thrown by the framework, it generally indicates a problem communicating with the Content Repository (such as out of disk space) and session rollback is often appropriate so that the + * FlowFile can be processed again. *

*/ public class FlowFileAccessOutputStream extends FilterOutputStream { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/LongHolder.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/LongHolder.java index 932cf9c262..bd5fec13fd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/LongHolder.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/repository/io/LongHolder.java @@ -17,10 +17,8 @@ package org.apache.nifi.controller.repository.io; /** - * Class to hold a long value that can be incremented and decremented. This - * allows the abstraction of passing a long value by reference, rather than by - * value, without the overhead of synchronization required by the use of an - * AtomicLong. + * Class to hold a long value that can be incremented and decremented. This allows the abstraction of passing a long value by reference, rather than by value, without the overhead of synchronization + * required by the use of an AtomicLong. */ public class LongHolder { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ConnectableProcessContext.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ConnectableProcessContext.java index 01285b0aca..7617e7c8ed 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ConnectableProcessContext.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ConnectableProcessContext.java @@ -39,8 +39,7 @@ import org.apache.nifi.processor.Relationship; import org.apache.nifi.processor.exception.ProcessException; /** - * This class is essentially an empty shell for {@link Connectable}s that are - * not Processors + * This class is essentially an empty shell for {@link Connectable}s that are not Processors */ public class ConnectableProcessContext implements ProcessContext { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ScheduleState.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ScheduleState.java index cb7f55f1a1..ea0b4564f6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ScheduleState.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/ScheduleState.java @@ -62,12 +62,11 @@ public class ScheduleState { } /** - * Maintains an AtomicBoolean so that the first thread to call this method - * after a Processor is no longer scheduled to run will receive a - * true and MUST call the methods annotated with @OnStopped + * Maintains an AtomicBoolean so that the first thread to call this method after a Processor is no longer scheduled to run will receive a true and MUST call the methods annotated with * - * @return true if the caller is required to call Processor - * methods annotated with + * @OnStopped + * + * @return true if the caller is required to call Processor methods annotated with * @OnStopped, false otherwise */ public boolean mustCallOnStoppedMethods() { @@ -75,8 +74,7 @@ public class ScheduleState { } /** - * Establishes the list of relevant futures for this processor. Replaces any - * previously held futures. + * Establishes the list of relevant futures for this processor. Replaces any previously held futures. * * @param newFutures futures */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java index bb565cbc4c..ffa669d55a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/scheduling/StandardProcessScheduler.java @@ -69,8 +69,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Responsible for scheduling Processors, Ports, and Funnels to run at regular - * intervals + * Responsible for scheduling Processors, Ports, and Funnels to run at regular intervals */ public final class StandardProcessScheduler implements ProcessScheduler { @@ -257,10 +256,8 @@ public final class StandardProcessScheduler implements ProcessScheduler { } /** - * Starts scheduling the given processor to run after invoking all methods - * on the underlying {@link nifi.processor.Processor - * FlowFileProcessor} that are annotated with the {@link OnScheduled} - * annotation. + * Starts scheduling the given processor to run after invoking all methods on the underlying {@link nifi.processor.Processor + * FlowFileProcessor} that are annotated with the {@link OnScheduled} annotation. */ @Override public synchronized void startProcessor(final ProcessorNode procNode) { @@ -379,9 +376,8 @@ public final class StandardProcessScheduler implements ProcessScheduler { } /** - * Stops scheduling the given processor to run and invokes all methods on - * the underlying {@link nifi.processor.Processor FlowFileProcessor} that - * are annotated with the {@link OnUnscheduled} annotation. + * Stops scheduling the given processor to run and invokes all methods on the underlying {@link nifi.processor.Processor FlowFileProcessor} that are annotated with the {@link OnUnscheduled} + * annotation. */ @Override public synchronized void stopProcessor(final ProcessorNode procNode) { @@ -577,9 +573,7 @@ public final class StandardProcessScheduler implements ProcessScheduler { } /** - * Returns the ScheduleState that is registered for the given component; if - * no ScheduleState current is registered, one is created and registered - * atomically, and then that value is returned. + * Returns the ScheduleState that is registered for the given component; if no ScheduleState current is registered, one is created and registered atomically, and then that value is returned. * * @param schedulable schedulable * @return scheduled state diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceProvider.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceProvider.java index a45bf7686b..d8506c1351 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceProvider.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/service/StandardControllerServiceProvider.java @@ -518,10 +518,8 @@ public class StandardControllerServiceProvider implements ControllerServiceProvi } /** - * Returns a List of all components that reference the given referencedNode - * (either directly or indirectly through another service) that are also of - * the given componentType. The list that is returned is in the order in - * which they will need to be 'activated' (enabled/started). + * Returns a List of all components that reference the given referencedNode (either directly or indirectly through another service) that are also of the given componentType. The list that is + * returned is in the order in which they will need to be 'activated' (enabled/started). * * @param referencedNode node * @param componentType type diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/status/history/StandardStatusSnapshot.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/status/history/StandardStatusSnapshot.java index e1fdca8987..abaf899316 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/status/history/StandardStatusSnapshot.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/status/history/StandardStatusSnapshot.java @@ -53,7 +53,7 @@ public class StandardStatusSnapshot implements StatusSnapshot { public StatusSnapshot reduce(final List values) { Date reducedTimestamp = null; final Set> allDescriptors = new LinkedHashSet<>(metricValues.keySet()); - + for (final StatusSnapshot statusSnapshot : values) { if (reducedTimestamp == null) { reducedTimestamp = statusSnapshot.getTimestamp(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunConnectableTask.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunConnectableTask.java index f3cbb90d6d..a824ad0dc2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunConnectableTask.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunConnectableTask.java @@ -35,9 +35,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Continually runs a Connectable as long as the processor has work to do. - * {@link #call()} will return true if the Connectable should be - * yielded, false otherwise. + * Continually runs a Connectable as long as the processor has work to do. {@link #call()} will return true if the Connectable should be yielded, false otherwise. */ public class ContinuallyRunConnectableTask implements Callable { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunProcessorTask.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunProcessorTask.java index baed6ae5e3..efa5814e21 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunProcessorTask.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ContinuallyRunProcessorTask.java @@ -44,9 +44,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Continually runs a processor as long as the processor has work to do. - * {@link #call()} will return true if the processor should be - * yielded, false otherwise. + * Continually runs a processor as long as the processor has work to do. {@link #call()} will return true if the processor should be yielded, false otherwise. */ public class ContinuallyRunProcessorTask implements Callable { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ExpireFlowFiles.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ExpireFlowFiles.java index a351a6834f..7d8bcece47 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ExpireFlowFiles.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/tasks/ExpireFlowFiles.java @@ -34,9 +34,7 @@ import org.apache.nifi.groups.RemoteProcessGroup; import org.apache.nifi.util.FormatUtils; /** - * This task runs through all Connectable Components and goes through its - * incoming queues, polling for FlowFiles and accepting none. This causes the - * desired side effect of expiring old FlowFiles. + * This task runs through all Connectable Components and goes through its incoming queues, polling for FlowFiles and accepting none. This causes the desired side effect of expiring old FlowFiles. */ public class ExpireFlowFiles implements Runnable { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/encrypt/StringEncryptor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/encrypt/StringEncryptor.java index fccd10ee31..5de1bebc40 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/encrypt/StringEncryptor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/encrypt/StringEncryptor.java @@ -26,16 +26,14 @@ import org.jasypt.exceptions.EncryptionOperationNotPossibleException; /** *

- * An application specific string encryptor that collects configuration from the - * application properties, system properties, and/or system environment. + * An application specific string encryptor that collects configuration from the application properties, system properties, and/or system environment. *

* *

* Instance of this class are thread-safe

* *

- * The encryption provider and algorithm is configured using the application - * properties: + * The encryption provider and algorithm is configured using the application properties: *

    *
  • nifi.sensitive.props.provider
    • *
  • nifi.sensitive.props.algorithm
    • @@ -73,12 +71,10 @@ public final class StringEncryptor { } /** - * Creates an instance of the nifi sensitive property encryptor. Validates - * that the encryptor is actually working. + * Creates an instance of the nifi sensitive property encryptor. Validates that the encryptor is actually working. * * @return encryptor - * @throws EncryptionException if any issues arise initializing or - * validating the encryptor + * @throws EncryptionException if any issues arise initializing or validating the encryptor */ public static StringEncryptor createEncryptor() throws EncryptionException { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/engine/FlowEngine.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/engine/FlowEngine.java index 3be178f6aa..d407e2f692 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/engine/FlowEngine.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/engine/FlowEngine.java @@ -34,8 +34,7 @@ public final class FlowEngine extends ScheduledThreadPoolExecutor { /** * Creates a new instance of FlowEngine * - * @param corePoolSize the maximum number of threads available to tasks - * running in the engine. + * @param corePoolSize the maximum number of threads available to tasks running in the engine. * @param threadNamePrefix for naming the thread */ public FlowEngine(int corePoolSize, final String threadNamePrefix) { @@ -45,11 +44,9 @@ public final class FlowEngine extends ScheduledThreadPoolExecutor { /** * Creates a new instance of FlowEngine * - * @param corePoolSize the maximum number of threads available to tasks - * running in the engine. + * @param corePoolSize the maximum number of threads available to tasks running in the engine. * @param threadNamePrefix for thread naming - * @param daemon if true, the thread pool will be populated with daemon - * threads, otherwise the threads will not be marked as daemon. + * @param daemon if true, the thread pool will be populated with daemon threads, otherwise the threads will not be marked as daemon. */ public FlowEngine(int corePoolSize, final String threadNamePrefix, final boolean daemon) { super(corePoolSize); @@ -70,8 +67,7 @@ public final class FlowEngine extends ScheduledThreadPoolExecutor { } /** - * Hook method called by the running thread whenever a runnable task is - * given to the thread to run. + * Hook method called by the running thread whenever a runnable task is given to the thread to run. * * @param thread thread * @param runnable runnable @@ -84,9 +80,7 @@ public final class FlowEngine extends ScheduledThreadPoolExecutor { } /** - * Hook method called by the thread that executed the given runnable after - * execution of the runnable completed. Logs the fact of completion and any - * errors that might have occured. + * Hook method called by the thread that executed the given runnable after execution of the runnable completed. Logs the fact of completion and any errors that might have occured. * * @param runnable runnable * @param throwable throwable diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/events/VolatileBulletinRepository.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/events/VolatileBulletinRepository.java index e8708bd62b..a20e974a1c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/events/VolatileBulletinRepository.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/events/VolatileBulletinRepository.java @@ -176,9 +176,8 @@ public class VolatileBulletinRepository implements BulletinRepository { } /** - * Overrides the default bulletin processing strategy. When a custom - * bulletin strategy is employed, bulletins will not be persisted in this - * repository and will sent to the specified strategy instead. + * Overrides the default bulletin processing strategy. When a custom bulletin strategy is employed, bulletins will not be persisted in this repository and will sent to the specified strategy + * instead. * * @param strategy bulletin strategy */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/fingerprint/FingerprintFactory.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/fingerprint/FingerprintFactory.java index 27eca37adc..f8ca2f0d22 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/fingerprint/FingerprintFactory.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/fingerprint/FingerprintFactory.java @@ -72,15 +72,10 @@ import org.w3c.dom.NodeList; import org.xml.sax.SAXException; /** - * Creates a fingerprint of a flow.xml. The order of elements or attributes in - * the flow.xml does not influence the fingerprint generation. + * Creates a fingerprint of a flow.xml. The order of elements or attributes in the flow.xml does not influence the fingerprint generation. * - * Only items in the flow.xml that influence the processing of data are - * incorporated into the fingerprint. Examples of items involved in the - * fingerprint are: processor IDs, processor relationships, and processor - * properties. Examples of items not involved in the fingerprint are: items in - * the processor "settings" or "comments" tabs, position information, flow - * controller settings, and counters. + * Only items in the flow.xml that influence the processing of data are incorporated into the fingerprint. Examples of items involved in the fingerprint are: processor IDs, processor relationships, + * and processor properties. Examples of items not involved in the fingerprint are: items in the processor "settings" or "comments" tabs, position information, flow controller settings, and counters. * */ public final class FingerprintFactory { @@ -125,8 +120,7 @@ public final class FingerprintFactory { } /** - * Creates a fingerprint of a flow. The order of elements or attributes in - * the flow does not influence the fingerprint generation. + * Creates a fingerprint of a flow. The order of elements or attributes in the flow does not influence the fingerprint generation. * * @param flowBytes the flow represented as bytes * @param controller the controller @@ -183,8 +177,7 @@ public final class FingerprintFactory { } /** - * Creates a fingerprint of a Collection of Templates The order of the - * templates does not influence the fingerprint generation. + * Creates a fingerprint of a Collection of Templates The order of the templates does not influence the fingerprint generation. * * * @param templates collection of templates diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/groups/StandardProcessGroup.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/groups/StandardProcessGroup.java index e0181eaa11..c7baef4578 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/groups/StandardProcessGroup.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/groups/StandardProcessGroup.java @@ -1805,14 +1805,11 @@ public final class StandardProcessGroup implements ProcessGroup { } /** - * Verifies that all ID's defined within the given snippet reference - * components within this ProcessGroup. If this is not the case, throws - * {@link IllegalStateException}. + * Verifies that all ID's defined within the given snippet reference components within this ProcessGroup. If this is not the case, throws {@link IllegalStateException}. * * @param snippet the snippet * @throws NullPointerException if the argument is null - * @throws IllegalStateException if the snippet contains an ID that - * references a component that is not part of this ProcessGroup + * @throws IllegalStateException if the snippet contains an ID that references a component that is not part of this ProcessGroup */ private void verifyContents(final Snippet snippet) throws NullPointerException, IllegalStateException { requireNonNull(snippet); @@ -1829,10 +1826,8 @@ public final class StandardProcessGroup implements ProcessGroup { /** *

    - * Verifies that all ID's specified by the given set exist as keys in the - * given Map. If any of the ID's does not exist as a key in the map, will - * throw {@link IllegalStateException} indicating the ID that is invalid and - * specifying the Component Type. + * Verifies that all ID's specified by the given set exist as keys in the given Map. If any of the ID's does not exist as a key in the map, will throw {@link IllegalStateException} indicating the + * ID that is invalid and specifying the Component Type. *

    * *

    diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycle.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycle.java index 84f0dbc5a5..72b129ca1a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycle.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycle.java @@ -17,37 +17,30 @@ package org.apache.nifi.lifecycle; /** - * Represents a start/stop lifecyle for a component. start should - * only be called once per lifecyle unless otherwise documented by implementing - * classes. + * Represents a start/stop lifecyle for a component. start should only be called once per lifecyle unless otherwise documented by implementing classes. * * @author unattributed */ public interface LifeCycle { /** - * Initiates the start state of the lifecyle. Should not throw an exception - * if the component is already running. + * Initiates the start state of the lifecyle. Should not throw an exception if the component is already running. * * @throws LifeCycleStartException if startup or initialization failed */ void start() throws LifeCycleStartException; /** - * Initiates the stop state of the lifecycle. Should not throw an exception - * if the component is already stopped. + * Initiates the stop state of the lifecycle. Should not throw an exception if the component is already stopped. * - * @param force true if all efforts such as thread interruption should be - * attempted to stop the component; false if a graceful stopping should be - * employed + * @param force true if all efforts such as thread interruption should be attempted to stop the component; false if a graceful stopping should be employed * * @throws LifeCycleStopException if the shutdown failed */ void stop(boolean force) throws LifeCycleStopException; /** - * @return true if the component is started, but not yet stopped; false - * otherwise + * @return true if the component is started, but not yet stopped; false otherwise */ boolean isRunning(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleException.java index 297a9984f7..d3bf2bfe1b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleException.java @@ -17,8 +17,7 @@ package org.apache.nifi.lifecycle; /** - * The base exception for issues encountered during the lifecycle of a class - * implementing the LifeCycle interface. + * The base exception for issues encountered during the lifecycle of a class implementing the LifeCycle interface. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStartException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStartException.java index 8d2f726d35..725d840ab3 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStartException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStartException.java @@ -17,9 +17,7 @@ package org.apache.nifi.lifecycle; /** - * Represents the exceptional case when a problem is encountered during the - * startup or initialization of a class implementing the LifeCycle - * interface. + * Represents the exceptional case when a problem is encountered during the startup or initialization of a class implementing the LifeCycle interface. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStopException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStopException.java index be3779bcef..910e0a8836 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStopException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/lifecycle/LifeCycleStopException.java @@ -17,8 +17,7 @@ package org.apache.nifi.lifecycle; /** - * Represents the exceptional case when a problem is encountered during the - * shutdown of a class implementing the LifeCycle interface. + * Represents the exceptional case when a problem is encountered during the shutdown of a class implementing the LifeCycle interface. * * @author unattributed */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/FlowConfigurationDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/FlowConfigurationDAO.java index cc3dbeaf38..92a0d84281 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/FlowConfigurationDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/persistence/FlowConfigurationDAO.java @@ -32,24 +32,18 @@ import org.apache.nifi.controller.UninheritableFlowException; public interface FlowConfigurationDAO { /** - * Loads the given controller with the values from the given proposed flow. - * If loading the proposed flow configuration would cause the controller to - * orphan flow files, then an UninheritableFlowException is thrown. + * Loads the given controller with the values from the given proposed flow. If loading the proposed flow configuration would cause the controller to orphan flow files, then an + * UninheritableFlowException is thrown. * - * If the FlowSynchronizationException is thrown, then the controller may - * have changed some of its state and should no longer be used. + * If the FlowSynchronizationException is thrown, then the controller may have changed some of its state and should no longer be used. * * @param controller a controller * @param dataFlow the flow to load * @throws java.io.IOException * - * @throws FlowSerializationException if proposed flow is not a valid flow - * configuration file - * @throws UninheritableFlowException if the proposed flow cannot be loaded - * by the controller because in doing so would risk orphaning flow files - * @throws FlowSynchronizationException if updates to the controller failed. - * If this exception is thrown, then the controller should be considered - * unsafe to be used + * @throws FlowSerializationException if proposed flow is not a valid flow configuration file + * @throws UninheritableFlowException if the proposed flow cannot be loaded by the controller because in doing so would risk orphaning flow files + * @throws FlowSynchronizationException if updates to the controller failed. If this exception is thrown, then the controller should be considered unsafe to be used */ void load(FlowController controller, DataFlow dataFlow) throws IOException, FlowSerializationException, FlowSynchronizationException, UninheritableFlowException; @@ -76,8 +70,7 @@ public interface FlowConfigurationDAO { * @param flow to save * @throws NullPointerException if the given flow is null * @throws IOException If unable to persist state of given flow - * @throws IllegalStateException if FileFlowDAO not in proper state for - * saving + * @throws IllegalStateException if FileFlowDAO not in proper state for saving */ void save(FlowController flow) throws IOException; @@ -85,12 +78,10 @@ public interface FlowConfigurationDAO { * Saves all changes made to the given flow to the given File. * * @param flow to save - * @param outStream the OutputStream to which the FlowController will be - * written + * @param outStream the OutputStream to which the FlowController will be written * @throws NullPointerException if the given flow is null * @throws IOException If unable to persist state of given flow - * @throws IllegalStateException if FileFlowDAO not in proper state for - * saving + * @throws IllegalStateException if FileFlowDAO not in proper state for saving */ void save(FlowController flow, OutputStream outStream) throws IOException; @@ -98,12 +89,10 @@ public interface FlowConfigurationDAO { * Saves all changes made to the given flow to the given File. * * @param flow to save - * @param archive if true will also attempt to archive the flow - * configuration + * @param archive if true will also attempt to archive the flow configuration * @throws NullPointerException if the given flow is null * @throws IOException If unable to persist state of given flow - * @throws IllegalStateException if FileFlowDAO not in proper state for - * saving + * @throws IllegalStateException if FileFlowDAO not in proper state for saving */ void save(FlowController flow, boolean archive) throws IOException; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardProcessContext.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardProcessContext.java index 3e1d1e6f38..d1bfacf6bd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardProcessContext.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardProcessContext.java @@ -65,8 +65,7 @@ public class StandardProcessContext implements ProcessContext, ControllerService /** *

    - * Returns the currently configured value for the property with the given - * name. + * Returns the currently configured value for the property with the given name. *

    */ @Override diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardPropertyValue.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardPropertyValue.java index b320a61b2a..acb86aa06d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardPropertyValue.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/processor/StandardPropertyValue.java @@ -39,15 +39,9 @@ public final class StandardPropertyValue implements PropertyValue { } /** - * Constructs a new StandardPropertyValue with the given value & service - * lookup and indicates whether or not the rawValue contains any NiFi - * Expressions. If it is unknown whether or not the value contains any NiFi - * Expressions, the - * {@link #StandardPropertyValue(String, ControllerServiceLookup)} - * constructor should be used or true should be passed. - * However, if it is known that the value contains no NiFi Expression, that - * information should be provided so that calls to - * {@link #evaluateAttributeExpressions()} are much more efficient + * Constructs a new StandardPropertyValue with the given value & service lookup and indicates whether or not the rawValue contains any NiFi Expressions. If it is unknown whether or not the value + * contains any NiFi Expressions, the {@link #StandardPropertyValue(String, ControllerServiceLookup)} constructor should be used or true should be passed. However, if it is known that + * the value contains no NiFi Expression, that information should be provided so that calls to {@link #evaluateAttributeExpressions()} are much more efficient * * @param rawValue value * @param serviceLookup lookup diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/RemoteNiFiUtils.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/RemoteNiFiUtils.java index bed5279678..e80d38352b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/RemoteNiFiUtils.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/RemoteNiFiUtils.java @@ -120,12 +120,9 @@ public class RemoteNiFiUtils { } /** - * Returns the port on which the remote instance is listening for Flow File - * transfers, or null if the remote instance is not configured - * to use Site-to-Site transfers. + * Returns the port on which the remote instance is listening for Flow File transfers, or null if the remote instance is not configured to use Site-to-Site transfers. * - * @param uri the base URI of the remote instance. This should include the - * path only to the nifi-api level, as well as the protocol, host, and port. + * @param uri the base URI of the remote instance. This should include the path only to the nifi-api level, as well as the protocol, host, and port. * @param timeoutMillis wait time in millis * @return port number * @throws IOException ex @@ -158,9 +155,7 @@ public class RemoteNiFiUtils { } /** - * Returns the port on which the remote instance is listening for Flow File - * transfers, or null if the remote instance is not configured - * to use Site-to-Site transfers. + * Returns the port on which the remote instance is listening for Flow File transfers, or null if the remote instance is not configured to use Site-to-Site transfers. * * @param uri the full URI to fetch, including the path. * @return port diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/StandardRemoteProcessGroup.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/StandardRemoteProcessGroup.java index f4b59757bf..d19b5c184c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/StandardRemoteProcessGroup.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/remote/StandardRemoteProcessGroup.java @@ -72,9 +72,8 @@ import com.sun.jersey.api.client.ClientResponse.Status; import com.sun.jersey.api.client.UniformInterfaceException; /** - * Represents the Root Process Group of a remote NiFi Instance. Holds - * information about that remote instance, as well as {@link IncomingPort}s and - * {@link OutgoingPort}s for communicating with the remote instance. + * Represents the Root Process Group of a remote NiFi Instance. Holds information about that remote instance, as well as {@link IncomingPort}s and {@link OutgoingPort}s for communicating with the + * remote instance. */ public class StandardRemoteProcessGroup implements RemoteProcessGroup { @@ -325,11 +324,8 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * Changes the currently configured input ports to the ports described in - * the given set. If any port is currently configured that is not in the set - * given, that port will be shutdown and removed. If any port is currently - * not configured and is in the set given, that port will be instantiated - * and started. + * Changes the currently configured input ports to the ports described in the given set. If any port is currently configured that is not in the set given, that port will be shutdown and removed. + * If any port is currently not configured and is in the set given, that port will be instantiated and started. * * @param ports the new ports * @@ -378,12 +374,10 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * Returns a boolean indicating whether or not an Output Port exists with - * the given ID + * Returns a boolean indicating whether or not an Output Port exists with the given ID * * @param id identifier of port - * @return true if an Output Port exists with the given ID, - * false otherwise. + * @return true if an Output Port exists with the given ID, false otherwise. */ public boolean containsOutputPort(final String id) { readLock.lock(); @@ -395,11 +389,8 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * Changes the currently configured output ports to the ports described in - * the given set. If any port is currently configured that is not in the set - * given, that port will be shutdown and removed. If any port is currently - * not configured and is in the set given, that port will be instantiated - * and started. + * Changes the currently configured output ports to the ports described in the given set. If any port is currently configured that is not in the set given, that port will be shutdown and removed. + * If any port is currently not configured and is in the set given, that port will be instantiated and started. * * @param ports the new ports * @@ -452,8 +443,7 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { * * * @throws NullPointerException if the given output Port is null - * @throws IllegalStateException if the port does not belong to this remote - * process group + * @throws IllegalStateException if the port does not belong to this remote process group */ @Override public void removeNonExistentPort(final RemoteGroupPort port) { @@ -531,13 +521,11 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * Adds an Output Port to this Remote Process Group that is described by - * this DTO. + * Adds an Output Port to this Remote Process Group that is described by this DTO. * * @param descriptor * - * @throws IllegalStateException if an Output Port already exists with the - * ID given by dto.getId() + * @throws IllegalStateException if an Output Port already exists with the ID given by dto.getId() */ private void addOutputPort(final RemoteProcessGroupPortDescriptor descriptor) { writeLock.lock(); @@ -563,8 +551,7 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { /** * @param portIdentifier the ID of the Port to send FlowFiles to - * @return {@link RemoteGroupPort} that can be used to send FlowFiles to the - * port whose ID is given on the remote instance + * @return {@link RemoteGroupPort} that can be used to send FlowFiles to the port whose ID is given on the remote instance */ @Override public RemoteGroupPort getInputPort(final String portIdentifier) { @@ -581,8 +568,7 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * @return a set of {@link OutgoingPort}s used for transmitting FlowFiles to - * the remote instance + * @return a set of {@link OutgoingPort}s used for transmitting FlowFiles to the remote instance */ @Override public Set getInputPorts() { @@ -597,13 +583,11 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * Adds an InputPort to this ProcessGroup that is described by the given - * DTO. + * Adds an InputPort to this ProcessGroup that is described by the given DTO. * * @param descriptor port descriptor * - * @throws IllegalStateException if an Input Port already exists with the ID - * given by the ID of the DTO. + * @throws IllegalStateException if an Input Port already exists with the ID given by the ID of the DTO. */ private void addInputPort(final RemoteProcessGroupPortDescriptor descriptor) { writeLock.lock(); @@ -643,8 +627,7 @@ public class StandardRemoteProcessGroup implements RemoteProcessGroup { } /** - * @return a set of {@link RemoteGroupPort}s used for receiving FlowFiles - * from the remote instance + * @return a set of {@link RemoteGroupPort}s used for receiving FlowFiles from the remote instance */ @Override public Set getOutputPorts() { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/services/FlowService.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/services/FlowService.java index 71cf969efc..e59a8d4ae6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/services/FlowService.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/services/FlowService.java @@ -29,16 +29,14 @@ import org.apache.nifi.controller.UninheritableFlowException; import org.apache.nifi.lifecycle.LifeCycle; /** - * Defines the API level services available for carrying out file-based dataflow - * operations. + * Defines the API level services available for carrying out file-based dataflow operations. * * @author unattributed */ public interface FlowService extends LifeCycle { /** - * Immediately persists the state of the flow controller to the flow.xml - * file in a blocking call. + * Immediately persists the state of the flow controller to the flow.xml file in a blocking call. * * @throws NullPointerException if the given flow is null. * @throws IOException if any problem occurs creating/modifying file @@ -46,19 +44,16 @@ public interface FlowService extends LifeCycle { void saveFlowChanges() throws IOException; /** - * Immediately persists the state of the flow controller to the given output - * stream in a blocking call. + * Immediately persists the state of the flow controller to the given output stream in a blocking call. * - * @param outStream the stream to which the FlowController is to be - * persisted + * @param outStream the stream to which the FlowController is to be persisted * @throws NullPointerException if the given flow is null. * @throws IOException if any problem occurs creating/modifying file */ void saveFlowChanges(OutputStream outStream) throws IOException; /** - * Saves the given stream to the flow.xml file on disk. This method does not - * change the state of the flow controller. + * Saves the given stream to the flow.xml file on disk. This method does not change the state of the flow controller. * * @param is an input stream * @throws IOException if unable to save the flow @@ -66,10 +61,8 @@ public interface FlowService extends LifeCycle { void overwriteFlow(InputStream is) throws IOException; /** - * Asynchronously saves the flow controller. The flow controller will be - * copied and immediately returned. If another call to save is made within - * that time the latest called state of the flow controller will be used. In - * database terms this technique is referred to as 'write-delay'. + * Asynchronously saves the flow controller. The flow controller will be copied and immediately returned. If another call to save is made within that time the latest called state of the flow + * controller will be used. In database terms this technique is referred to as 'write-delay'. * * @param delayUnit unit of delay * @param delay period of delay @@ -77,47 +70,35 @@ public interface FlowService extends LifeCycle { void saveFlowChanges(TimeUnit delayUnit, long delay); /** - * Asynchronously saves the flow controller. The flow controller will be - * copied and immediately returned. If another call to save is made within - * that time the latest called state of the flow controller will be used. In - * database terms this technique is referred to as 'write-delay'. + * Asynchronously saves the flow controller. The flow controller will be copied and immediately returned. If another call to save is made within that time the latest called state of the flow + * controller will be used. In database terms this technique is referred to as 'write-delay'. * * @param delayUnit unit of delay * @param delay period of delay - * @param archive if true means the user wants the flow configuration to be - * archived as well + * @param archive if true means the user wants the flow configuration to be archived as well */ void saveFlowChanges(TimeUnit delayUnit, long delay, boolean archive); /** * Stops the flow and underlying repository as determined by user * - * @param force if true the controller is not allowed to gracefully shut - * down. + * @param force if true the controller is not allowed to gracefully shut down. */ @Override void stop(boolean force); /** - * Loads the flow controller with the given flow. Passing null means that - * the local flow on disk will used as the proposed flow. If loading the - * proposed flow configuration would cause the controller to orphan flow - * files, then an UninheritableFlowException is thrown. + * Loads the flow controller with the given flow. Passing null means that the local flow on disk will used as the proposed flow. If loading the proposed flow configuration would cause the + * controller to orphan flow files, then an UninheritableFlowException is thrown. * - * If the FlowSynchronizationException is thrown, then the controller may - * have changed some of its state and should no longer be used. + * If the FlowSynchronizationException is thrown, then the controller may have changed some of its state and should no longer be used. * * @param proposedFlow the flow to load * - * @throws IOException if flow configuration could not be retrieved from - * disk - * @throws FlowSerializationException if proposed flow is not a valid flow - * configuration file - * @throws UninheritableFlowException if the proposed flow cannot be loaded - * by the controller because in doing so would risk orphaning flow files - * @throws FlowSynchronizationException if updates to the controller failed. - * If this exception is thrown, then the controller should be considered - * unsafe to be used + * @throws IOException if flow configuration could not be retrieved from disk + * @throws FlowSerializationException if proposed flow is not a valid flow configuration file + * @throws UninheritableFlowException if the proposed flow cannot be loaded by the controller because in doing so would risk orphaning flow files + * @throws FlowSynchronizationException if updates to the controller failed. If this exception is thrown, then the controller should be considered unsafe to be used */ void load(DataFlow proposedFlow) throws IOException, FlowSerializationException, FlowSynchronizationException, UninheritableFlowException; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/FlowControllerFactoryBean.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/FlowControllerFactoryBean.java index 665738b6ae..6949cf980c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/FlowControllerFactoryBean.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/FlowControllerFactoryBean.java @@ -29,9 +29,7 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; /** - * Factory bean for creating a singleton FlowController instance. If the - * application is configured to act as the cluster manager, then null is always - * returned as the created instance. + * Factory bean for creating a singleton FlowController instance. If the application is configured to act as the cluster manager, then null is always returned as the created instance. */ @SuppressWarnings("rawtypes") public class FlowControllerFactoryBean implements FactoryBean, ApplicationContextAware { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/StandardFlowServiceFactoryBean.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/StandardFlowServiceFactoryBean.java index cfd855f698..2aed5c2361 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/StandardFlowServiceFactoryBean.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/spring/StandardFlowServiceFactoryBean.java @@ -28,9 +28,7 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationContextAware; /** - * Factory bean for creating a singleton FlowController instance. If the - * application is configured to act as the cluster manager, then null is always - * returned as the created instance. + * Factory bean for creating a singleton FlowController instance. If the application is configured to act as the cluster manager, then null is always returned as the created instance. */ @SuppressWarnings("rawtypes") public class StandardFlowServiceFactoryBean implements FactoryBean, ApplicationContextAware { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ComponentStatusReport.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ComponentStatusReport.java index 12960048a8..ca31467d35 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ComponentStatusReport.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ComponentStatusReport.java @@ -28,9 +28,7 @@ import org.apache.nifi.controller.status.ProcessorStatus; import org.apache.nifi.controller.status.RemoteProcessGroupStatus; /** - * ComponentStatusReport is a util class that can be used to "flatten" a - * ProcessGroupStatus into a collection of Map's so that retrieval of a Status - * for a particular component is very efficient + * ComponentStatusReport is a util class that can be used to "flatten" a ProcessGroupStatus into a collection of Map's so that retrieval of a Status for a particular component is very efficient */ public class ComponentStatusReport { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ReflectionUtils.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ReflectionUtils.java index d7573c3235..5140e3104b 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ReflectionUtils.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/ReflectionUtils.java @@ -31,12 +31,9 @@ public class ReflectionUtils { private final static Logger LOG = LoggerFactory.getLogger(ReflectionUtils.class); /** - * Invokes all methods on the given instance that have been annotated with - * the given Annotation. If the signature of the method that is defined in - * instance uses 1 or more parameters, those parameters must be - * specified by the args parameter. However, if more arguments - * are supplied by the args parameter than needed, the extra - * arguments will be ignored. + * Invokes all methods on the given instance that have been annotated with the given Annotation. If the signature of the method that is defined in instance uses 1 or more parameters, + * those parameters must be specified by the args parameter. However, if more arguments are supplied by the args parameter than needed, the extra arguments will be + * ignored. * * @param annotation annotation * @param instance instance @@ -51,14 +48,9 @@ public class ReflectionUtils { } /** - * Invokes all methods on the given instance that have been annotated with - * the given preferredAnnotation and if no such method exists will invoke - * all methods on the given instance that have been annotated with the given - * alternateAnnotation, if any exists. If the signature of the method that - * is defined in instance uses 1 or more parameters, those - * parameters must be specified by the args parameter. However, - * if more arguments are supplied by the args parameter than - * needed, the extra arguments will be ignored. + * Invokes all methods on the given instance that have been annotated with the given preferredAnnotation and if no such method exists will invoke all methods on the given instance that have been + * annotated with the given alternateAnnotation, if any exists. If the signature of the method that is defined in instance uses 1 or more parameters, those parameters must be + * specified by the args parameter. However, if more arguments are supplied by the args parameter than needed, the extra arguments will be ignored. * * @param preferredAnnotation preferred * @param alternateAnnotation alternate @@ -134,67 +126,48 @@ public class ReflectionUtils { } /** - * Invokes all methods on the given instance that have been annotated with - * the given Annotation. If the signature of the method that is defined in - * instance uses 1 or more parameters, those parameters must be - * specified by the args parameter. However, if more arguments - * are supplied by the args parameter than needed, the extra - * arguments will be ignored. + * Invokes all methods on the given instance that have been annotated with the given Annotation. If the signature of the method that is defined in instance uses 1 or more parameters, + * those parameters must be specified by the args parameter. However, if more arguments are supplied by the args parameter than needed, the extra arguments will be + * ignored. * * @param annotation annotation * @param instance instance * @param args args - * @return true if all appropriate methods were invoked and - * returned without throwing an Exception, false if one of the - * methods threw an Exception or could not be invoked; if false - * is returned, an error will have been logged. + * @return true if all appropriate methods were invoked and returned without throwing an Exception, false if one of the methods threw an Exception or could not be + * invoked; if false is returned, an error will have been logged. */ public static boolean quietlyInvokeMethodsWithAnnotation(final Class annotation, final Object instance, final Object... args) { return quietlyInvokeMethodsWithAnnotation(annotation, null, instance, null, args); } /** - * Invokes all methods on the given instance that have been annotated with - * the given Annotation. If the signature of the method that is defined in - * instance uses 1 or more parameters, those parameters must be - * specified by the args parameter. However, if more arguments - * are supplied by the args parameter than needed, the extra - * arguments will be ignored. + * Invokes all methods on the given instance that have been annotated with the given Annotation. If the signature of the method that is defined in instance uses 1 or more parameters, + * those parameters must be specified by the args parameter. However, if more arguments are supplied by the args parameter than needed, the extra arguments will be + * ignored. * * @param annotation annotation * @param instance instance * @param logger logger * @param args args - * @return true if all appropriate methods were invoked and - * returned without throwing an Exception, false if one of the - * methods threw an Exception or could not be invoked; if false - * is returned, an error will have been logged. + * @return true if all appropriate methods were invoked and returned without throwing an Exception, false if one of the methods threw an Exception or could not be + * invoked; if false is returned, an error will have been logged. */ public static boolean quietlyInvokeMethodsWithAnnotation(final Class annotation, final Object instance, final ProcessorLog logger, final Object... args) { return quietlyInvokeMethodsWithAnnotation(annotation, null, instance, logger, args); } /** - * Invokes all methods on the given instance that have been annotated with - * the given preferredAnnotation and if no such method exists will invoke - * all methods on the given instance that have been annotated with the given - * alternateAnnotation, if any exists. If the signature of the method that - * is defined in instance uses 1 or more parameters, those - * parameters must be specified by the args parameter. However, - * if more arguments are supplied by the args parameter than - * needed, the extra arguments will be ignored. + * Invokes all methods on the given instance that have been annotated with the given preferredAnnotation and if no such method exists will invoke all methods on the given instance that have been + * annotated with the given alternateAnnotation, if any exists. If the signature of the method that is defined in instance uses 1 or more parameters, those parameters must be + * specified by the args parameter. However, if more arguments are supplied by the args parameter than needed, the extra arguments will be ignored. * * @param preferredAnnotation preferred * @param alternateAnnotation alternate * @param instance instance - * @param logger the ProcessorLog to use for logging any errors. If null, - * will use own logger, but that will not generate bulletins or easily tie - * to the Processor's log messages. + * @param logger the ProcessorLog to use for logging any errors. If null, will use own logger, but that will not generate bulletins or easily tie to the Processor's log messages. * @param args args - * @return true if all appropriate methods were invoked and - * returned without throwing an Exception, false if one of the - * methods threw an Exception or could not be invoked; if false - * is returned, an error will have been logged. + * @return true if all appropriate methods were invoked and returned without throwing an Exception, false if one of the methods threw an Exception or could not be + * invoked; if false is returned, an error will have been logged. */ public static boolean quietlyInvokeMethodsWithAnnotation( final Class preferredAnnotation, final Class alternateAnnotation, final Object instance, final ProcessorLog logger, final Object... args) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/SnippetUtils.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/SnippetUtils.java index 81d00e67b9..1521f54d57 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/SnippetUtils.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/util/SnippetUtils.java @@ -35,8 +35,7 @@ import org.apache.nifi.web.api.dto.PositionDTO; public final class SnippetUtils { /** - * Moves the content of the specified template around the specified - * location. + * Moves the content of the specified template around the specified location. * * @param snippet snippet * @param x x location @@ -97,8 +96,7 @@ public final class SnippetUtils { } /** - * Gets all components, but not connections, that are part of the specified - * template. + * Gets all components, but not connections, that are part of the specified template. * * @param contents snippet * @return component dtos diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerAuditor.java index 7f5f926094..f1e31ddcdb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerAuditor.java @@ -43,10 +43,10 @@ public class ControllerAuditor extends NiFiAuditor { /** * Audits updating the name of the controller. * - * @param proceedingJoinPoint - * @param name - * @param controllerFacade - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @param name name + * @param controllerFacade facade + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.controller.ControllerFacade) && " + "execution(void setName(java.lang.String)) && " @@ -96,10 +96,10 @@ public class ControllerAuditor extends NiFiAuditor { /** * Audits updating the comments of the controller. * - * @param proceedingJoinPoint - * @param comments - * @param controllerFacade - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @param comments comments + * @param controllerFacade facade + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.controller.ControllerFacade) && " + "execution(void setComments(java.lang.String)) && " @@ -147,13 +147,12 @@ public class ControllerAuditor extends NiFiAuditor { } /** - * Audits updating the max number of timer driven threads for the - * controller. + * Audits updating the max number of timer driven threads for the controller. * - * @param proceedingJoinPoint - * @param maxTimerDrivenThreadCount - * @param controllerFacade - * @throws java.lang.Throwable + * @param proceedingJoinPoint joint point + * @param maxTimerDrivenThreadCount thread count + * @param controllerFacade facade + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.controller.ControllerFacade) && " + "execution(void setMaxTimerDrivenThreadCount(int)) && " @@ -201,13 +200,12 @@ public class ControllerAuditor extends NiFiAuditor { } /** - * Audits updating the max number of event driven threads for the - * controller. + * Audits updating the max number of event driven threads for the controller. * - * @param proceedingJoinPoint - * @param maxEventDrivenThreadCount - * @param controllerFacade - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @param maxEventDrivenThreadCount thread count + * @param controllerFacade facade + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.controller.ControllerFacade) && " + "execution(void setMaxEventDrivenThreadCount(int)) && " diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerServiceAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerServiceAuditor.java index a044b4697a..8ca3f0e196 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerServiceAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ControllerServiceAuditor.java @@ -63,16 +63,12 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Audits the creation of controller service via createControllerService(). * - * This method only needs to be run 'after returning'. However, in Java 7 - * the order in which these methods are returned from - * Class.getDeclaredMethods (even though there is no order guaranteed) seems - * to differ from Java 6. SpringAOP depends on this ordering to determine - * advice precedence. By normalizing all advice into Around advice we can - * alleviate this issue. + * This method only needs to be run 'after returning'. However, in Java 7 the order in which these methods are returned from Class.getDeclaredMethods (even though there is no order guaranteed) + * seems to differ from Java 6. SpringAOP depends on this ordering to determine advice precedence. By normalizing all advice into Around advice we can alleviate this issue. * - * @param proceedingJoinPoint - * @return - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @return node + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.dao.ControllerServiceDAO+) && " + "execution(org.apache.nifi.controller.service.ControllerServiceNode createControllerService(org.apache.nifi.web.api.dto.ControllerServiceDTO))") @@ -94,11 +90,11 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Audits the configuration of a single controller service. * - * @param proceedingJoinPoint - * @param controllerServiceDTO - * @param controllerServiceDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param controllerServiceDTO dto + * @param controllerServiceDAO dao + * @return object + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ControllerServiceDAO+) && " + "execution(org.apache.nifi.controller.service.ControllerServiceNode updateControllerService(org.apache.nifi.web.api.dto.ControllerServiceDTO)) && " @@ -220,13 +216,14 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Audits the update of a component referencing a controller service. * - * @param proceedingJoinPoint - * @param controllerServiceId - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @return object + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ControllerServiceDAO+) && " - + "execution(org.apache.nifi.controller.service.ControllerServiceReference updateControllerServiceReferencingComponents(java.lang.String, org.apache.nifi.controller.ScheduledState, org.apache.nifi.controller.service.ControllerServiceState))") + + "execution(org.apache.nifi.controller.service.ControllerServiceReference " + + "updateControllerServiceReferencingComponents(java.lang.String, org.apache.nifi.controller.ScheduledState, " + + "org.apache.nifi.controller.service.ControllerServiceState))") public Object updateControllerServiceReferenceAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable { // update the controller service references final ControllerServiceReference controllerServiceReference = (ControllerServiceReference) proceedingJoinPoint.proceed(); @@ -255,12 +252,13 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Gets the update actions for all specified referencing components. * - * @param user - * @param actions - * @param visitedServices - * @param referencingComponents + * @param user user + * @param actions actions + * @param visitedServices services + * @param referencingComponents components */ - private void getUpdateActionsForReferencingComponents(final NiFiUser user, final Collection actions, final Collection visitedServices, final Set referencingComponents) { + private void getUpdateActionsForReferencingComponents( + final NiFiUser user, final Collection actions, final Collection visitedServices, final Set referencingComponents) { // consider each component updates for (final ConfiguredComponent component : referencingComponents) { if (component instanceof ProcessorNode) { @@ -329,10 +327,10 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Audits the removal of a controller service via deleteControllerService(). * - * @param proceedingJoinPoint - * @param controllerServiceId - * @param controllerServiceDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param controllerServiceId id + * @param controllerServiceDAO dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ControllerServiceDAO+) && " + "execution(void deleteControllerService(java.lang.String)) && " @@ -358,9 +356,9 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a controller service. * - * @param controllerService - * @param operation - * @return + * @param controllerService service + * @param operation operation + * @return action */ private Action generateAuditRecord(ControllerServiceNode controllerService, Operation operation) { return generateAuditRecord(controllerService, operation, null); @@ -369,10 +367,10 @@ public class ControllerServiceAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a controller service. * - * @param controllerService - * @param operation - * @param actionDetails - * @return + * @param controllerService service + * @param operation operation + * @param actionDetails details + * @return action */ private Action generateAuditRecord(ControllerServiceNode controllerService, Operation operation, ActionDetails actionDetails) { Action action = null; @@ -406,12 +404,11 @@ public class ControllerServiceAuditor extends NiFiAuditor { } /** - * Extracts the values for the configured properties from the specified - * ControllerService. + * Extracts the values for the configured properties from the specified ControllerService. * - * @param controllerService - * @param controllerServiceDTO - * @return + * @param controllerService service + * @param controllerServiceDTO dto + * @return properties */ private Map extractConfiguredPropertyValues(ControllerServiceNode controllerService, ControllerServiceDTO controllerServiceDTO) { Map values = new HashMap<>(); @@ -447,12 +444,11 @@ public class ControllerServiceAuditor extends NiFiAuditor { } /** - * Locates the actual property descriptor for the given spec property - * descriptor. + * Locates the actual property descriptor for the given spec property descriptor. * - * @param propertyDescriptors - * @param specDescriptor - * @return + * @param propertyDescriptors descriptors + * @param specDescriptor example descriptor + * @return property */ private PropertyDescriptor locatePropertyDescriptor(Set propertyDescriptors, PropertyDescriptor specDescriptor) { for (PropertyDescriptor propertyDescriptor : propertyDescriptors) { @@ -464,11 +460,10 @@ public class ControllerServiceAuditor extends NiFiAuditor { } /** - * Returns whether the specified controller service is disabled (or - * disabling). + * Returns whether the specified controller service is disabled (or disabling). * - * @param controllerService - * @return + * @param controllerService service + * @return whether the specified controller service is disabled (or disabling) */ private boolean isDisabled(final ControllerServiceNode controllerService) { return ControllerServiceState.DISABLED.equals(controllerService.getState()) || ControllerServiceState.DISABLING.equals(controllerService.getState()); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/FunnelAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/FunnelAuditor.java index e96604ca2a..e864c898e2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/FunnelAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/FunnelAuditor.java @@ -33,9 +33,6 @@ import org.aspectj.lang.annotation.Aspect; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** - * - */ @Aspect public class FunnelAuditor extends NiFiAuditor { @@ -44,9 +41,9 @@ public class FunnelAuditor extends NiFiAuditor { /** * Audits the creation of a funnel. * - * @param proceedingJoinPoint - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @return funnel + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.FunnelDAO+) && " + "execution(org.apache.nifi.connectable.Funnel createFunnel(java.lang.String, org.apache.nifi.web.api.dto.FunnelDTO))") @@ -68,11 +65,11 @@ public class FunnelAuditor extends NiFiAuditor { /** * Audits the removal of a funnel. * - * @param proceedingJoinPoint - * @param groupId - * @param funnelId - * @param funnelDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param funnelId funnel id + * @param funnelDAO funnel dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.FunnelDAO+) && " + "execution(void deleteFunnel(java.lang.String, java.lang.String)) && " @@ -97,9 +94,9 @@ public class FunnelAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of the specified funnel. * - * @param funnel - * @param operation - * @return + * @param funnel funnel + * @param operation operation + * @return action */ public Action generateAuditRecord(Funnel funnel, Operation operation) { return generateAuditRecord(funnel, operation, null); @@ -108,10 +105,10 @@ public class FunnelAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of the specified funnel. * - * @param funnel - * @param operation - * @param actionDetails - * @return + * @param funnel funnel + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecord(Funnel funnel, Operation operation, ActionDetails actionDetails) { Action action = null; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/NiFiAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/NiFiAuditor.java index e61a4a63e7..4477cce641 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/NiFiAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/NiFiAuditor.java @@ -41,8 +41,8 @@ public abstract class NiFiAuditor { /** * Records the specified action. * - * @param action - * @param logger + * @param action action + * @param logger logger */ protected void saveAction(Action action, Logger logger) { final Collection actions = new ArrayList<>(); @@ -53,8 +53,8 @@ public abstract class NiFiAuditor { /** * Records the actions. * - * @param actions - * @param logger + * @param actions actions + * @param logger logger */ protected void saveActions(Collection actions, Logger logger) { ClusterContext ctx = ClusterContextThreadLocal.getContext(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/PortAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/PortAuditor.java index 479842c48d..2df883d4e7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/PortAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/PortAuditor.java @@ -43,9 +43,6 @@ import org.aspectj.lang.annotation.Aspect; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -/** - * - */ @Aspect public class PortAuditor extends NiFiAuditor { @@ -54,9 +51,9 @@ public class PortAuditor extends NiFiAuditor { /** * Audits the creation of a port. * - * @param proceedingJoinPoint - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @return port + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.PortDAO+) && " + "execution(org.apache.nifi.connectable.Port createPort(java.lang.String, org.apache.nifi.web.api.dto.PortDTO))") @@ -78,12 +75,12 @@ public class PortAuditor extends NiFiAuditor { /** * Audits the update of a port. * - * @param proceedingJoinPoint - * @param groupId - * @param portDTO - * @param portDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param portDTO port dto + * @param portDAO port dao + * @return port + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.PortDAO+) && " + "execution(org.apache.nifi.connectable.Port updatePort(java.lang.String, org.apache.nifi.web.api.dto.PortDTO)) && " @@ -263,11 +260,11 @@ public class PortAuditor extends NiFiAuditor { /** * Audits the removal of a processor via deleteProcessor(). * - * @param proceedingJoinPoint - * @param groupId - * @param portId - * @param portDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param portId port id + * @param portDAO port dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.PortDAO+) && " + "execution(void deletePort(java.lang.String, java.lang.String)) && " @@ -293,9 +290,9 @@ public class PortAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of the specified port. * - * @param port - * @param operation - * @return + * @param port port + * @param operation operation + * @return action */ public Action generateAuditRecord(Port port, Operation operation) { return generateAuditRecord(port, operation, null); @@ -304,10 +301,10 @@ public class PortAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of the specified port. * - * @param port - * @param operation - * @param actionDetails - * @return + * @param port port + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecord(Port port, Operation operation, ActionDetails actionDetails) { Action action = null; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessGroupAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessGroupAuditor.java index 7acf4e2cf1..fa5ac7061d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessGroupAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessGroupAuditor.java @@ -47,16 +47,12 @@ public class ProcessGroupAuditor extends NiFiAuditor { /** * Audits the creation of process groups via createProcessGroup(). * - * This method only needs to be run 'after returning'. However, in Java 7 - * the order in which these methods are returned from - * Class.getDeclaredMethods (even though there is no order guaranteed) seems - * to differ from Java 6. SpringAOP depends on this ordering to determine - * advice precedence. By normalizing all advice into Around advice we can - * alleviate this issue. + * This method only needs to be run 'after returning'. However, in Java 7 the order in which these methods are returned from Class.getDeclaredMethods (even though there is no order guaranteed) + * seems to differ from Java 6. SpringAOP depends on this ordering to determine advice precedence. By normalizing all advice into Around advice we can alleviate this issue. * - * @param proceedingJoinPoint - * @return - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @return group + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.dao.ProcessGroupDAO+) && " + "execution(org.apache.nifi.groups.ProcessGroup createProcessGroup(java.lang.String, org.apache.nifi.web.api.dto.ProcessGroupDTO))") @@ -79,10 +75,10 @@ public class ProcessGroupAuditor extends NiFiAuditor { /** * Audits the update of process group configuration. * - * @param proceedingJoinPoint - * @param processGroupDTO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param processGroupDTO dto + * @return group + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ProcessGroupDAO+) && " + "execution(org.apache.nifi.groups.ProcessGroup updateProcessGroup(org.apache.nifi.web.api.dto.ProcessGroupDTO)) && " @@ -190,9 +186,9 @@ public class ProcessGroupAuditor extends NiFiAuditor { /** * Audits the removal of a process group via deleteProcessGroup(). * - * @param proceedingJoinPoint - * @param groupId - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ProcessGroupDAO+) && " + "execution(void deleteProcessGroup(java.lang.String)) && " @@ -218,9 +214,9 @@ public class ProcessGroupAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a process group. * - * @param processGroup - * @param operation - * @return + * @param processGroup group + * @param operation operation + * @return action */ public Action generateAuditRecord(ProcessGroup processGroup, Operation operation) { return generateAuditRecord(processGroup, operation, null); @@ -229,10 +225,10 @@ public class ProcessGroupAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a process group. * - * @param processGroup - * @param operation - * @param actionDetails - * @return + * @param processGroup group + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecord(ProcessGroup processGroup, Operation operation, ActionDetails actionDetails) { Action action = null; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessorAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessorAuditor.java index 0a9f857294..23df486b11 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessorAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ProcessorAuditor.java @@ -71,16 +71,12 @@ public class ProcessorAuditor extends NiFiAuditor { /** * Audits the creation of processors via createProcessor(). * - * This method only needs to be run 'after returning'. However, in Java 7 - * the order in which these methods are returned from - * Class.getDeclaredMethods (even though there is no order guaranteed) seems - * to differ from Java 6. SpringAOP depends on this ordering to determine - * advice precedence. By normalizing all advice into Around advice we can - * alleviate this issue. + * This method only needs to be run 'after returning'. However, in Java 7 the order in which these methods are returned from Class.getDeclaredMethods (even though there is no order guaranteed) + * seems to differ from Java 6. SpringAOP depends on this ordering to determine advice precedence. By normalizing all advice into Around advice we can alleviate this issue. * - * @param proceedingJoinPoint - * @return - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @return node + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.dao.ProcessorDAO+) && " + "execution(org.apache.nifi.controller.ProcessorNode createProcessor(java.lang.String, org.apache.nifi.web.api.dto.ProcessorDTO))") @@ -102,12 +98,12 @@ public class ProcessorAuditor extends NiFiAuditor { /** * Audits the configuration of a single processor. * - * @param proceedingJoinPoint - * @param groupId - * @param processorDTO - * @param processorDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param processorDTO dto + * @param processorDAO dao + * @return node + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ProcessorDAO+) && " + "execution(org.apache.nifi.controller.ProcessorNode updateProcessor(java.lang.String, org.apache.nifi.web.api.dto.ProcessorDTO)) && " @@ -237,11 +233,11 @@ public class ProcessorAuditor extends NiFiAuditor { /** * Audits the removal of a processor via deleteProcessor(). * - * @param proceedingJoinPoint - * @param groupId - * @param processorId - * @param processorDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param processorId processor id + * @param processorDAO dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ProcessorDAO+) && " + "execution(void deleteProcessor(java.lang.String, java.lang.String)) && " @@ -267,9 +263,9 @@ public class ProcessorAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a processor. * - * @param processor - * @param operation - * @return + * @param processor processor + * @param operation operation + * @return action */ public Action generateAuditRecord(ProcessorNode processor, Operation operation) { return generateAuditRecord(processor, operation, null); @@ -278,10 +274,10 @@ public class ProcessorAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a processor. * - * @param processor - * @param operation - * @param actionDetails - * @return + * @param processor processor + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecord(ProcessorNode processor, Operation operation, ActionDetails actionDetails) { Action action = null; @@ -315,12 +311,7 @@ public class ProcessorAuditor extends NiFiAuditor { } /** - * Extracts the values for the configured properties from the specified - * Processor. - * - * @param processor - * @param processorDTO - * @return + * Extracts the values for the configured properties from the specified Processor. */ private Map extractConfiguredPropertyValues(ProcessorNode processor, ProcessorDTO processorDTO) { Map values = new HashMap<>(); @@ -389,12 +380,11 @@ public class ProcessorAuditor extends NiFiAuditor { } /** - * Locates the actual property descriptor for the given spec property - * descriptor. + * Locates the actual property descriptor for the given spec property descriptor. * - * @param propertyDescriptors - * @param specDescriptor - * @return + * @param propertyDescriptors properties + * @param specDescriptor example property + * @return property */ private PropertyDescriptor locatePropertyDescriptor(Set propertyDescriptors, PropertyDescriptor specDescriptor) { for (PropertyDescriptor propertyDescriptor : propertyDescriptors) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RelationshipAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RelationshipAuditor.java index b6519041c0..c55a1c67a4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RelationshipAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RelationshipAuditor.java @@ -69,16 +69,12 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Audits the creation of relationships via createConnection(). * - * This method only needs to be run 'after returning'. However, in Java 7 - * the order in which these methods are returned from - * Class.getDeclaredMethods (even though there is no order guaranteed) seems - * to differ from Java 6. SpringAOP depends on this ordering to determine - * advice precedence. By normalizing all advice into Around advice we can - * alleviate this issue. + * This method only needs to be run 'after returning'. However, in Java 7 the order in which these methods are returned from Class.getDeclaredMethods (even though there is no order guaranteed) + * seems to differ from Java 6. SpringAOP depends on this ordering to determine advice precedence. By normalizing all advice into Around advice we can alleviate this issue. * - * @param proceedingJoinPoint - * @return - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @return connection + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.dao.ConnectionDAO+) && " + "execution(org.apache.nifi.connectable.Connection createConnection(java.lang.String, org.apache.nifi.web.api.dto.ConnectionDTO))") @@ -101,12 +97,12 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Audits the creation and removal of relationships via updateConnection(). * - * @param proceedingJoinPoint - * @param groupId - * @param connectionDTO - * @param connectionDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param connectionDTO dto + * @param connectionDAO dao + * @return connection + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ConnectionDAO+) && " + "execution(org.apache.nifi.connectable.Connection updateConnection(java.lang.String, org.apache.nifi.web.api.dto.ConnectionDTO)) && " @@ -215,11 +211,11 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Audits the removal of relationships via deleteConnection(). * - * @param proceedingJoinPoint - * @param groupId - * @param id - * @param connectionDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param id id + * @param connectionDAO dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ConnectionDAO+) && " + "execution(void deleteConnection(java.lang.String, java.lang.String)) && " @@ -249,11 +245,11 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Creates action details for connect/disconnect actions. * - * @param connection - * @param source - * @param relationships - * @param destination - * @return + * @param connection connection + * @param source source + * @param relationships relationships + * @param destination destinations + * @return details */ public ConnectDetails createConnectDetails(final Connection connection, final Connectable source, final Collection relationships, final Connectable destination) { final Component sourceType = determineConnectableType(source); @@ -279,12 +275,11 @@ public class RelationshipAuditor extends NiFiAuditor { } /** - * Extracts configured settings from the specified connection only if they - * have also been specified in the connectionDTO. + * Extracts configured settings from the specified connection only if they have also been specified in the connectionDTO. * - * @param connection - * @param connectionDTO - * @return + * @param connection connection + * @param connectionDTO dto + * @return properties */ private Map extractConfiguredPropertyValues(Connection connection, ConnectionDTO connectionDTO) { Map values = new HashMap<>(); @@ -315,9 +310,9 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Generates the audit records for the specified connection. * - * @param connection - * @param operation - * @return + * @param connection connection + * @param operation operation + * @return action */ public Action generateAuditRecordForConnection(Connection connection, Operation operation) { return generateAuditRecordForConnection(connection, operation, null); @@ -326,10 +321,10 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Generates the audit records for the specified connection. * - * @param connection - * @param operation - * @param actionDetails - * @return + * @param connection connection + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecordForConnection(Connection connection, Operation operation, ActionDetails actionDetails) { Action action = null; @@ -374,9 +369,6 @@ public class RelationshipAuditor extends NiFiAuditor { /** * Determines the type of component the specified connectable is. - * - * @param connectable - * @return */ private Component determineConnectableType(Connectable connectable) { String sourceId = connectable.getIdentifier(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RemoteProcessGroupAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RemoteProcessGroupAuditor.java index ba9e629749..f201fe2fb5 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RemoteProcessGroupAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/RemoteProcessGroupAuditor.java @@ -50,19 +50,14 @@ public class RemoteProcessGroupAuditor extends NiFiAuditor { private static final Logger logger = LoggerFactory.getLogger(RemoteProcessGroupAuditor.class); /** - * Audits the creation of remote process groups via - * createRemoteProcessGroup(). + * Audits the creation of remote process groups via createRemoteProcessGroup(). * - * This method only needs to be run 'after returning'. However, in Java 7 - * the order in which these methods are returned from - * Class.getDeclaredMethods (even though there is no order guaranteed) seems - * to differ from Java 6. SpringAOP depends on this ordering to determine - * advice precedence. By normalizing all advice into Around advice we can - * alleviate this issue. + * This method only needs to be run 'after returning'. However, in Java 7 the order in which these methods are returned from Class.getDeclaredMethods (even though there is no order guaranteed) + * seems to differ from Java 6. SpringAOP depends on this ordering to determine advice precedence. By normalizing all advice into Around advice we can alleviate this issue. * - * @param proceedingJoinPoint - * @return - * @throws java.lang.Throwable + * @param proceedingJoinPoint join point + * @return group + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.dao.RemoteProcessGroupDAO+) && " + "execution(org.apache.nifi.groups.RemoteProcessGroup createRemoteProcessGroup(java.lang.String, org.apache.nifi.web.api.dto.RemoteProcessGroupDTO))") @@ -85,18 +80,19 @@ public class RemoteProcessGroupAuditor extends NiFiAuditor { /** * Audits the update of remote process group configuration. * - * @param proceedingJoinPoint - * @param groupId - * @param remoteProcessGroupDTO - * @param remoteProcessGroupDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param remoteProcessGroupDTO dto + * @param remoteProcessGroupDAO dao + * @return group + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.RemoteProcessGroupDAO+) && " + "execution(org.apache.nifi.groups.RemoteProcessGroup updateRemoteProcessGroup(java.lang.String, org.apache.nifi.web.api.dto.RemoteProcessGroupDTO)) && " + "args(groupId, remoteProcessGroupDTO) && " + "target(remoteProcessGroupDAO)") - public RemoteProcessGroup auditUpdateProcessGroupConfiguration(ProceedingJoinPoint proceedingJoinPoint, String groupId, RemoteProcessGroupDTO remoteProcessGroupDTO, RemoteProcessGroupDAO remoteProcessGroupDAO) throws Throwable { + public RemoteProcessGroup auditUpdateProcessGroupConfiguration( + ProceedingJoinPoint proceedingJoinPoint, String groupId, RemoteProcessGroupDTO remoteProcessGroupDTO, RemoteProcessGroupDAO remoteProcessGroupDAO) throws Throwable { final RemoteProcessGroup remoteProcessGroup = remoteProcessGroupDAO.getRemoteProcessGroup(groupId, remoteProcessGroupDTO.getId()); // record the current value of this remoteProcessGroups configuration for comparisons later @@ -300,11 +296,11 @@ public class RemoteProcessGroupAuditor extends NiFiAuditor { /** * Audits the removal of a process group via deleteProcessGroup(). * - * @param proceedingJoinPoint - * @param groupId - * @param remoteProcessGroupId - * @param remoteProcessGroupDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param groupId group id + * @param remoteProcessGroupId remote group id + * @param remoteProcessGroupDAO remote group dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.RemoteProcessGroupDAO+) && " + "execution(void deleteRemoteProcessGroup(java.lang.String, java.lang.String)) && " @@ -329,9 +325,9 @@ public class RemoteProcessGroupAuditor extends NiFiAuditor { /** * Generates an audit record for the specified remote process group. * - * @param remoteProcessGroup - * @param operation - * @return + * @param remoteProcessGroup group + * @param operation operation + * @return action */ public Action generateAuditRecord(RemoteProcessGroup remoteProcessGroup, Operation operation) { return generateAuditRecord(remoteProcessGroup, operation, null); @@ -340,10 +336,10 @@ public class RemoteProcessGroupAuditor extends NiFiAuditor { /** * Generates an audit record for the specified remote process group. * - * @param remoteProcessGroup - * @param operation - * @param actionDetails - * @return + * @param remoteProcessGroup group + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecord(RemoteProcessGroup remoteProcessGroup, Operation operation, ActionDetails actionDetails) { Action action = null; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ReportingTaskAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ReportingTaskAuditor.java index 38aaf1fcfd..bad91ec740 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ReportingTaskAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/ReportingTaskAuditor.java @@ -56,16 +56,12 @@ public class ReportingTaskAuditor extends NiFiAuditor { /** * Audits the creation of reporting task via createReportingTask(). * - * This method only needs to be run 'after returning'. However, in Java 7 - * the order in which these methods are returned from - * Class.getDeclaredMethods (even though there is no order guaranteed) seems - * to differ from Java 6. SpringAOP depends on this ordering to determine - * advice precedence. By normalizing all advice into Around advice we can - * alleviate this issue. + * This method only needs to be run 'after returning'. However, in Java 7 the order in which these methods are returned from Class.getDeclaredMethods (even though there is no order guaranteed) + * seems to differ from Java 6. SpringAOP depends on this ordering to determine advice precedence. By normalizing all advice into Around advice we can alleviate this issue. * - * @param proceedingJoinPoint - * @return - * @throws java.lang.Throwable + * @param proceedingJoinPoint joinpoint + * @return node + * @throws java.lang.Throwable ex */ @Around("within(org.apache.nifi.web.dao.ReportingTaskDAO+) && " + "execution(org.apache.nifi.controller.ReportingTaskNode createReportingTask(org.apache.nifi.web.api.dto.ReportingTaskDTO))") @@ -87,11 +83,11 @@ public class ReportingTaskAuditor extends NiFiAuditor { /** * Audits the configuration of a reporting task. * - * @param proceedingJoinPoint - * @param reportingTaskDTO - * @param reportingTaskDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint joinpoint + * @param reportingTaskDTO dto + * @param reportingTaskDAO dao + * @return object + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ReportingTaskDAO+) && " + "execution(org.apache.nifi.controller.ReportingTaskNode updateReportingTask(org.apache.nifi.web.api.dto.ReportingTaskDTO)) && " @@ -220,10 +216,10 @@ public class ReportingTaskAuditor extends NiFiAuditor { /** * Audits the removal of a reporting task via deleteReportingTask(). * - * @param proceedingJoinPoint - * @param reportingTaskId - * @param reportingTaskDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param reportingTaskId task id + * @param reportingTaskDAO task dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.ReportingTaskDAO+) && " + "execution(void deleteReportingTask(java.lang.String)) && " @@ -249,9 +245,9 @@ public class ReportingTaskAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a reporting task. * - * @param reportingTask - * @param operation - * @return + * @param reportingTask task + * @param operation operation + * @return action */ public Action generateAuditRecord(ReportingTaskNode reportingTask, Operation operation) { return generateAuditRecord(reportingTask, operation, null); @@ -260,10 +256,10 @@ public class ReportingTaskAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of a reporting task. * - * @param reportingTask - * @param operation - * @param actionDetails - * @return + * @param reportingTask task + * @param operation operation + * @param actionDetails details + * @return action */ public Action generateAuditRecord(ReportingTaskNode reportingTask, Operation operation, ActionDetails actionDetails) { Action action = null; @@ -297,12 +293,11 @@ public class ReportingTaskAuditor extends NiFiAuditor { } /** - * Extracts the values for the configured properties from the specified - * ReportingTask. + * Extracts the values for the configured properties from the specified ReportingTask. * - * @param reportingTask - * @param reportingTaskDTO - * @return + * @param reportingTask task + * @param reportingTaskDTO dto + * @return properties of task */ private Map extractConfiguredPropertyValues(ReportingTaskNode reportingTask, ReportingTaskDTO reportingTaskDTO) { Map values = new HashMap<>(); @@ -335,12 +330,11 @@ public class ReportingTaskAuditor extends NiFiAuditor { } /** - * Locates the actual property descriptor for the given spec property - * descriptor. + * Locates the actual property descriptor for the given spec property descriptor. * - * @param propertyDescriptors - * @param specDescriptor - * @return + * @param propertyDescriptors properties + * @param specDescriptor example property + * @return property */ private PropertyDescriptor locatePropertyDescriptor(Set propertyDescriptors, PropertyDescriptor specDescriptor) { for (PropertyDescriptor propertyDescriptor : propertyDescriptors) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/SnippetAuditor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/SnippetAuditor.java index 38769bbfff..20ce7406a2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/SnippetAuditor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/audit/SnippetAuditor.java @@ -88,9 +88,9 @@ public class SnippetAuditor extends NiFiAuditor { /** * Audits copy/paste. * - * @param proceedingJoinPoint - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @return dto + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.SnippetDAO+) && " + "execution(org.apache.nifi.web.api.dto.FlowSnippetDTO copySnippet(java.lang.String, java.lang.String, java.lang.Double, java.lang.Double))") @@ -104,9 +104,9 @@ public class SnippetAuditor extends NiFiAuditor { /** * Audits the instantiation of a template. * - * @param proceedingJoinPoint - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @return dto + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.TemplateDAO+) && " + "execution(org.apache.nifi.web.api.dto.FlowSnippetDTO instantiateTemplate(java.lang.String, java.lang.Double, java.lang.Double, java.lang.String))") @@ -119,8 +119,6 @@ public class SnippetAuditor extends NiFiAuditor { /** * Audits the specified snippet. - * - * @param snippet */ private void auditSnippet(final FlowSnippetDTO snippet) { final Collection actions = new ArrayList<>(); @@ -199,9 +197,6 @@ public class SnippetAuditor extends NiFiAuditor { /** * Determines the type of component the specified connectable is. - * - * @param connectable - * @return */ private Component determineConnectableType(ConnectableDTO connectable) { Component component = Component.Controller; @@ -224,11 +219,6 @@ public class SnippetAuditor extends NiFiAuditor { /** * Generates an audit record for the creation of the specified funnel. - * - * @param id - * @param name - * @param type - * @param operation */ private Action generateAuditRecord(String id, String name, Component type, Operation operation, Date timestamp) { Action action = null; @@ -255,11 +245,11 @@ public class SnippetAuditor extends NiFiAuditor { /** * Audits a bulk move. * - * @param proceedingJoinPoint - * @param snippetDTO - * @param snippetDAO - * @return - * @throws Throwable + * @param proceedingJoinPoint join point + * @param snippetDTO dto + * @param snippetDAO dao + * @return snippet + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.SnippetDAO+) && " + "execution(org.apache.nifi.controller.Snippet updateSnippet(org.apache.nifi.web.api.dto.SnippetDTO)) && " @@ -349,10 +339,10 @@ public class SnippetAuditor extends NiFiAuditor { /** * Audits bulk delete. * - * @param proceedingJoinPoint - * @param snippetId - * @param snippetDAO - * @throws Throwable + * @param proceedingJoinPoint join point + * @param snippetId snippet id + * @param snippetDAO dao + * @throws Throwable ex */ @Around("within(org.apache.nifi.web.dao.SnippetDAO+) && " + "execution(void deleteSnippet(java.lang.String)) && " diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/IllegalClusterResourceRequestException.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/IllegalClusterResourceRequestException.java index 1336a14599..fa65504d27 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/IllegalClusterResourceRequestException.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/IllegalClusterResourceRequestException.java @@ -17,8 +17,7 @@ package org.apache.nifi.web; /** - * Exception indicating a clustering-related request was issued to a node when - * it should have been issued to the cluster manager. + * Exception indicating a clustering-related request was issued to a node when it should have been issued to the cluster manager. */ @SuppressWarnings("serial") public class IllegalClusterResourceRequestException extends RuntimeException { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiServiceFacade.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiServiceFacade.java index fbd47428c7..9436fb8f11 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiServiceFacade.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiServiceFacade.java @@ -545,7 +545,8 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { } @Override - public ConfigurationSnapshot updateRemoteProcessGroupInputPort(final Revision revision, final String groupId, final String remoteProcessGroupId, final RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) { + public ConfigurationSnapshot updateRemoteProcessGroupInputPort( + final Revision revision, final String groupId, final String remoteProcessGroupId, final RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) { return optimisticLockingManager.configureFlow(revision, new ConfigurationRequest() { @Override public RemoteProcessGroupPortDTO execute() { @@ -561,7 +562,8 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { } @Override - public ConfigurationSnapshot updateRemoteProcessGroupOutputPort(final Revision revision, final String groupId, final String remoteProcessGroupId, final RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) { + public ConfigurationSnapshot updateRemoteProcessGroupOutputPort( + final Revision revision, final String groupId, final String remoteProcessGroupId, final RemoteProcessGroupPortDTO remoteProcessGroupPortDTO) { return optimisticLockingManager.configureFlow(revision, new ConfigurationRequest() { @Override public RemoteProcessGroupPortDTO execute() { @@ -1237,7 +1239,11 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { } @Override - public ConfigurationSnapshot> updateControllerServiceReferencingComponents(final Revision revision, final String controllerServiceId, final org.apache.nifi.controller.ScheduledState scheduledState, final org.apache.nifi.controller.service.ControllerServiceState controllerServiceState) { + public ConfigurationSnapshot> updateControllerServiceReferencingComponents( + final Revision revision, + final String controllerServiceId, + final org.apache.nifi.controller.ScheduledState scheduledState, + final org.apache.nifi.controller.service.ControllerServiceState controllerServiceState) { return optimisticLockingManager.configureFlow(revision, new ConfigurationRequest>() { @Override public Set execute() { @@ -1368,7 +1374,7 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { try { userService.invalidateUserAccount(userId); } catch (final AccountNotFoundException anfe) { - // ignore + // ignore } } @@ -1774,7 +1780,7 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { final List results = bulletinRepository.findBulletins(queryBuilder.build()); // perform the query and generate the results - iterating in reverse order since we are - // getting the most recent results by ordering by timestamp desc above. this gets the + // getting the most recent results by ordering by timestamp desc above. this gets the // exact results we want but in reverse order final List bulletins = new ArrayList<>(); for (final ListIterator bulletinIter = results.listIterator(results.size()); bulletinIter.hasPrevious();) { @@ -1806,10 +1812,6 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { /** * Ensures the specified user has permission to access the specified port. - * - * @param user - * @param port - * @return */ private boolean isUserAuthorized(final NiFiUser user, final RootGroupPort port) { final boolean isSiteToSiteSecure = Boolean.TRUE.equals(properties.isSiteToSiteSecure()); @@ -1840,7 +1842,7 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { throw new WebApplicationException(new Throwable("Unable to access details for current user.")); } - // at this point we know that the user must have ROLE_NIFI because it's required + // at this point we know that the user must have ROLE_NIFI because it's required // get to the endpoint that calls this method but we'll check again anyways final Set authorities = user.getAuthorities(); if (!authorities.contains(Authority.ROLE_NIFI)) { @@ -2976,10 +2978,6 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { /** * Utility method to get the oldest of the two specified dates. - * - * @param date1 - * @param date2 - * @return */ private Date getOldestDate(final Date date1, final Date date2) { if (date1 == null && date2 == null) { @@ -3001,10 +2999,6 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { /** * Utility method to get the newest of the two specified dates. - * - * @param date1 - * @param date2 - * @return */ private Date getNewestDate(final Date date1, final Date date2) { if (date1 == null && date2 == null) { @@ -3025,11 +3019,7 @@ public class StandardNiFiServiceFacade implements NiFiServiceFacade { } /** - * Utility method for extracting component counts from the specified group - * status. - * - * @param groupStatus - * @return + * Utility method for extracting component counts from the specified group status. */ private ProcessGroupCounts extractProcessGroupCounts(ProcessGroupStatus groupStatus) { int running = 0; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebConfigurationContext.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebConfigurationContext.java index a1cfcd5867..870ba5662a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebConfigurationContext.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebConfigurationContext.java @@ -68,8 +68,7 @@ import org.apache.nifi.web.api.entity.ReportingTaskEntity; import org.apache.nifi.web.util.ClientResponseUtils; /** - * Implements the NiFiWebConfigurationContext interface to support a context in - * both standalone and clustered environments. + * Implements the NiFiWebConfigurationContext interface to support a context in both standalone and clustered environments. */ public class StandardNiFiWebConfigurationContext implements NiFiWebConfigurationContext { @@ -95,7 +94,7 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration public void saveActions(final NiFiWebRequestContext requestContext, final Collection configurationActions) { Objects.requireNonNull(configurationActions, "Actions cannot be null."); - // ensure the path could be + // ensure the path could be if (requestContext.getExtensionType() == null) { throw new IllegalArgumentException("The UI extension type must be specified."); } @@ -188,7 +187,7 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration throw new ResourceNotFoundException(String.format("Configuration request context config did not have a component ID.")); } - // ensure the path could be + // ensure the path could be if (requestContext.getExtensionType() == null) { throw new IllegalArgumentException("The UI extension type must be specified."); } @@ -225,7 +224,7 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration throw new ResourceNotFoundException(String.format("Configuration request context did not have a component ID.")); } - // ensure the path could be + // ensure the path could be if (requestContext.getExtensionType() == null) { throw new IllegalArgumentException("The UI extension type must be specified."); } @@ -259,17 +258,17 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration /** * Gets the component details using the specified request context. * - * @param requestContext - * @return + * @param requestContext context + * @return the component details using the specified request context */ ComponentDetails getComponentDetails(NiFiWebRequestContext requestContext); /** * Sets the annotation data using the specified request context. * - * @param requestContext - * @param annotationData - * @return + * @param requestContext context + * @param annotationData data + * @return details */ ComponentDetails setAnnotationData(NiFiWebConfigurationRequestContext requestContext, String annotationData); } @@ -392,8 +391,7 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration } /** - * Interprets the request/response with the underlying ControllerService - * model. + * Interprets the request/response with the underlying ControllerService model. */ private class ControllerServiceFacade implements ComponentFacade { @@ -528,8 +526,7 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration } /** - * Interprets the request/response with the underlying ControllerService - * model. + * Interprets the request/response with the underlying ControllerService model. */ private class ReportingTaskFacade implements ComponentFacade { @@ -664,11 +661,7 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration } /** - * Gets the headers for the request to replicate to each node while - * clustered. - * - * @param config - * @return + * Gets the headers for the request to replicate to each node while clustered. */ private Map getHeaders(final NiFiWebRequestContext config) { final Map headers = new HashMap<>(); @@ -694,10 +687,6 @@ public class StandardNiFiWebConfigurationContext implements NiFiWebConfiguration /** * Checks the specified response and drains the stream appropriately. - * - * @param nodeResponse - * @param revision - * @param id */ private void checkResponse(final NodeResponse nodeResponse, final String id) { if (nodeResponse.hasThrowable()) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebContext.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebContext.java index 07b982f446..37ad804c52 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebContext.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/StandardNiFiWebContext.java @@ -63,8 +63,7 @@ import org.apache.nifi.controller.ControllerServiceLookup; import org.apache.nifi.web.util.ClientResponseUtils; /** - * Implements the NiFiWebContext interface to support a context in both - * standalone and clustered environments. + * Implements the NiFiWebContext interface to support a context in both standalone and clustered environments. */ @Deprecated public class StandardNiFiWebContext implements NiFiWebContext { @@ -285,10 +284,9 @@ public class StandardNiFiWebContext implements NiFiWebContext { } /** - * Gets the headers for the request to replicate to each node while - * clustered. + * Gets the headers for the request to replicate to each node while clustered. * - * @param config config + * @param config config * @return headers */ private Map getHeaders(final NiFiWebContextConfig config) { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ApplicationResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ApplicationResource.java index 66b237eb3f..aa519256c8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ApplicationResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ApplicationResource.java @@ -90,8 +90,8 @@ public abstract class ApplicationResource { /** * Generate a resource uri based off of the specified parameters. * - * @param path - * @return + * @param path path + * @return resource uri */ protected String generateResourceUri(String... path) { UriBuilder uriBuilder = uriInfo.getBaseUriBuilder(); @@ -150,8 +150,8 @@ public abstract class ApplicationResource { /** * Edit the response headers to indicating no caching. * - * @param response - * @return + * @param response response + * @return builder */ protected ResponseBuilder noCache(ResponseBuilder response) { CacheControl cacheControl = new CacheControl(); @@ -162,12 +162,10 @@ public abstract class ApplicationResource { } /** - * If the application is operating as a node, then this method adds the - * cluster context information to the response using the response header - * 'X-CLUSTER_CONTEXT'. + * If the application is operating as a node, then this method adds the cluster context information to the response using the response header 'X-CLUSTER_CONTEXT'. * - * @param response - * @return + * @param response response + * @return builder */ protected ResponseBuilder clusterContext(ResponseBuilder response) { @@ -208,7 +206,7 @@ public abstract class ApplicationResource { Action batchAction = new Action(); batchAction.setOperation(Operation.Batch); - // copy values from prototype action + // copy values from prototype action batchAction.setTimestamp(prototypeAction.getTimestamp()); batchAction.setUserDn(prototypeAction.getUserDn()); batchAction.setUserName(prototypeAction.getUserName()); @@ -231,8 +229,7 @@ public abstract class ApplicationResource { } /** - * @return the cluster context if found in the request header - * 'X-CLUSTER_CONTEXT'. + * @return the cluster context if found in the request header 'X-CLUSTER_CONTEXT'. */ protected ClusterContext getClusterContextFromRequest() { String clusterContextHeaderValue = httpServletRequest.getHeader(WebClusterManager.CLUSTER_CONTEXT_HTTP_HEADER); @@ -253,7 +250,7 @@ public abstract class ApplicationResource { /** * Generates an Ok response with no content. * - * @return + * @return an Ok response with no content */ protected ResponseBuilder generateOkResponse() { return noCache(Response.ok()); @@ -274,7 +271,7 @@ public abstract class ApplicationResource { * Generates a 201 Created response with the specified content. * * @param uri The URI - * @param jsonResponse The content + * @param entity entity * @return The response to be built */ protected ResponseBuilder generateCreatedResponse(URI uri, Object entity) { @@ -283,10 +280,9 @@ public abstract class ApplicationResource { } /** - * Generates a 150 Node Continue response to be used within the cluster - * request handshake. + * Generates a 150 Node Continue response to be used within the cluster request handshake. * - * @return + * @return a 150 Node Continue response to be used within the cluster request handshake */ protected ResponseBuilder generateContinueResponse() { return Response.status(WebClusterManager.NODE_CONTINUE_STATUS_CODE); @@ -341,8 +337,8 @@ public abstract class ApplicationResource { protected Map getHeaders(final Map overriddenHeaders) { - final Map result = new HashMap(); - final Map overriddenHeadersIgnoreCaseMap = new TreeMap(String.CASE_INSENSITIVE_ORDER); + final Map result = new HashMap<>(); + final Map overriddenHeadersIgnoreCaseMap = new TreeMap<>(String.CASE_INSENSITIVE_ORDER); overriddenHeadersIgnoreCaseMap.putAll(overriddenHeaders); final Enumeration headerNames = httpServletRequest.getHeaderNames(); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java index 32dafb9057..7c59ceac09 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java @@ -49,11 +49,8 @@ public class BulletinBoardResource extends ApplicationResource { /** * Retrieves all the of templates in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param after Supporting querying for bulletins after a particular - * bulletin id. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param after Supporting querying for bulletins after a particular bulletin id. * @param limit The max number of bulletins to return. * @param sourceName Source name filter. Supports a regular expression. * @param message Message filter. Supports a regular expression. diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java index a99d7dfd61..b080fc651e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java @@ -87,7 +87,7 @@ public class ClusterResource extends ApplicationResource { /** * Locates the ClusterConnection sub-resource. * - * @return + * @return node resource */ @Path("/nodes") public NodeResource getNodeResource() { @@ -261,7 +261,7 @@ public class ClusterResource extends ApplicationResource { /** * Updates the processors annotation data. * - * @param httpServletRequest + * @param httpServletRequest request * @param version The revision is used to verify the client is working with the latest version of the flow. * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param processorId The id of the processor. @@ -314,7 +314,7 @@ public class ClusterResource extends ApplicationResource { /** * Updates the processors annotation data. * - * @param httpServletRequest + * @param httpServletRequest request * @param processorId The id of the processor. * @param processorEntity A processorEntity. * @return A processorEntity. diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ConnectionResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ConnectionResource.java index 5d233f78c7..137cc07e90 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ConnectionResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ConnectionResource.java @@ -85,8 +85,8 @@ public class ConnectionResource extends ApplicationResource { /** * Populate the uri's for the specified processors and their relationships. * - * @param connections - * @return + * @param connections connections + * @return dtos */ public Set populateRemainingConnectionsContent(Set connections) { for (ConnectionDTO connection : connections) { @@ -97,9 +97,6 @@ public class ConnectionResource extends ApplicationResource { /** * Populate the uri's for the specified processor and its relationships. - * - * @param connection - * @return */ private ConnectionDTO populateRemainingConnectionContent(ConnectionDTO connection) { // populate the remaining properties @@ -110,9 +107,7 @@ public class ConnectionResource extends ApplicationResource { /** * Gets all the connections. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A connectionsEntity. */ @GET @@ -145,9 +140,7 @@ public class ConnectionResource extends ApplicationResource { /** * Retrieves the specified connection. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the connection. * @return A connectionEntity. */ @@ -183,9 +176,7 @@ public class ConnectionResource extends ApplicationResource { /** * Retrieves the specified connection status history. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the connection to retrieve. * @return A statusHistoryEntity. */ @@ -220,12 +211,9 @@ public class ConnectionResource extends ApplicationResource { /** * Creates a connection. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param name The name of the connection. * @param sourceId The id of the source connectable. * @param sourceGroupId The parent group id for the source. @@ -233,19 +221,14 @@ public class ConnectionResource extends ApplicationResource { * @param bends Array of bend points in string form ["x,y", "x,y", "x,y"] * @param relationships Array of relationships. * @param flowFileExpiration The flow file expiration in minutes - * @param backPressureObjectThreshold The object count for when to apply - * back pressure. - * @param backPressureDataSizeThreshold The object size for when to apply - * back pressure. - * @param prioritizers Array of prioritizer types. These types should refer - * to one of the types in the GET /controller/prioritizers response. If this - * parameter is not specified no change will be made. If this parameter - * appears with no value (empty string), it will be treated as an empty - * array. + * @param backPressureObjectThreshold The object count for when to apply back pressure. + * @param backPressureDataSizeThreshold The object size for when to apply back pressure. + * @param prioritizers Array of prioritizer types. These types should refer to one of the types in the GET /controller/prioritizers response. If this parameter is not specified no change will be + * made. If this parameter appears with no value (empty string), it will be treated as an empty array. * @param destinationId The id of the destination connectable. * @param destinationGroupId The parent group id for the destination. * @param destinationType The type of the destination connectable. - * @param formParams + * @param formParams params * @return A connectionEntity. */ @POST @@ -378,7 +361,7 @@ public class ConnectionResource extends ApplicationResource { /** * Creates a new connection. * - * @param httpServletRequest + * @param httpServletRequest request * @param connectionEntity A connectionEntity. * @return A connectionEntity. */ @@ -466,12 +449,9 @@ public class ConnectionResource extends ApplicationResource { /** * Updates the specified relationship target. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param connectionId The id of the source processor. * @param name The name of the connection. * @param relationships Array of relationships. @@ -479,19 +459,14 @@ public class ConnectionResource extends ApplicationResource { * @param labelIndex The control point index for the connection label * @param zIndex The zIndex for this connection * @param flowFileExpiration The flow file expiration in minutes - * @param backPressureObjectThreshold The object count for when to apply - * back pressure. - * @param backPressureDataSizeThreshold The object size for when to apply - * back pressure. - * @param prioritizers Array of prioritizer types. These types should refer - * to one of the types in the GET /controller/prioritizers response. If this - * parameter is not specified no change will be made. If this parameter - * appears with no value (empty string), it will be treated as an empty - * array. + * @param backPressureObjectThreshold The object count for when to apply back pressure. + * @param backPressureDataSizeThreshold The object size for when to apply back pressure. + * @param prioritizers Array of prioritizer types. These types should refer to one of the types in the GET /controller/prioritizers response. If this parameter is not specified no change will be + * made. If this parameter appears with no value (empty string), it will be treated as an empty array. * @param destinationId The id of the destination connectable. * @param destinationGroupId The group id of the destination. * @param destinationType The type of the destination type. - * @param formParams + * @param formParams params * @return A connectionEntity. */ @PUT @@ -627,7 +602,7 @@ public class ConnectionResource extends ApplicationResource { /** * Updates the specified connection. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the connection. * @param connectionEntity A connectionEntity. * @return A connectionEntity. @@ -698,12 +673,9 @@ public class ConnectionResource extends ApplicationResource { /** * Removes the specified connection. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the connection. * @return An Entity containing the client id and an updated revision. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java index 9228be47a0..9e34201cb7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java @@ -93,7 +93,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the Provenance sub-resource. * - * @return + * @return the Provenance sub-resource */ @Path("/provenance") public ProvenanceResource getProvenanceResource() { @@ -103,7 +103,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the User sub-resource. * - * @return + * @return the User sub-resource */ @Path("/users") public UserResource getUserResource() { @@ -113,7 +113,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the User sub-resource. * - * @return + * @return the User sub-resource */ @Path("/user-groups") public UserGroupResource getUserGroupResource() { @@ -123,7 +123,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the History sub-resource. * - * @return + * @return the History sub-resource */ @Path("/history") public HistoryResource getHistoryResource() { @@ -133,7 +133,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the History sub-resource. * - * @return + * @return the History sub-resource */ @Path("/bulletin-board") public BulletinBoardResource getBulletinBoardResource() { @@ -143,7 +143,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the Template sub-resource. * - * @return + * @return the Template sub-resource */ @Path("/templates") public TemplateResource getTemplateResource() { @@ -153,7 +153,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the Snippets sub-resource. * - * @return + * @return the Snippets sub-resource */ @Path("/snippets") public SnippetResource getSnippetResource() { @@ -163,7 +163,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the Controller Services sub-resource. * - * @return + * @return the Controller Services sub-resource */ @Path("/controller-services") public ControllerServiceResource getControllerServiceResource() { @@ -173,7 +173,7 @@ public class ControllerResource extends ApplicationResource { /** * Locates the Reporting Tasks sub-resource. * - * @return + * @return the Reporting Tasks sub-resource */ @Path("/reporting-tasks") public ReportingTaskResource getReportingTaskResource() { @@ -184,7 +184,7 @@ public class ControllerResource extends ApplicationResource { * Locates the Group sub-resource. * * @param groupId The process group id - * @return + * @return the Group sub-resource */ @Path("/process-groups/{process-group-id}") public ProcessGroupResource getGroupResource(@PathParam("process-group-id") String groupId) { @@ -194,8 +194,7 @@ public class ControllerResource extends ApplicationResource { } /** - * Returns a 200 OK response to indicate this is a valid controller - * endpoint. + * Returns a 200 OK response to indicate this is a valid controller endpoint. * * @return An OK response with an empty entity body. */ @@ -212,9 +211,7 @@ public class ControllerResource extends ApplicationResource { /** * Returns the details of this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A controllerEntity. */ @GET @@ -272,22 +269,14 @@ public class ControllerResource extends ApplicationResource { } /** - * Creates a new archive of this flow controller. Note, this is a POST - * operation that returns a URI that is not representative of the thing that - * was actually created. The archive that is created cannot be referenced at - * a later time, therefore there is no corresponding URI. Instead the - * request URI is returned. + * Creates a new archive of this flow controller. Note, this is a POST operation that returns a URI that is not representative of the thing that was actually created. The archive that is created + * cannot be referenced at a later time, therefore there is no corresponding URI. Instead the request URI is returned. * - * Alternatively, we could have performed a PUT request. However, PUT - * requests are supposed to be idempotent and this endpoint is certainly - * not. + * Alternatively, we could have performed a PUT request. However, PUT requests are supposed to be idempotent and this endpoint is certainly not. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A processGroupEntity. */ @POST @@ -361,9 +350,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the status for this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A controllerStatusEntity. */ @GET @@ -391,9 +378,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the counters report for this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A countersEntity. */ @GET @@ -421,10 +406,8 @@ public class ControllerResource extends ApplicationResource { /** * Update the specified counter. This will reset the counter value to 0. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the counter. * @return A counterEntity. */ @@ -468,9 +451,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the configuration for this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A controllerConfigurationEntity. */ @GET @@ -503,18 +484,13 @@ public class ControllerResource extends ApplicationResource { /** * Update the configuration for this NiFi. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param name The name of this controller. * @param comments The comments of this controller. - * @param maxTimerDrivenThreadCount The maximum number of timer driven - * threads this controller has available. - * @param maxEventDrivenThreadCount The maximum number of timer driven - * threads this controller has available. + * @param maxTimerDrivenThreadCount The maximum number of timer driven threads this controller has available. + * @param maxEventDrivenThreadCount The maximum number of timer driven threads this controller has available. * @return A controllerConfigurationEntity. */ @PUT @@ -565,7 +541,7 @@ public class ControllerResource extends ApplicationResource { /** * Update the configuration for this NiFi. * - * @param httpServletRequest + * @param httpServletRequest request * @param configEntity A controllerConfigurationEntity. * @return A controllerConfigurationEntity. */ @@ -624,12 +600,9 @@ public class ControllerResource extends ApplicationResource { } /** - * Retrieves the user details, including the authorities, about the user - * making the request. + * Retrieves the user details, including the authorities, about the user making the request. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A authoritiesEntity. */ @GET @@ -661,9 +634,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the banners for this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A bannerEntity. */ @GET @@ -701,9 +672,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the types of processors that this NiFi supports. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A processorTypesEntity. */ @GET @@ -734,9 +703,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the types of controller services that this NiFi supports. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param serviceType Returns only services that implement this type * @return A controllerServicesTypesEntity. */ @@ -770,9 +737,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the types of reporting tasks that this NiFi supports. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A controllerServicesTypesEntity. */ @GET @@ -803,9 +768,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves the types of prioritizers that this NiFi supports. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A prioritizerTypesEntity. */ @GET @@ -836,9 +799,7 @@ public class ControllerResource extends ApplicationResource { /** * Retrieves details about this NiFi to put in the About dialog. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return An aboutEntity. */ @GET diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerServiceResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerServiceResource.java index bd3daf2136..90d031dadd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerServiceResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerServiceResource.java @@ -88,8 +88,8 @@ public class ControllerServiceResource extends ApplicationResource { /** * Populates the uri for the specified controller service. * - * @param controllerServices - * @return + * @param controllerServices services + * @return dtos */ private Set populateRemainingControllerServicesContent(final String availability, final Set controllerServices) { for (ControllerServiceDTO controllerService : controllerServices) { @@ -121,11 +121,10 @@ public class ControllerServiceResource extends ApplicationResource { } /** - * Parses the availability and ensure that the specified availability makes - * sense for the given NiFi instance. + * Parses the availability and ensure that the specified availability makes sense for the given NiFi instance. * - * @param availability - * @return + * @param availability avail + * @return avail */ private Availability parseAvailability(final String availability) { final Availability avail; @@ -146,12 +145,9 @@ public class ControllerServiceResource extends ApplicationResource { /** * Retrieves all the of controller services in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @return A controllerServicesEntity. */ @GET @@ -186,15 +182,11 @@ public class ControllerServiceResource extends ApplicationResource { /** * Creates a new controller service. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param type The type of controller service to create. * @return A controllerServiceEntity. */ @@ -233,10 +225,9 @@ public class ControllerServiceResource extends ApplicationResource { /** * Creates a new Controller Service. * - * @param httpServletRequest - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param httpServletRequest request + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param controllerServiceEntity A controllerServiceEntity. * @return A controllerServiceEntity. */ @@ -324,12 +315,9 @@ public class ControllerServiceResource extends ApplicationResource { /** * Retrieves the specified controller service. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param id The id of the controller service to retrieve * @return A controllerServiceEntity. */ @@ -366,10 +354,8 @@ public class ControllerServiceResource extends ApplicationResource { /** * Returns the descriptor for the specified property. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability avail * @param id The id of the controller service. * @param propertyName The property * @return a propertyDescriptorEntity @@ -415,12 +401,9 @@ public class ControllerServiceResource extends ApplicationResource { /** * Retrieves the references of the specified controller service. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param id The id of the controller service to retrieve * @return A controllerServiceEntity. */ @@ -458,20 +441,14 @@ public class ControllerServiceResource extends ApplicationResource { /** * Updates the references of the specified controller service. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param id The id of the controller service to retrieve - * @param state Sets the state of referencing components. A value of RUNNING - * or STOPPED will update referencing schedulable components (Processors and - * Reporting Tasks). A value of ENABLED or DISABLED will update referencing - * controller services. + * @param state Sets the state of referencing components. A value of RUNNING or STOPPED will update referencing schedulable components (Processors and Reporting Tasks). A value of ENABLED or + * DISABLED will update referencing controller services. * @return A controllerServiceEntity. */ @PUT @@ -558,27 +535,19 @@ public class ControllerServiceResource extends ApplicationResource { /** * Updates the specified controller service. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param id The id of the controller service to update. * @param name The name of the controller service * @param annotationData The annotation data for the controller service * @param comments The comments for the controller service - * @param state The state of this controller service. Should be ENABLED or - * DISABLED. - * @param markedForDeletion Array of property names whose value should be - * removed. - * @param formParams Additionally, the processor properties and styles are - * specified in the form parameters. Because the property names and styles - * differ from processor to processor they are specified in a map-like - * fashion: + * @param state The state of this controller service. Should be ENABLED or DISABLED. + * @param markedForDeletion Array of property names whose value should be removed. + * @param formParams Additionally, the processor properties and styles are specified in the form parameters. Because the property names and styles differ from processor to processor they are + * specified in a map-like fashion: *
    *
      *
    • properties[required.file.path]=/path/to/file
      • @@ -662,10 +631,9 @@ public class ControllerServiceResource extends ApplicationResource { /** * Updates the specified a new Controller Service. * - * @param httpServletRequest - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param httpServletRequest request + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param id The id of the controller service to update. * @param controllerServiceEntity A controllerServiceEntity. * @return A controllerServiceEntity. @@ -740,15 +708,11 @@ public class ControllerServiceResource extends ApplicationResource { /** * Removes the specified controller service. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the controller service is available on the - * NCM only (ncm) or on the nodes only (node). If this instance is not - * clustered all services should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the controller service is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all services should use the node + * availability. * @param id The id of the controller service to remove. * @return A entity containing the client id and an updated revision. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FunnelResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FunnelResource.java index 4e6095eb17..fd97dcafbb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FunnelResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FunnelResource.java @@ -73,8 +73,8 @@ public class FunnelResource extends ApplicationResource { /** * Populates the uri for the specified funnels. * - * @param funnels - * @return + * @param funnels funnels + * @return funnels */ public Set populateRemainingFunnelsContent(Set funnels) { for (FunnelDTO funnel : funnels) { @@ -95,9 +95,7 @@ public class FunnelResource extends ApplicationResource { /** * Retrieves all the of funnels in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A funnelsEntity. */ @GET @@ -130,12 +128,9 @@ public class FunnelResource extends ApplicationResource { /** * Creates a new funnel. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @return A funnelEntity. @@ -179,7 +174,7 @@ public class FunnelResource extends ApplicationResource { /** * Creates a new Funnel. * - * @param httpServletRequest + * @param httpServletRequest request * @param funnelEntity A funnelEntity. * @return A funnelEntity. */ @@ -259,9 +254,7 @@ public class FunnelResource extends ApplicationResource { /** * Retrieves the specified funnel. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the funnel to retrieve * @return A funnelEntity. */ @@ -295,12 +288,9 @@ public class FunnelResource extends ApplicationResource { /** * Updates the specified funnel. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the funnel to update. * @param parentGroupId The id of the process group to move this funnel to. * @param x The x coordinate for this funnels position. @@ -350,7 +340,7 @@ public class FunnelResource extends ApplicationResource { /** * Creates a new Funnel. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the funnel to update. * @param funnelEntity A funnelEntity. * @return A funnelEntity. @@ -422,12 +412,9 @@ public class FunnelResource extends ApplicationResource { /** * Removes the specified funnel. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the funnel to remove. * @return A entity containing the client id and an updated revision. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/HistoryResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/HistoryResource.java index 49bede821d..749863cdc8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/HistoryResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/HistoryResource.java @@ -51,29 +51,17 @@ public class HistoryResource extends ApplicationResource { /** * Queries the history of this Controller. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param offset The offset into the data. This parameter is required and is - * used in conjunction with count. - * @param count The number of rows that should be returned. This parameter - * is required and is used in conjunction with page. - * @param sortColumn The column to sort on. This parameter is optional. If - * not specified the results will be returned with the most recent first. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param offset The offset into the data. This parameter is required and is used in conjunction with count. + * @param count The number of rows that should be returned. This parameter is required and is used in conjunction with page. + * @param sortColumn The column to sort on. This parameter is optional. If not specified the results will be returned with the most recent first. * @param sortOrder The sort order. - * @param startDate The start date/time for the query. The start date/time - * must be formatted as 'MM/dd/yyyy HH:mm:ss'. This parameter is optional - * and must be specified in the timezone of the server. The server's - * timezone can be determined by inspecting the result of a status or - * history request. - * @param endDate The end date/time for the query. The end date/time must be - * formatted as 'MM/dd/yyyy HH:mm:ss'. This parameter is optional and must - * be specified in the timezone of the server. The server's timezone can be - * determined by inspecting the result of a status or history request. - * @param userName The user name of the user who's actions are being - * queried. This parameter is optional. - * @param sourceId The id of the source being queried (usually a processor - * id). This parameter is optional. + * @param startDate The start date/time for the query. The start date/time must be formatted as 'MM/dd/yyyy HH:mm:ss'. This parameter is optional and must be specified in the timezone of the + * server. The server's timezone can be determined by inspecting the result of a status or history request. + * @param endDate The end date/time for the query. The end date/time must be formatted as 'MM/dd/yyyy HH:mm:ss'. This parameter is optional and must be specified in the timezone of the server. The + * server's timezone can be determined by inspecting the result of a status or history request. + * @param userName The user name of the user who's actions are being queried. This parameter is optional. + * @param sourceId The id of the source being queried (usually a processor id). This parameter is optional. * @return A historyEntity. */ @GET @@ -160,9 +148,7 @@ public class HistoryResource extends ApplicationResource { /** * Gets the action for the corresponding id. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the action to get. * @return An actionEntity. */ @@ -198,9 +184,7 @@ public class HistoryResource extends ApplicationResource { /** * Deletes flow history from the specified end date. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param endDate The end date for the purge action. * @return A historyEntity */ @@ -235,9 +219,7 @@ public class HistoryResource extends ApplicationResource { /** * Gets the actions for the specified processor. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param processorId The id of the processor. * @return An processorHistoryEntity. */ @@ -266,9 +248,7 @@ public class HistoryResource extends ApplicationResource { /** * Gets the actions for the specified controller service. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param controllerServiceId The id of the controller service. * @return An componentHistoryEntity. */ @@ -297,9 +277,7 @@ public class HistoryResource extends ApplicationResource { /** * Gets the actions for the specified reporting task. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param reportingTaskId The id of the reporting task. * @return An componentHistoryEntity. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/InputPortResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/InputPortResource.java index 9b5eeba5c1..4e446fb6f7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/InputPortResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/InputPortResource.java @@ -75,8 +75,8 @@ public class InputPortResource extends ApplicationResource { /** * Populates the uri for the specified input ports. * - * @param inputPorts - * @return + * @param inputPorts ports + * @return ports */ public Set populateRemainingInputPortsContent(Set inputPorts) { for (PortDTO inputPort : inputPorts) { @@ -97,9 +97,7 @@ public class InputPortResource extends ApplicationResource { /** * Retrieves all the of input ports in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A inputPortsEntity. */ @GET @@ -132,12 +130,9 @@ public class InputPortResource extends ApplicationResource { /** * Creates a new input port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @param name The input ports name. @@ -185,7 +180,7 @@ public class InputPortResource extends ApplicationResource { /** * Creates a new input port. * - * @param httpServletRequest + * @param httpServletRequest request * @param portEntity A inputPortEntity. * @return A inputPortEntity. */ @@ -266,9 +261,7 @@ public class InputPortResource extends ApplicationResource { /** * Retrieves the specified input port. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the input port to retrieve * @return A inputPortEntity. */ @@ -302,12 +295,9 @@ public class InputPortResource extends ApplicationResource { /** * Updates the specified input port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the input port to update. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. @@ -316,9 +306,8 @@ public class InputPortResource extends ApplicationResource { * @param comments Any comments about this input port. * @param name The input ports name. * @param state The state of this port. - * @param concurrentlySchedulableTaskCount The number of concurrently - * schedulable tasks. - * @param formParams + * @param concurrentlySchedulableTaskCount The number of concurrently schedulable tasks. + * @param formParams form params * @return A inputPortEntity. */ @PUT @@ -387,7 +376,7 @@ public class InputPortResource extends ApplicationResource { /** * Updates the specified input port. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the input port to update. * @param portEntity A inputPortEntity. * @return A inputPortEntity. @@ -460,12 +449,9 @@ public class InputPortResource extends ApplicationResource { /** * Removes the specified input port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the input port to remove. * @return A inputPortEntity. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/LabelResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/LabelResource.java index 4905ad39da..6b12d0efd2 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/LabelResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/LabelResource.java @@ -75,8 +75,8 @@ public class LabelResource extends ApplicationResource { /** * Populates the uri for the specified labels. * - * @param labels - * @return + * @param labels labels + * @return dtos */ public Set populateRemainingLabelsContent(Set labels) { for (LabelDTO label : labels) { @@ -97,9 +97,7 @@ public class LabelResource extends ApplicationResource { /** * Retrieves all the of labels in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A labelsEntity. */ @GET @@ -132,12 +130,9 @@ public class LabelResource extends ApplicationResource { /** * Creates a new label. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @param width The width of the label. @@ -195,7 +190,7 @@ public class LabelResource extends ApplicationResource { /** * Creates a new Label. * - * @param httpServletRequest + * @param httpServletRequest request * @param labelEntity A labelEntity. * @return A labelEntity. */ @@ -275,9 +270,7 @@ public class LabelResource extends ApplicationResource { /** * Retrieves the specified label. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the label to retrieve * @return A labelEntity. */ @@ -311,20 +304,16 @@ public class LabelResource extends ApplicationResource { /** * Updates the specified label. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the label to update. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @param width The width of the label. * @param height The height of the label. * @param label The label's value. - * @param formParams Additionally, the label styles are specified in the - * form parameters. They are specified in a map-like fashion: + * @param formParams Additionally, the label styles are specified in the form parameters. They are specified in a map-like fashion: *
      *
        *
      • style[background-color]=#aaaaaa
        • @@ -405,7 +394,7 @@ public class LabelResource extends ApplicationResource { /** * Updates the specified label. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the label to update. * @param labelEntity A labelEntity. * @return A labelEntity. @@ -477,12 +466,9 @@ public class LabelResource extends ApplicationResource { /** * Removes the specified label. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the label to remove. * @return A entity containing the client id and an updated revision. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java index db3d040e34..bb0eba98ea 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/NodeResource.java @@ -54,9 +54,7 @@ public class NodeResource extends ApplicationResource { /** * Gets the contents of the specified node in this NiFi cluster. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The node id. * @return A nodeEntity. */ @@ -92,9 +90,7 @@ public class NodeResource extends ApplicationResource { /** * Gets the status for the specified node. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the node. * @return A processGroupStatusEntity */ @@ -128,9 +124,7 @@ public class NodeResource extends ApplicationResource { /** * Gets the system diagnositics for the specified node. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the node. * @return A systemDiagnosticsEntity */ @@ -164,9 +158,7 @@ public class NodeResource extends ApplicationResource { /** * Updates the contents of the specified node in this NiFi cluster. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the node. * @param status The status of the node. * @param primary Whether the node should be make primary. @@ -256,9 +248,7 @@ public class NodeResource extends ApplicationResource { /** * Removes the specified from this NiFi cluster. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the node * @return A nodeEntity */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/OutputPortResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/OutputPortResource.java index 168ec906ff..a600d356e5 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/OutputPortResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/OutputPortResource.java @@ -75,8 +75,8 @@ public class OutputPortResource extends ApplicationResource { /** * Populates the uri for the specified output ports. * - * @param outputPorts - * @return + * @param outputPorts ports + * @return dtos */ public Set populateRemainingOutputPortsContent(Set outputPorts) { for (PortDTO outputPort : outputPorts) { @@ -97,9 +97,7 @@ public class OutputPortResource extends ApplicationResource { /** * Retrieves all the of output ports in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A outputPortsEntity. */ @GET @@ -132,12 +130,9 @@ public class OutputPortResource extends ApplicationResource { /** * Creates a new output port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @param name The output ports name. @@ -185,7 +180,7 @@ public class OutputPortResource extends ApplicationResource { /** * Creates a new output port. * - * @param httpServletRequest + * @param httpServletRequest request * @param portEntity A outputPortEntity. * @return A outputPortEntity. */ @@ -266,9 +261,7 @@ public class OutputPortResource extends ApplicationResource { /** * Retrieves the specified output port. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the output port to retrieve * @return A outputPortEntity. */ @@ -302,12 +295,9 @@ public class OutputPortResource extends ApplicationResource { /** * Updates the specified output port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the output port to update. * @param x The x coordinate for this output ports position. * @param y The y coordinate for this output ports position. @@ -316,9 +306,8 @@ public class OutputPortResource extends ApplicationResource { * @param groupAccessControl The allowed groups for this output port. * @param userAccessControl The allowed users for this output port. * @param state The state of this port. - * @param concurrentlySchedulableTaskCount The number of concurrently - * schedulable tasks. - * @param formParams + * @param concurrentlySchedulableTaskCount The number of concurrently schedulable tasks. + * @param formParams params * @return A outputPortEntity. */ @PUT @@ -388,7 +377,7 @@ public class OutputPortResource extends ApplicationResource { /** * Updates the specified output port. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the output port to update. * @param portEntity A outputPortEntity. * @return A outputPortEntity. @@ -461,12 +450,9 @@ public class OutputPortResource extends ApplicationResource { /** * Removes the specified output port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the output port to remove. * @return A outputPortEntity. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java index 1bf3f7779a..2b3657e02a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java @@ -84,7 +84,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Get the processor resource within the specified group. * - * @return + * @return the processor resource within the specified group */ @Path("processors") public ProcessorResource getProcessorResource() { @@ -96,7 +96,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Get the connection sub-resource within the specified group. * - * @return + * @return the connection sub-resource within the specified group */ @Path("connections") public ConnectionResource getConnectionResource() { @@ -108,7 +108,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Get the input ports sub-resource within the specified group. * - * @return + * @return the input ports sub-resource within the specified group */ @Path("input-ports") public InputPortResource getInputPortResource() { @@ -120,7 +120,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Get the output ports sub-resource within the specified group. * - * @return + * @return the output ports sub-resource within the specified group */ @Path("output-ports") public OutputPortResource getOutputPortResource() { @@ -132,7 +132,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Locates the label sub-resource within the specified group. * - * @return + * @return the label sub-resource within the specified group */ @Path("labels") public LabelResource getLabelResource() { @@ -144,7 +144,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Locates the funnel sub-resource within the specified group. * - * @return + * @return the funnel sub-resource within the specified group */ @Path("funnels") public FunnelResource getFunnelResource() { @@ -156,7 +156,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Locates the remote process group sub-resource within the specified group. * - * @return + * @return the remote process group sub-resource within the specified group */ @Path("remote-process-groups") public RemoteProcessGroupResource getRemoteProcessGroupResource() { @@ -168,8 +168,8 @@ public class ProcessGroupResource extends ApplicationResource { /** * Populates the remaining fields in the specified process groups. * - * @param processGroups - * @return + * @param processGroups groups + * @return group dto */ public Set populateRemainingProcessGroupsContent(Set processGroups) { for (ProcessGroupDTO processGroup : processGroups) { @@ -181,9 +181,9 @@ public class ProcessGroupResource extends ApplicationResource { /** * Populates the remaining fields in the specified process group. * - * @param processGroup - * @param verbose - * @return + * @param processGroup group + * @param processGroupUri processGroupUri + * @return group dto */ private ProcessGroupDTO populateRemainingProcessGroupContent(ProcessGroupDTO processGroup, String processGroupUri) { FlowSnippetDTO flowSnippet = processGroup.getContents(); @@ -201,9 +201,6 @@ public class ProcessGroupResource extends ApplicationResource { /** * Populates the remaining content of the specified snippet. - * - * @param snippet - * @return */ private FlowSnippetDTO populateRemainingSnippetContent(FlowSnippetDTO snippet) { getProcessorResource().populateRemainingProcessorsContent(snippet.getProcessors()); @@ -224,9 +221,6 @@ public class ProcessGroupResource extends ApplicationResource { /** * Generates a URI for a process group. - * - * @param processGroupId - * @return */ private String getProcessGroupUri(String processGroupId) { return generateResourceUri("controller", "process-groups", processGroupId); @@ -234,28 +228,17 @@ public class ProcessGroupResource extends ApplicationResource { /** * Generates a URI for a process group reference. - * - * @param processGroupId - * @return */ private String getProcessGroupReferenceUri(ProcessGroupDTO processGroup) { return generateResourceUri("controller", "process-groups", processGroup.getParentGroupId(), "process-group-references", processGroup.getId()); } /** - * Retrieves the content of the specified group. This includes all - * processors, the connections, the process group references, the remote - * process group references, and the labels. + * Retrieves the content of the specified group. This includes all processors, the connections, the process group references, the remote process group references, and the labels. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param recursive Optional recursive flag that defaults to false. If set - * to true, all descendent groups and their content will be included if the - * verbose flag is also set to true. - * @param verbose Optional verbose flag that defaults to false. If the - * verbose flag is set to true processor configuration and property details - * will be included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param recursive Optional recursive flag that defaults to false. If set to true, all descendent groups and their content will be included if the verbose flag is also set to true. + * @param verbose Optional verbose flag that defaults to false. If the verbose flag is set to true processor configuration and property details will be included in the response. * @return A processGroupEntity. */ @GET @@ -300,12 +283,9 @@ public class ProcessGroupResource extends ApplicationResource { /** * Copies the specified snippet within this ProcessGroup. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param snippetId The id of the snippet to copy. * @param originX The x coordinate of the origin of the bounding box. * @param originY The y coordinate of the origin of the bounding box. @@ -379,12 +359,9 @@ public class ProcessGroupResource extends ApplicationResource { /** * Instantiates the specified template within this ProcessGroup. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param templateId The id of the template to instantiate. * @param originX The x coordinate of the origin of the bounding box. * @param originY The y coordinate of the origin of the bounding box. @@ -453,18 +430,12 @@ public class ProcessGroupResource extends ApplicationResource { } /** - * Updates the state of all processors in the process group. Supports - * modifying whether the processors and process groups are running/stopped - * and instantiating templates. + * Updates the state of all processors in the process group. Supports modifying whether the processors and process groups are running/stopped and instantiating templates. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param running Optional flag that indicates whether all processors in - * this group should be started/stopped. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param running Optional flag that indicates whether all processors in this group should be started/stopped. * @return A processGroupEntity. */ @PUT @@ -501,11 +472,9 @@ public class ProcessGroupResource extends ApplicationResource { } /** - * Updates the state of all processors in the process group. Supports - * modifying whether the processors and process groups are running/stopped - * and instantiating templates. + * Updates the state of all processors in the process group. Supports modifying whether the processors and process groups are running/stopped and instantiating templates. * - * @param httpServletRequest + * @param httpServletRequest request * @param processGroupEntity A processGroupEntity * @return A processGroupEntity */ @@ -573,16 +542,10 @@ public class ProcessGroupResource extends ApplicationResource { /** * Retrieves the contents of the specified group. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param recursive Optional recursive flag that defaults to false. If set - * to true, all descendent groups and their content will be included if the - * verbose flag is also set to true. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param recursive Optional recursive flag that defaults to false. If set to true, all descendent groups and their content will be included if the verbose flag is also set to true. * @param processGroupReferenceId The id of the process group. - * @param verbose Optional verbose flag that defaults to false. If the - * verbose flag is set to true processor configuration and property details - * will be included in the response. + * @param verbose Optional verbose flag that defaults to false. If the verbose flag is set to true processor configuration and property details will be included in the response. * @return A processGroupEntity. */ @GET @@ -629,12 +592,8 @@ public class ProcessGroupResource extends ApplicationResource { /** * Retrieves the content of the specified group reference. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param verbose Optional verbose flag that defaults to false. If the - * verbose flag is set to true processor configuration and property details - * will be included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param verbose Optional verbose flag that defaults to false. If the verbose flag is set to true processor configuration and property details will be included in the response. * @return A controllerEntity. */ @GET @@ -676,12 +635,9 @@ public class ProcessGroupResource extends ApplicationResource { /** * Adds the specified process group. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param name The name of the process group * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. @@ -729,7 +685,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Adds the specified process group. * - * @param httpServletRequest + * @param httpServletRequest request * @param processGroupEntity A processGroupEntity * @return A processGroupEntity */ @@ -810,17 +766,13 @@ public class ProcessGroupResource extends ApplicationResource { /** * Updates the specified process group. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the process group * @param name The name of the process group. * @param comments The comments for the process group. - * @param running Optional flag that indicates whether all processors should - * be started/stopped. + * @param running Optional flag that indicates whether all processors should be started/stopped. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @return A processGroupEntity. @@ -874,7 +826,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Updates the specified process group. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the process group. * @param processGroupEntity A processGroupEntity. * @return A processGroupEntity. @@ -945,12 +897,9 @@ public class ProcessGroupResource extends ApplicationResource { /** * Removes the specified process group reference. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the process group to be removed. * @return A processGroupEntity. */ @@ -1002,12 +951,8 @@ public class ProcessGroupResource extends ApplicationResource { /** * Retrieves the status report for this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param recursive Optional recursive flag that defaults to false. If set - * to true, all descendent groups and their content will be included if the - * verbose flag is also set to true. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param recursive Optional recursive flag that defaults to false. If set to true, all descendent groups and their content will be included if the verbose flag is also set to true. * @return A processGroupStatusEntity. */ @GET @@ -1050,9 +995,7 @@ public class ProcessGroupResource extends ApplicationResource { /** * Retrieves the specified remote process groups status history. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A processorEntity. */ @GET diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java index 00b6fe3125..16c7e190de 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java @@ -100,8 +100,8 @@ public class ProcessorResource extends ApplicationResource { /** * Populate the uri's for the specified processors and their relationships. * - * @param processors - * @return + * @param processors processors + * @return dtos */ public Set populateRemainingProcessorsContent(Set processors) { for (ProcessorDTO processor : processors) { @@ -112,9 +112,6 @@ public class ProcessorResource extends ApplicationResource { /** * Populate the uri's for the specified processor and its relationships. - * - * @param processor - * @return */ private ProcessorDTO populateRemainingProcessorContent(ProcessorDTO processor) { // populate the remaining properties @@ -147,9 +144,7 @@ public class ProcessorResource extends ApplicationResource { /** * Retrieves all the processors in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A processorsEntity. */ @GET @@ -182,15 +177,11 @@ public class ProcessorResource extends ApplicationResource { /** * Creates a new processor. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param name The name of the new processor. - * @param type The type of the new processor. This type should refer to one - * of the types in the GET /controller/processor-types response. + * @param type The type of the new processor. This type should refer to one of the types in the GET /controller/processor-types response. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. * @return A processorEntity. @@ -238,7 +229,7 @@ public class ProcessorResource extends ApplicationResource { /** * Creates a new processor. * - * @param httpServletRequest + * @param httpServletRequest request * @param processorEntity A processorEntity. * @return A processorEntity. */ @@ -324,9 +315,7 @@ public class ProcessorResource extends ApplicationResource { /** * Retrieves the specified processor. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the processor to retrieve. * @return A processorEntity. */ @@ -361,9 +350,7 @@ public class ProcessorResource extends ApplicationResource { /** * Retrieves the specified processor status history. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the processor history to retrieve. * @return A statusHistoryEntity. */ @@ -398,9 +385,7 @@ public class ProcessorResource extends ApplicationResource { /** * Returns the descriptor for the specified property. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the processor * @param propertyName The property * @return a propertyDescriptorEntity @@ -443,18 +428,14 @@ public class ProcessorResource extends ApplicationResource { /** * Updates the specified processor with the specified values. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the processor to update. * @param x The x coordinate for this processors position. * @param y The y coordinate for this processors position. * @param name The name of the processor. - * @param concurrentlySchedulableTaskCount The number of - * concurrentlySchedulableTasks + * @param concurrentlySchedulableTaskCount The number of concurrentlySchedulableTasks * @param schedulingPeriod The scheduling period * @param schedulingStrategy The scheduling strategy * @param penaltyDuration The penalty duration @@ -462,13 +443,10 @@ public class ProcessorResource extends ApplicationResource { * @param runDurationMillis The run duration in milliseconds * @param bulletinLevel The bulletin level * @param comments Any comments about this processor. - * @param markedForDeletion Array of property names whose value should be - * removed. + * @param markedForDeletion Array of property names whose value should be removed. * @param state The processors state. - * @param formParams Additionally, the processor properties and styles are - * specified in the form parameters. Because the property names and styles - * differ from processor to processor they are specified in a map-like - * fashion: + * @param formParams Additionally, the processor properties and styles are specified in the form parameters. Because the property names and styles differ from processor to processor they are + * specified in a map-like fashion: *
        *
          *
        • properties[required.file.path]=/path/to/file
          • @@ -604,7 +582,7 @@ public class ProcessorResource extends ApplicationResource { /** * Updates the specified processor with the specified values. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the processor to update. * @param processorEntity A processorEntity. * @return A processorEntity. @@ -686,12 +664,9 @@ public class ProcessorResource extends ApplicationResource { /** * Removes the specified processor. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the processor to remove. * @return A processorEntity. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceResource.java index 5fef27fb67..4bfe3a0fe6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceResource.java @@ -113,9 +113,7 @@ public class ProvenanceResource extends ApplicationResource { /** * Gets the provenance search options for this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A provenanceOptionsEntity */ @GET @@ -146,15 +144,11 @@ public class ProvenanceResource extends ApplicationResource { } /** - * Creates a new replay request for the content associated with the - * specified provenance event id. + * Creates a new replay request for the content associated with the specified provenance event id. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param clusterNodeId The id of the node in the cluster that has the - * specified event. Required if clustered. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param clusterNodeId The id of the node in the cluster that has the specified event. Required if clustered. * @param eventId The provenance event id. * @return A provenanceEventEntity */ @@ -220,11 +214,8 @@ public class ProvenanceResource extends ApplicationResource { /** * Gets the content for the input of the specified event. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param clusterNodeId The id of the node within the cluster this content - * is on. Required if clustered. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param clusterNodeId The id of the node within the cluster this content is on. Required if clustered. * @param id The id of the provenance event associated with this content. * @return The content stream */ @@ -294,11 +285,8 @@ public class ProvenanceResource extends ApplicationResource { /** * Gets the content for the output of the specified event. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param clusterNodeId The id of the node within the cluster this content - * is on. Required if clustered. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param clusterNodeId The id of the node within the cluster this content is on. Required if clustered. * @param id The id of the provenance event associated with this content. * @return The content stream */ @@ -368,21 +356,15 @@ public class ProvenanceResource extends ApplicationResource { /** * Creates provenance using the specified query criteria. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param startDate The start date. * @param endDate The end date. * @param minimumFileSize The minimum size of the content after the event. * @param maximumFileSize The maximum size of the content after the event. * @param maxResults The maximum number of results to return. - * @param clusterNodeId The id of node in the cluster to search. This is - * optional and only relevant when clustered. If clustered and it is not - * specified the entire cluster is searched. - * @param formParams Additionally, the search parameters are specified in - * the form parameters. Because the search parameters differ based on - * configuration they are specified in a map-like fashion: + * @param clusterNodeId The id of node in the cluster to search. This is optional and only relevant when clustered. If clustered and it is not specified the entire cluster is searched. + * @param formParams Additionally, the search parameters are specified in the form parameters. Because the search parameters differ based on configuration they are specified in a map-like fashion: *
          *
            *
          • search[filename]=myFile.txt
            • @@ -467,7 +449,7 @@ public class ProvenanceResource extends ApplicationResource { /** * Creates provenance using the specified query criteria. * - * @param httpServletRequest + * @param httpServletRequest request * @param provenanceEntity A provenanceEntity * @return A provenanceEntity */ @@ -560,13 +542,9 @@ public class ProvenanceResource extends ApplicationResource { /** * Gets the provenance with the specified id. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the provenance - * @param clusterNodeId The id of node in the cluster to search. This is - * optional and only relevant when clustered. If clustered and it is not - * specified the entire cluster is searched. + * @param clusterNodeId The id of node in the cluster to search. This is optional and only relevant when clustered. If clustered and it is not specified the entire cluster is searched. * @return A provenanceEntity */ @GET @@ -621,14 +599,10 @@ public class ProvenanceResource extends ApplicationResource { /** * Deletes the provenance with the specified id. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the provenance - * @param clusterNodeId The id of node in the cluster to search. This is - * optional and only relevant when clustered. If clustered and it is not - * specified the entire cluster is searched. + * @param clusterNodeId The id of node in the cluster to search. This is optional and only relevant when clustered. If clustered and it is not specified the entire cluster is searched. * @return A provenanceEntity */ @DELETE @@ -687,12 +661,9 @@ public class ProvenanceResource extends ApplicationResource { /** * Gets the details for a provenance event. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the event - * @param clusterNodeId The id of node in the cluster that the - * event/flowfile originated from. This is only required when clustered. + * @param clusterNodeId The id of node in the cluster that the event/flowfile originated from. This is only required when clustered. * @return A provenanceEventEntity */ @GET @@ -752,29 +723,18 @@ public class ProvenanceResource extends ApplicationResource { /** * Submits a lineage request based on an event or a flowfile uuid. * - * When querying for the lineage of an event you must specify the eventId - * and the eventDirection. The eventDirection must be 'parents' or - * 'children' and specifies whether we are going up or down the flowfile - * ancestry. The uuid cannot be specified in these cases. + * When querying for the lineage of an event you must specify the eventId and the eventDirection. The eventDirection must be 'parents' or 'children' and specifies whether we are going up or down + * the flowfile ancestry. The uuid cannot be specified in these cases. * - * When querying for the lineage of a flowfile you must specify the uuid. - * The eventId and eventDirection cannot be specified in this case. + * When querying for the lineage of a flowfile you must specify the uuid. The eventId and eventDirection cannot be specified in this case. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param eventId The id of an event to get the lineage for. Must also - * specify the eventDirection and not the uuid. - * @param lineageRequest Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. - * PARENTS will return the lineage for the flowfiles that are parents of the - * specified event. CHILDREN will return the lineage of for the flowfiles - * that are children of the specified event. FLOWFILE will return the - * lineage for the specified flowfile. - * @param uuid The uuid of the flowfile to get the lineage for. Must not - * specify the eventId or eventDirection. - * @param clusterNodeId The id of node in the cluster that the - * event/flowfile originated from. This is only required when clustered. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param eventId The id of an event to get the lineage for. Must also specify the eventDirection and not the uuid. + * @param lineageRequest Either 'PARENTS', 'CHILDREN', or 'FLOWFILE'. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage of + * for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile. + * @param uuid The uuid of the flowfile to get the lineage for. Must not specify the eventId or eventDirection. + * @param clusterNodeId The id of node in the cluster that the event/flowfile originated from. This is only required when clustered. * @return A lineageEntity */ @POST @@ -829,15 +789,12 @@ public class ProvenanceResource extends ApplicationResource { /** * Submits a lineage request based on an event or a flowfile uuid. * - * When querying for the lineage of an event you must specify the eventId - * and the eventDirection. The eventDirection must be 'parents' or - * 'children' and specifies whether we are going up or down the flowfile - * ancestry. The uuid cannot be specified in these cases. + * When querying for the lineage of an event you must specify the eventId and the eventDirection. The eventDirection must be 'parents' or 'children' and specifies whether we are going up or down + * the flowfile ancestry. The uuid cannot be specified in these cases. * - * When querying for the lineage of a flowfile you must specify the uuid. - * The eventId and eventDirection cannot be specified in this case. + * When querying for the lineage of a flowfile you must specify the uuid. The eventId and eventDirection cannot be specified in this case. * - * @param httpServletRequest + * @param httpServletRequest request * @param lineageEntity A lineageEntity * @return A lineageEntity */ @@ -935,11 +892,8 @@ public class ProvenanceResource extends ApplicationResource { /** * Gets the lineage with the specified id. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param clusterNodeId The id of node in the cluster that the - * event/flowfile originated from. This is only required when clustered. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param clusterNodeId The id of node in the cluster that the event/flowfile originated from. This is only required when clustered. * @param id The id of the lineage * @return A lineageEntity */ @@ -993,12 +947,9 @@ public class ProvenanceResource extends ApplicationResource { /** * Deletes the lineage with the specified id. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param clusterNodeId The id of node in the cluster that the - * event/flowfile originated from. This is only required when clustered. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param clusterNodeId The id of node in the cluster that the event/flowfile originated from. This is only required when clustered. * @param id The id of the lineage * @return A lineageEntity */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java index b1718359ef..c506b9b24f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java @@ -81,11 +81,10 @@ public class RemoteProcessGroupResource extends ApplicationResource { private String groupId; /** - * Populates the remaining content for each remote process group. The uri - * must be generated and the remote process groups name must be retrieved. + * Populates the remaining content for each remote process group. The uri must be generated and the remote process groups name must be retrieved. * - * @param remoteProcessGroups - * @return + * @param remoteProcessGroups groups + * @return dtos */ public Set populateRemainingRemoteProcessGroupsContent(Set remoteProcessGroups) { for (RemoteProcessGroupDTO remoteProcessGroup : remoteProcessGroups) { @@ -95,12 +94,10 @@ public class RemoteProcessGroupResource extends ApplicationResource { } /** - * Populates the remaining content for the specified remote process group. - * The uri must be generated and the remote process groups name must be - * retrieved. + * Populates the remaining content for the specified remote process group. The uri must be generated and the remote process groups name must be retrieved. * - * @param remoteProcessGroup - * @return + * @param remoteProcessGroup group + * @return dto */ private RemoteProcessGroupDTO populateRemainingRemoteProcessGroupContent(RemoteProcessGroupDTO remoteProcessGroup) { // populate the remaining content @@ -112,12 +109,8 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Retrieves all the of remote process groups in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param verbose Optional verbose flag that defaults to false. If the - * verbose flag is set to true remote group contents (ports) will be - * included. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param verbose Optional verbose flag that defaults to false. If the verbose flag is set to true remote group contents (ports) will be included. * @return A remoteProcessGroupEntity. */ @GET @@ -159,12 +152,8 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Retrieves the specified remote process group. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param verbose Optional verbose flag that defaults to false. If the - * verbose flag is set to true remote group contents (ports) will be - * included. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param verbose Optional verbose flag that defaults to false. If the verbose flag is set to true remote group contents (ports) will be included. * @param id The id of the remote process group to retrieve * @return A remoteProcessGroupEntity. */ @@ -206,9 +195,7 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Retrieves the specified remote process groups status history. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the remote process group to retrieve the status fow. * @return A statusHistoryEntity. */ @@ -243,12 +230,9 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Creates a new remote process group. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param uri The uri to the remote process group that is being referenced. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. @@ -296,7 +280,7 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Creates a new remote process group. * - * @param httpServletRequest + * @param httpServletRequest request * @param remoteProcessGroupEntity A remoteProcessGroupEntity. * @return A remoteProcessGroupEntity. */ @@ -409,12 +393,9 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Removes the specified remote process group. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the remote process group to be removed. * @return A remoteProcessGroupEntity. */ @@ -465,18 +446,14 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Updates the specified remote process group input port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the remote process group to update. * @param portId The id of the input port to update. * @param isTransmitting Whether or not this port is transmitting. * @param isCompressed Whether or not this port should compress. - * @param concurrentlySchedulableTaskCount The number of concurrent tasks - * that should be supported + * @param concurrentlySchedulableTaskCount The number of concurrent tasks that should be supported * * @return A remoteProcessGroupPortEntity */ @@ -525,7 +502,7 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Updates the specified remote process group input port. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the remote process group to update. * @param portId The id of the input port to update. * @param remoteProcessGroupPortEntity The remoteProcessGroupPortEntity @@ -599,18 +576,14 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Updates the specified remote process group output port. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the remote process group to update. * @param portId The id of the output port to update. * @param isTransmitting Whether or not this port is transmitting. * @param isCompressed Whether or not this port should compress. - * @param concurrentlySchedulableTaskCount The number of concurrent tasks - * that should be supported + * @param concurrentlySchedulableTaskCount The number of concurrent tasks that should be supported * * @return A remoteProcessGroupPortEntity */ @@ -659,7 +632,7 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Updates the specified remote process group output port. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the remote process group to update. * @param portId The id of the output port to update. * @param remoteProcessGroupPortEntity The remoteProcessGroupPortEntity @@ -733,18 +706,14 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Updates the specified remote process group. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the remote process group to update. * @param isTransmitting Whether this remote process group is transmitting. * @param x The x coordinate for this funnels position. * @param y The y coordinate for this funnels position. - * @param communicationsTimeout The timeout to use when communication with - * this remote process group. + * @param communicationsTimeout The timeout to use when communication with this remote process group. * @param yieldDuration The yield duration * * @return A remoteProcessGroupEntity. @@ -798,7 +767,7 @@ public class RemoteProcessGroupResource extends ApplicationResource { /** * Updates the specified remote process group. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the remote process group to update. * @param remoteProcessGroupEntity A remoteProcessGroupEntity. * @return A remoteProcessGroupEntity. @@ -847,7 +816,7 @@ public class RemoteProcessGroupResource extends ApplicationResource { return generateContinueResponse().build(); } - // if the target uri is set we have to verify it here - we don't support updating the target uri on + // if the target uri is set we have to verify it here - we don't support updating the target uri on // an existing remote process group, however if the remote process group is being created with an id // as is the case in clustered mode we need to verify the remote process group. treat this request as // though its a new remote process group. diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java index 485b8fdc58..8aea04cc49 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java @@ -84,8 +84,8 @@ public class ReportingTaskResource extends ApplicationResource { /** * Populates the uri for the specified reporting task. * - * @param reportingTasks - * @return + * @param reportingTasks tasks + * @return tasks */ private Set populateRemainingReportingTasksContent(final String availability, final Set reportingTasks) { for (ReportingTaskDTO reportingTask : reportingTasks) { @@ -117,11 +117,7 @@ public class ReportingTaskResource extends ApplicationResource { } /** - * Parses the availability and ensure that the specified availability makes - * sense for the given NiFi instance. - * - * @param availability - * @return + * Parses the availability and ensure that the specified availability makes sense for the given NiFi instance. */ private Availability parseAvailability(final String availability) { final Availability avail; @@ -142,12 +138,8 @@ public class ReportingTaskResource extends ApplicationResource { /** * Retrieves all the of reporting tasks in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @return A reportingTasksEntity. */ @GET @@ -182,15 +174,10 @@ public class ReportingTaskResource extends ApplicationResource { /** * Creates a new reporting task. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @param type The type of reporting task to create. * @return A reportingTaskEntity. */ @@ -229,10 +216,8 @@ public class ReportingTaskResource extends ApplicationResource { /** * Creates a new Reporting Task. * - * @param httpServletRequest - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param httpServletRequest request + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @param reportingTaskEntity A reportingTaskEntity. * @return A reportingTaskEntity. */ @@ -320,12 +305,8 @@ public class ReportingTaskResource extends ApplicationResource { /** * Retrieves the specified reporting task. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @param id The id of the reporting task to retrieve * @return A reportingTaskEntity. */ @@ -362,10 +343,8 @@ public class ReportingTaskResource extends ApplicationResource { /** * Returns the descriptor for the specified property. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability availability * @param id The id of the reporting task. * @param propertyName The property * @return a propertyDescriptorEntity @@ -411,28 +390,20 @@ public class ReportingTaskResource extends ApplicationResource { /** * Updates the specified reporting task. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @param id The id of the reporting task to update. * @param name The name of the reporting task * @param annotationData The annotation data for the reporting task - * @param markedForDeletion Array of property names whose value should be - * removed. + * @param markedForDeletion Array of property names whose value should be removed. * @param state The updated scheduled state * @param schedulingStrategy The scheduling strategy for this reporting task * @param schedulingPeriod The scheduling period for this reporting task * @param comments The comments for this reporting task - * @param formParams Additionally, the processor properties and styles are - * specified in the form parameters. Because the property names and styles - * differ from processor to processor they are specified in a map-like - * fashion: + * @param formParams Additionally, the processor properties and styles are specified in the form parameters. Because the property names and styles differ from processor to processor they are + * specified in a map-like fashion: *
            *
              *
            • properties[required.file.path]=/path/to/file
              • @@ -519,10 +490,8 @@ public class ReportingTaskResource extends ApplicationResource { /** * Updates the specified a Reporting Task. * - * @param httpServletRequest - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param httpServletRequest request + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @param id The id of the reporting task to update. * @param reportingTaskEntity A reportingTaskEntity. * @return A reportingTaskEntity. @@ -597,15 +566,10 @@ public class ReportingTaskResource extends ApplicationResource { /** * Removes the specified reporting task. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param availability Whether the reporting task is available on the NCM - * only (ncm) or on the nodes only (node). If this instance is not clustered - * all tasks should use the node availability. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param availability Whether the reporting task is available on the NCM only (ncm) or on the nodes only (node). If this instance is not clustered all tasks should use the node availability. * @param id The id of the reporting task to remove. * @return A entity containing the client id and an updated revision. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SnippetResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SnippetResource.java index 275b133a86..997fe4a934 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SnippetResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SnippetResource.java @@ -77,7 +77,7 @@ public class SnippetResource extends ApplicationResource { /** * Get the processor resource within the specified group. * - * @return + * @return the processor resource within the specified group */ private ProcessorResource getProcessorResource(final String groupId) { ProcessorResource processorResource = resourceContext.getResource(ProcessorResource.class); @@ -88,7 +88,7 @@ public class SnippetResource extends ApplicationResource { /** * Get the connection sub-resource within the specified group. * - * @return + * @return the connection sub-resource within the specified group */ private ConnectionResource getConnectionResource(final String groupId) { ConnectionResource connectionResource = resourceContext.getResource(ConnectionResource.class); @@ -99,7 +99,7 @@ public class SnippetResource extends ApplicationResource { /** * Get the input ports sub-resource within the specified group. * - * @return + * @return the input ports sub-resource within the specified group */ private InputPortResource getInputPortResource(final String groupId) { InputPortResource inputPortResource = resourceContext.getResource(InputPortResource.class); @@ -110,7 +110,7 @@ public class SnippetResource extends ApplicationResource { /** * Get the output ports sub-resource within the specified group. * - * @return + * @return the output ports sub-resource within the specified group */ private OutputPortResource getOutputPortResource(final String groupId) { OutputPortResource outputPortResource = resourceContext.getResource(OutputPortResource.class); @@ -121,7 +121,7 @@ public class SnippetResource extends ApplicationResource { /** * Locates the label sub-resource within the specified group. * - * @return + * @return the label sub-resource within the specified group */ private LabelResource getLabelResource(final String groupId) { LabelResource labelResource = resourceContext.getResource(LabelResource.class); @@ -132,7 +132,7 @@ public class SnippetResource extends ApplicationResource { /** * Locates the funnel sub-resource within the specified group. * - * @return + * @return the funnel sub-resource within the specified group */ private FunnelResource getFunnelResource(final String groupId) { FunnelResource funnelResource = resourceContext.getResource(FunnelResource.class); @@ -143,7 +143,7 @@ public class SnippetResource extends ApplicationResource { /** * Locates the remote process group sub-resource within the specified group. * - * @return + * @return the remote process group sub-resource within the specified group */ private RemoteProcessGroupResource getRemoteProcessGroupResource(final String groupId) { RemoteProcessGroupResource remoteProcessGroupResource = resourceContext.getResource(RemoteProcessGroupResource.class); @@ -154,8 +154,8 @@ public class SnippetResource extends ApplicationResource { /** * Locates the process group sub-resource within the specified group. * - * @param groupId - * @return + * @param groupId group id + * @return the process group sub-resource within the specified group */ private ProcessGroupResource getProcessGroupResource(final String groupId) { ProcessGroupResource processGroupResource = resourceContext.getResource(ProcessGroupResource.class); @@ -191,21 +191,14 @@ public class SnippetResource extends ApplicationResource { /** * Creates a new snippet based on the specified contents. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param parentGroupId The id of the process group the components in this - * snippet belong to. - * @param linked Whether or not this snippet is linked to the underlying - * data flow. If a linked snippet is deleted, the components that comprise - * the snippet are also deleted. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param parentGroupId The id of the process group the components in this snippet belong to. + * @param linked Whether or not this snippet is linked to the underlying data flow. If a linked snippet is deleted, the components that comprise the snippet are also deleted. * @param processorIds The ids of any processors in this snippet. * @param processGroupIds The ids of any process groups in this snippet. - * @param remoteProcessGroupIds The ids of any remote process groups in this - * snippet. + * @param remoteProcessGroupIds The ids of any remote process groups in this snippet. * @param inputPortIds The ids of any input ports in this snippet. * @param outputPortIds The ids of any output ports in this snippet. * @param connectionIds The ids of any connections in this snippet. @@ -266,7 +259,7 @@ public class SnippetResource extends ApplicationResource { /** * Creates a snippet based off the specified configuration. * - * @param httpServletRequest + * @param httpServletRequest request * @param snippetEntity A snippetEntity * @return A snippetEntity */ @@ -354,11 +347,8 @@ public class SnippetResource extends ApplicationResource { /** * Retrieves the specified snippet. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param verbose Whether or not to include the contents of the snippet in - * the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param verbose Whether or not to include the contents of the snippet in the response. * @param id The id of the snippet to retrieve. * @return A snippetEntity. */ @@ -400,20 +390,13 @@ public class SnippetResource extends ApplicationResource { /** * Updates the specified snippet. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param verbose Whether or not to include the contents of the snippet in - * the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param verbose Whether or not to include the contents of the snippet in the response. * @param id The id of the snippet to update. - * @param parentGroupId The id of the process group to move the contents of - * this snippet to. - * @param linked Whether or not this snippet is linked to the underlying - * data flow. If a linked snippet is deleted, the components that comprise - * the snippet are also deleted. + * @param parentGroupId The id of the process group to move the contents of this snippet to. + * @param linked Whether or not this snippet is linked to the underlying data flow. If a linked snippet is deleted, the components that comprise the snippet are also deleted. * @return A snippetEntity. */ @PUT @@ -455,10 +438,9 @@ public class SnippetResource extends ApplicationResource { } /** - * Updates the specified snippet. The contents of the snippet (component - * ids) cannot be updated once the snippet is created. + * Updates the specified snippet. The contents of the snippet (component ids) cannot be updated once the snippet is created. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the snippet. * @param snippetEntity A snippetEntity * @return A snippetEntity @@ -533,12 +515,9 @@ public class SnippetResource extends ApplicationResource { /** * Removes the specified snippet. * - * @param httpServletRequest - * @param version The revision is used to verify the client is working with - * the latest version of the flow. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param version The revision is used to verify the client is working with the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the snippet to remove. * @return A entity containing the client id and an updated revision. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SystemDiagnosticsResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SystemDiagnosticsResource.java index 915c55e8ba..f747c47cbe 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SystemDiagnosticsResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SystemDiagnosticsResource.java @@ -49,9 +49,7 @@ public class SystemDiagnosticsResource extends ApplicationResource { /** * Gets the system diagnostics for this NiFi instance. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A systemDiagnosticsEntity. */ @GET diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TemplateResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TemplateResource.java index 24292e9b6e..00707be7e4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TemplateResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TemplateResource.java @@ -72,8 +72,8 @@ public class TemplateResource extends ApplicationResource { /** * Populates the uri for the specified templates. * - * @param templates - * @return + * @param templates templates + * @return templates */ public Set populateRemainingTemplatesContent(Set templates) { for (TemplateDTO template : templates) { @@ -94,9 +94,7 @@ public class TemplateResource extends ApplicationResource { /** * Retrieves all the of templates in this NiFi. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A templatesEntity. */ @GET @@ -130,10 +128,8 @@ public class TemplateResource extends ApplicationResource { /** * Creates a new template based off of the specified template. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param name The name of the template. * @param description The description of the template. * @param snippetId The id of the snippet this template is based on. @@ -181,10 +177,8 @@ public class TemplateResource extends ApplicationResource { /** * Imports the specified template. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param in The template stream * @return A templateEntity or an errorResponse XML snippet. */ @@ -215,7 +209,8 @@ public class TemplateResource extends ApplicationResource { return Response.status(Response.Status.OK).entity(responseXml).type("application/xml").build(); } catch (Exception e) { logger.warn("An error occurred while importing a template.", e); - String responseXml = String.format("", Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), e.getMessage()); + String responseXml = String.format("", + Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), e.getMessage()); return Response.status(Response.Status.OK).entity(responseXml).type("application/xml").build(); } @@ -245,7 +240,7 @@ public class TemplateResource extends ApplicationResource { /** * Imports the specified template. * - * @param httpServletRequest + * @param httpServletRequest request * @param templateEntity A templateEntity. * @return A templateEntity. */ @@ -295,7 +290,8 @@ public class TemplateResource extends ApplicationResource { return Response.status(Response.Status.OK).entity(responseXml).type("application/xml").build(); } catch (Exception e) { logger.warn("An error occurred while importing a template.", e); - String responseXml = String.format("", Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), e.getMessage()); + String responseXml + = String.format("", Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), e.getMessage()); return Response.status(Response.Status.OK).entity(responseXml).type("application/xml").build(); } } @@ -303,9 +299,7 @@ public class TemplateResource extends ApplicationResource { /** * Retrieves the specified template. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the template to retrieve * @return A templateEntity. */ @@ -344,10 +338,8 @@ public class TemplateResource extends ApplicationResource { /** * Removes the specified template. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the template to remove. * @return A templateEntity. */ diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java index 573c407b56..f7b2009315 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java @@ -54,7 +54,7 @@ public class UserGroupResource extends ApplicationResource { /* * Developer Note: Clustering assumes a centralized security provider. The - * cluster manager will manage user accounts when in clustered mode and + * cluster manager will manage user accounts when in clustered mode and * interface with the authorization provider. However, when nodes perform * Site-to-Site, the authorization details of the remote NiFi will be cached * locally. These details need to be invalidated when certain actions are @@ -68,18 +68,14 @@ public class UserGroupResource extends ApplicationResource { /** * Updates a new user group. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. - * @param userIds A collection of user ids to include in this group. If a - * user already belongs to another group, they will be placed in this group - * instead. Existing users in this group will remain in this group. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. + * @param userIds A collection of user ids to include in this group. If a user already belongs to another group, they will be placed in this group instead. Existing users in this group will remain + * in this group. * @param group The name of the group. - * @param rawAuthorities Array of authorities to assign to the specified - * user. + * @param rawAuthorities Array of authorities to assign to the specified user. * @param status The status of the specified users account. - * @param formParams + * @param formParams form params * @return A userGroupEntity. */ @PUT @@ -132,7 +128,7 @@ public class UserGroupResource extends ApplicationResource { /** * Creates a new user group with the specified users. * - * @param httpServletRequest + * @param httpServletRequest request * @param group The user group. * @param userGroupEntity A userGroupEntity. * @return A userGroupEntity. @@ -177,7 +173,7 @@ public class UserGroupResource extends ApplicationResource { // this user is being modified, replicate to the nodes to invalidate this account // so that it will be re-authorized during the next attempted access - if this wasn't // done the account would remain stale for up to the configured cache duration. this - // is acceptable sometimes but when updating a users authorities or groups via the UI + // is acceptable sometimes but when updating a users authorities or groups via the UI // they shouldn't have to wait for the changes to take effect` if (properties.isClusterManager()) { // change content type to JSON for serializing entity @@ -233,15 +229,12 @@ public class UserGroupResource extends ApplicationResource { } /** - * Deletes the user from the specified group. The user will not be removed, - * just the fact that they were in this group. + * Deletes the user from the specified group. The user will not be removed, just the fact that they were in this group. * - * @param httpServletRequest + * @param httpServletRequest request * @param group The user group. * @param userId The user id to remove. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A userGroupEntity. */ @DELETE @@ -258,7 +251,7 @@ public class UserGroupResource extends ApplicationResource { // this user is being modified, replicate to the nodes to invalidate this account // so that it will be re-authorized during the next attempted access - if this wasn't // done the account would remain stale for up to the configured cache duration. this - // is acceptable sometimes but when removing a user via the UI they shouldn't have to + // is acceptable sometimes but when removing a user via the UI they shouldn't have to // wait for the changes to take effect if (properties.isClusterManager()) { // identify yourself as the NCM attempting to invalidate the user @@ -302,14 +295,11 @@ public class UserGroupResource extends ApplicationResource { } /** - * Deletes the user group. The users will not be removed, just the fact that - * they were grouped. + * Deletes the user group. The users will not be removed, just the fact that they were grouped. * - * @param httpServletRequest + * @param httpServletRequest request * @param group The user group. - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A userGroupEntity. */ @DELETE @@ -325,7 +315,7 @@ public class UserGroupResource extends ApplicationResource { // this user is being modified, replicate to the nodes to invalidate this account // so that it will be re-authorized during the next attempted access - if this wasn't // done the account would remain stale for up to the configured cache duration. this - // is acceptable sometimes but when removing a user via the UI they shouldn't have to + // is acceptable sometimes but when removing a user via the UI they shouldn't have to // wait for the changes to take effect if (properties.isClusterManager()) { // identify yourself as the NCM attempting to invalidate the user diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java index 09307c810e..6dbb1a7773 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java @@ -66,7 +66,7 @@ public class UserResource extends ApplicationResource { /* * Developer Note: Clustering assumes a centralized security provider. The - * cluster manager will manage user accounts when in clustered mode and + * cluster manager will manage user accounts when in clustered mode and * interface with the authorization provider. However, when nodes perform * Site-to-Site, the authorization details of the remote NiFi will be cached * locally. These details need to be invalidated when certain actions are @@ -80,9 +80,7 @@ public class UserResource extends ApplicationResource { /** * Gets all users that are registered within this Controller. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param grouped Whether to return the users in their groups. * @return A usersEntity. */ @@ -114,9 +112,7 @@ public class UserResource extends ApplicationResource { /** * Gets the details for the specified user. * - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The user id. * @return A userEntity. */ @@ -237,15 +233,12 @@ public class UserResource extends ApplicationResource { /** * Updates the specified user. * - * @param httpServletRequest - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param httpServletRequest request + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @param id The id of the user to update. - * @param rawAuthorities Array of authorities to assign to the specified - * user. + * @param rawAuthorities Array of authorities to assign to the specified user. * @param status The status of the specified users account. - * @param formParams + * @param formParams form params * @return A userEntity */ @PUT @@ -296,7 +289,7 @@ public class UserResource extends ApplicationResource { /** * Updates the specified user. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The id of the user to update. * @param userEntity A userEntity * @return A userEntity @@ -334,7 +327,7 @@ public class UserResource extends ApplicationResource { // this user is being modified, replicate to the nodes to invalidate this account // so that it will be re-authorized during the next attempted access - if this wasn't // done the account would remain stale for up to the configured cache duration. this - // is acceptable sometimes but when updating a users authorities or groups via the UI + // is acceptable sometimes but when updating a users authorities or groups via the UI // they shouldn't have to wait for the changes to take effect` if (properties.isClusterManager()) { // change content type to JSON for serializing entity @@ -391,11 +384,9 @@ public class UserResource extends ApplicationResource { /** * Deletes the specified user. * - * @param httpServletRequest + * @param httpServletRequest request * @param id The user id - * @param clientId Optional client id. If the client id is not specified, a - * new one will be generated. This value (whether specified or generated) is - * included in the response. + * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. * @return A userEntity. */ @DELETE @@ -411,7 +402,7 @@ public class UserResource extends ApplicationResource { // this user is being modified, replicate to the nodes to invalidate this account // so that it will be re-authorized during the next attempted access - if this wasn't // done the account would remain stale for up to the configured cache duration. this - // is acceptable sometimes but when removing a user via the UI they shouldn't have to + // is acceptable sometimes but when removing a user via the UI they shouldn't have to // wait for the changes to take effect if (properties.isClusterManager()) { // identify yourself as the NCM attempting to invalidate the user diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java index d631d8214c..19b8e19809 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java @@ -20,7 +20,6 @@ import javax.ws.rs.core.Response; import javax.ws.rs.ext.ExceptionMapper; import javax.ws.rs.ext.Provider; import org.apache.nifi.admin.service.AdministrationException; -import org.apache.nifi.util.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java index 72a9c7bb48..bd35a985b6 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java @@ -25,8 +25,7 @@ import org.slf4j.LoggerFactory; import org.springframework.security.authentication.AuthenticationCredentialsNotFoundException; /** - * Maps exceptions that occur because no valid credentials were found into the - * corresponding response. + * Maps exceptions that occur because no valid credentials were found into the corresponding response. */ @Provider public class AuthenticationCredentialsNotFoundExceptionMapper implements ExceptionMapper { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java index a3c9884edf..2a67cf8306 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java @@ -20,7 +20,6 @@ import javax.ws.rs.core.Response; import javax.ws.rs.ext.ExceptionMapper; import javax.ws.rs.ext.Provider; import org.apache.nifi.cluster.manager.exception.ClusterException; -import org.apache.nifi.util.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java index ce2059ca1f..ceb73600bd 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java @@ -26,8 +26,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Maps the exceptional case when the cluster is unable to service a request - * because no nodes returned a response. + * Maps the exceptional case when the cluster is unable to service a request because no nodes returned a response. */ @Provider public class NoResponseFromNodesExceptionMapper implements ExceptionMapper { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java index 72772508d9..bdf1f00f00 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java @@ -19,7 +19,6 @@ package org.apache.nifi.web.api.config; import javax.ws.rs.core.Response; import javax.ws.rs.ext.ExceptionMapper; import javax.ws.rs.ext.Provider; -import org.apache.nifi.util.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java index bf216c3ee0..999a4a47be 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java @@ -129,9 +129,6 @@ import org.apache.nifi.controller.service.ControllerServiceReference; import org.apache.nifi.reporting.ReportingTask; import org.apache.nifi.web.FlowModification; -/** - * - */ public final class DtoFactory { @SuppressWarnings("rawtypes") @@ -149,8 +146,8 @@ public final class DtoFactory { /** * Creates an ActionDTO for the specified Action. * - * @param action - * @return + * @param action action + * @return dto */ public ActionDTO createActionDto(final Action action) { final ActionDTO actionDto = new ActionDTO(); @@ -171,8 +168,8 @@ public final class DtoFactory { /** * Creates an ActionDetailsDTO for the specified ActionDetails. * - * @param actionDetails - * @return + * @param actionDetails details + * @return dto */ private ActionDetailsDTO createActionDetailsDto(final ActionDetails actionDetails) { if (actionDetails == null) { @@ -214,8 +211,8 @@ public final class DtoFactory { /** * Creates a ComponentDetailsDTO for the specified ComponentDetails. * - * @param componentDetails - * @return + * @param componentDetails details + * @return dto */ private ComponentDetailsDTO createComponentDetailsDto(final ComponentDetails componentDetails) { if (componentDetails == null) { @@ -238,8 +235,8 @@ public final class DtoFactory { /** * Creates a HistoryDTO from the specified History. * - * @param history - * @return + * @param history history + * @return dto */ public HistoryDTO createHistoryDto(final History history) { final HistoryDTO historyDto = new HistoryDTO(); @@ -260,8 +257,8 @@ public final class DtoFactory { /** * Creates CounterDTOs for each Counter specified. * - * @param counterDtos - * @return + * @param counterDtos dtos + * @return dto */ public CountersDTO createCountersDto(final Collection counterDtos) { final CountersDTO dto = new CountersDTO(); @@ -273,8 +270,8 @@ public final class DtoFactory { /** * Creates a CounterDTO from the specified Counter. * - * @param counter - * @return + * @param counter counter + * @return dto */ public CounterDTO createCounterDto(final Counter counter) { final CounterDTO dto = new CounterDTO(); @@ -289,8 +286,8 @@ public final class DtoFactory { /** * Creates a PositionDTO from the specified position * - * @param position - * @return + * @param position position + * @return dto */ public PositionDTO createPositionDto(final Position position) { return new PositionDTO(position.getX(), position.getY()); @@ -299,8 +296,8 @@ public final class DtoFactory { /** * Creates a ConnectionDTO from the specified Connection. * - * @param connection - * @return + * @param connection connection + * @return dto */ public ConnectionDTO createConnectionDto(final Connection connection) { if (connection == null) { @@ -358,8 +355,8 @@ public final class DtoFactory { /** * Creates a ConnectableDTO from the specified Connectable. * - * @param connectable - * @return + * @param connectable connectable + * @return dto */ public ConnectableDTO createConnectableDto(final Connectable connectable) { if (connectable == null) { @@ -391,8 +388,8 @@ public final class DtoFactory { /** * Creates a LabelDTO from the specified Label. * - * @param label - * @return + * @param label label + * @return dto */ public LabelDTO createLabelDto(final Label label) { if (label == null) { @@ -414,8 +411,8 @@ public final class DtoFactory { /** * Creates a FunnelDTO from the specified Funnel. * - * @param funnel - * @return + * @param funnel funnel + * @return dto */ public FunnelDTO createFunnelDto(final Funnel funnel) { if (funnel == null) { @@ -433,8 +430,8 @@ public final class DtoFactory { /** * Creates a SnippetDTO from the specified Snippet. * - * @param snippet - * @return + * @param snippet snippet + * @return dto */ public SnippetDTO createSnippetDto(final Snippet snippet) { final SnippetDTO dto = new SnippetDTO(); @@ -458,8 +455,8 @@ public final class DtoFactory { /** * Creates a TemplateDTO from the specified template. * - * @param template - * @return + * @param template template + * @return dto */ public TemplateDTO createTemplateDTO(final Template template) { if (template == null) { @@ -728,8 +725,8 @@ public final class DtoFactory { /** * Creates a PortStatusDTO for the specified PortStatus. * - * @param portStatus - * @return + * @param portStatus status + * @return dto */ public PortStatusDTO createPortStatusDto(final PortStatus portStatus) { final PortStatusDTO dto = new PortStatusDTO(); @@ -754,8 +751,8 @@ public final class DtoFactory { /** * Copies the specified snippet. * - * @param originalSnippet - * @return + * @param originalSnippet snippet + * @return dto */ public FlowSnippetDTO copySnippetContents(FlowSnippetDTO originalSnippet) { final FlowSnippetDTO copySnippet = new FlowSnippetDTO(); @@ -807,8 +804,8 @@ public final class DtoFactory { /** * Creates a PortDTO from the specified Port. * - * @param port - * @return + * @param port port + * @return dto */ public PortDTO createPortDto(final Port port) { if (port == null) { @@ -1109,8 +1106,8 @@ public final class DtoFactory { /** * Creates a RemoteProcessGroupDTO from the specified RemoteProcessGroup. * - * @param group - * @return + * @param group group + * @return dto */ public RemoteProcessGroupDTO createRemoteProcessGroupDto(final RemoteProcessGroup group) { if (group == null) { @@ -1191,8 +1188,8 @@ public final class DtoFactory { /** * Creates a ProcessGroupDTO from the specified parent ProcessGroup. * - * @param parentGroup - * @return + * @param parentGroup group + * @return dto */ private ProcessGroupDTO createParentProcessGroupDto(final ProcessGroup parentGroup) { if (parentGroup == null) { @@ -1213,8 +1210,8 @@ public final class DtoFactory { /** * Creates a ProcessGroupDTO from the specified ProcessGroup. * - * @param group - * @return + * @param group group + * @return dto */ public ProcessGroupDTO createProcessGroupDto(final ProcessGroup group) { return createProcessGroupDto(group, false); @@ -1223,9 +1220,9 @@ public final class DtoFactory { /** * Creates a ProcessGroupDTO from the specified ProcessGroup. * - * @param group - * @param recurse - * @return + * @param group group + * @param recurse recurse + * @return dto */ public ProcessGroupDTO createProcessGroupDto(final ProcessGroup group, final boolean recurse) { final ProcessGroupDTO dto = createConciseProcessGroupDto(group); @@ -1236,9 +1233,8 @@ public final class DtoFactory { /** * Creates a ProcessGroupDTO from the specified ProcessGroup. * - * @param group - * @param recurse - * @return + * @param group group + * @return dto */ private ProcessGroupDTO createConciseProcessGroupDto(final ProcessGroup group) { if (group == null) { @@ -1273,9 +1269,9 @@ public final class DtoFactory { /** * Creates a ProcessGroupContentDTO from the specified ProcessGroup. * - * @param group - * @param recurse - * @return + * @param group group + * @param recurse recurse + * @return dto */ private FlowSnippetDTO createProcessGroupContentsDto(final ProcessGroup group, final boolean recurse) { if (group == null) { @@ -1325,9 +1321,6 @@ public final class DtoFactory { /** * Gets the capability description from the specified class. - * - * @param cls - * @return */ @SuppressWarnings("deprecation") private String getCapabilityDescription(final Class cls) { @@ -1344,9 +1337,6 @@ public final class DtoFactory { /** * Gets the tags from the specified class. - * - * @param cls - * @return */ @SuppressWarnings("deprecation") private Set getTags(final Class cls) { @@ -1371,8 +1361,8 @@ public final class DtoFactory { /** * Gets the DocumentedTypeDTOs from the specified classes. * - * @param classes - * @return + * @param classes classes + * @return dtos */ @SuppressWarnings("rawtypes") public Set fromDocumentedTypes(final Set classes) { @@ -1394,8 +1384,8 @@ public final class DtoFactory { /** * Creates a ProcessorDTO from the specified ProcessorNode. * - * @param node - * @return + * @param node node + * @return dto */ public ProcessorDTO createProcessorDto(final ProcessorNode node) { if (node == null) { @@ -1454,8 +1444,8 @@ public final class DtoFactory { /** * Creates a BulletinBoardDTO for the specified bulletins. * - * @param bulletins - * @return + * @param bulletins bulletins + * @return dto */ public BulletinBoardDTO createBulletinBoardDto(final List bulletins) { // sort the bulletins @@ -1494,8 +1484,8 @@ public final class DtoFactory { /** * Creates a BulletinDTO for the specified Bulletin. * - * @param bulletin - * @return + * @param bulletin bulletin + * @return dto */ public BulletinDTO createBulletinDto(final Bulletin bulletin) { final BulletinDTO dto = new BulletinDTO(); @@ -1514,8 +1504,8 @@ public final class DtoFactory { /** * Creates a ProvenanceEventNodeDTO for the specified ProvenanceEventLineageNode. * - * @param node - * @return + * @param node node + * @return dto */ public ProvenanceNodeDTO createProvenanceEventNodeDTO(final ProvenanceEventLineageNode node) { final ProvenanceNodeDTO dto = new ProvenanceNodeDTO(); @@ -1534,8 +1524,8 @@ public final class DtoFactory { /** * Creates a FlowFileNodeDTO for the specified LineageNode. * - * @param node - * @return + * @param node node + * @return dto */ public ProvenanceNodeDTO createFlowFileNodeDTO(final LineageNode node) { final ProvenanceNodeDTO dto = new ProvenanceNodeDTO(); @@ -1551,8 +1541,8 @@ public final class DtoFactory { /** * Creates a ProvenanceLinkDTO for the specified LineageEdge. * - * @param edge - * @return + * @param edge edge + * @return dto */ public ProvenanceLinkDTO createProvenanceLinkDTO(final LineageEdge edge) { final LineageNode source = edge.getSource(); @@ -1570,8 +1560,8 @@ public final class DtoFactory { /** * Creates a LineageDTO for the specified Lineage. * - * @param computeLineageSubmission - * @return + * @param computeLineageSubmission submission + * @return dto */ public LineageDTO createLineageDto(final ComputeLineageSubmission computeLineageSubmission) { // build the lineage dto @@ -1651,8 +1641,8 @@ public final class DtoFactory { /** * Creates a SystemDiagnosticsDTO for the specified SystemDiagnostics. * - * @param sysDiagnostics - * @return + * @param sysDiagnostics diags + * @return dto */ public SystemDiagnosticsDTO createSystemDiagnosticsDto(final SystemDiagnostics sysDiagnostics) { @@ -1705,9 +1695,9 @@ public final class DtoFactory { /** * Creates a StorageUsageDTO from the specified StorageUsage. * - * @param identifier - * @param storageUsage - * @return + * @param identifier id + * @param storageUsage usage + * @return dto */ public SystemDiagnosticsDTO.StorageUsageDTO createStorageUsageDTO(final String identifier, final StorageUsage storageUsage) { final SystemDiagnosticsDTO.StorageUsageDTO dto = new SystemDiagnosticsDTO.StorageUsageDTO(); @@ -1725,9 +1715,9 @@ public final class DtoFactory { /** * Creates a GarbageCollectionDTO from the specified GarbageCollection. * - * @param name - * @param garbageCollection - * @return + * @param name name + * @param garbageCollection gc + * @return dto */ public SystemDiagnosticsDTO.GarbageCollectionDTO createGarbageCollectionDTO(final String name, final GarbageCollection garbageCollection) { final SystemDiagnosticsDTO.GarbageCollectionDTO dto = new SystemDiagnosticsDTO.GarbageCollectionDTO(); @@ -1740,8 +1730,8 @@ public final class DtoFactory { /** * Creates a ProcessorConfigDTO from the specified ProcessorNode. * - * @param procNode - * @return + * @param procNode node + * @return dto */ public ProcessorConfigDTO createProcessorConfigDto(final ProcessorNode procNode) { if (procNode == null) { @@ -1818,8 +1808,8 @@ public final class DtoFactory { /** * Creates a PropertyDesriptorDTO from the specified PropertyDesriptor. * - * @param propertyDescriptor - * @return + * @param propertyDescriptor descriptor + * @return dto */ public PropertyDescriptorDTO createPropertyDescriptorDto(final PropertyDescriptor propertyDescriptor) { if (propertyDescriptor == null) { @@ -1873,9 +1863,7 @@ public final class DtoFactory { return dto; } - // // Copy methods - // public LabelDTO copy(final LabelDTO original) { final LabelDTO copy = new LabelDTO(); copy.setId(original.getId()); @@ -2164,11 +2152,11 @@ public final class DtoFactory { /** * - * @param original + * @param original orig * @param deep if true, all Connections, ProcessGroups, Ports, Processors, etc. will be copied. If false, the copy will have links to the same objects referenced by * original. * - * @return + * @return dto */ private FlowSnippetDTO copy(final FlowSnippetDTO original, final boolean deep) { final FlowSnippetDTO copy = new FlowSnippetDTO(); @@ -2294,8 +2282,8 @@ public final class DtoFactory { /** * Factory method for creating a new RevisionDTO based on this controller. * - * @param lastMod - * @return + * @param lastMod mod + * @return dto */ public RevisionDTO createRevisionDTO(FlowModification lastMod) { final Revision revision = lastMod.getRevision(); @@ -2312,8 +2300,8 @@ public final class DtoFactory { /** * Factory method for creating a new user transfer object. * - * @param user - * @return + * @param user user + * @return dto */ public UserDTO createUserDTO(NiFiUser user) { // convert the users authorities diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java index b75d13d9a9..0392ca49f9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java @@ -16,41 +16,26 @@ */ /** *

              - * The NiFi REST API allows clients to obtain and update configuration and - * status information pertaining to an instance of NiFi. The links below detail - * each resource. Follow the link to get more information about the resource - * including the supported HTTP methods and the expected parameters.

              + * The NiFi REST API allows clients to obtain and update configuration and status information pertaining to an instance of NiFi. The links below detail each resource. Follow the link to get more + * information about the resource including the supported HTTP methods and the expected parameters.

              * *

              - * Additionally, the documentation for each resource will describe what type of - * data should be returned from a successful invocation. However, if the request - * is not successful one of the follow status codes should be returned:

              + * Additionally, the documentation for each resource will describe what type of data should be returned from a successful invocation. However, if the request is not successful one of the follow status + * codes should be returned:

              * *
                - *
              • 400 (Bad Request) - A 400 status code will be returned when NiFi is - * unable to complete the request because it was invalid. The request should not - * be retried without modification.
                • - *
              • 401 (Unathorized) - A 401 status code indicates that the user is not - * known to this NiFi instance. The user may submit an account request.
                • - *
              • 403 (Forbidden) - A 403 status code indicates that the user is known to - * this NiFi instance and they do not have authority to perform the requested - * action.
                • - *
              • 404 (Not Found) - A 404 status code will be returned when the desired - * resource does not exist.
                • - *
              • 409 (Conflict) - NiFi employs an optimistic locking strategy where the - * client must include a revision in their request when performing an update. If - * the specified revision does not match the current base revision a 409 status - * code is returned. Additionally, a 409 is used when the state of the system - * does not allow for the request at that time. This same request may be - * successful later if the system is in a different state (e.g. cannot delete a - * processor because it is currently running).
                • - *
              • 500 (Internal Server Error) - A 500 status code indicates that an - * unexpected error has occurred.
                • + *
              • 400 (Bad Request) - A 400 status code will be returned when NiFi is unable to complete the request because it was invalid. The request should not be retried without modification.
                • + *
              • 401 (Unathorized) - A 401 status code indicates that the user is not known to this NiFi instance. The user may submit an account request.
                • + *
              • 403 (Forbidden) - A 403 status code indicates that the user is known to this NiFi instance and they do not have authority to perform the requested action.
                • + *
              • 404 (Not Found) - A 404 status code will be returned when the desired resource does not exist.
                • + *
              • 409 (Conflict) - NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. If the specified revision does not match the + * current base revision a 409 status code is returned. Additionally, a 409 is used when the state of the system does not allow for the request at that time. This same request may be successful later + * if the system is in a different state (e.g. cannot delete a processor because it is currently running).
                • + *
              • 500 (Internal Server Error) - A 500 status code indicates that an unexpected error has occurred.
                • *
              * *

              - * Most unsuccessful requests will include a description of the problem in the - * entity body of the response.

              + * Most unsuccessful requests will include a description of the problem in the entity body of the response.

              * *

              * The context path for the REST API is /nifi-api

              diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java index 98bfbebb68..c34ec59721 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java @@ -20,8 +20,7 @@ import java.util.regex.Pattern; import java.util.regex.PatternSyntaxException; /** - * Parameter class that auto [ap|pre]pends '.*' to the specified pattern to make - * user input more user friendly. + * Parameter class that auto [ap|pre]pends '.*' to the specified pattern to make user input more user friendly. */ public class BulletinBoardPatternParameter { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java index c0a39c290c..85a0a293ae 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java @@ -20,8 +20,7 @@ import java.util.UUID; import org.apache.commons.lang3.StringUtils; /** - * Class for parsing handling client ids. If the client id is not specified, one - * will be generated. + * Class for parsing handling client ids. If the client id is not specified, one will be generated. */ public class ClientIdParameter { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java index 726f031f14..3480cd0222 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java @@ -22,8 +22,7 @@ import java.util.Date; import java.util.Locale; /** - * Class for parsing integer parameters and providing a user friendly error - * message. + * Class for parsing integer parameters and providing a user friendly error message. */ public class DateTimeParameter { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java index eba046b665..8ea7e38d58 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java @@ -17,8 +17,7 @@ package org.apache.nifi.web.api.request; /** - * Class for parsing double parameters and providing a user friendly error - * message. + * Class for parsing double parameters and providing a user friendly error message. */ public class DoubleParameter { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java index cfbdbd88a7..76e8087696 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java @@ -17,8 +17,7 @@ package org.apache.nifi.web.api.request; /** - * Class for parsing integer parameters and providing a user friendly error - * message. + * Class for parsing integer parameters and providing a user friendly error message. */ public class IntegerParameter { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java index eef28fe207..ba2def98ef 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java @@ -17,8 +17,7 @@ package org.apache.nifi.web.api.request; /** - * Class for parsing long parameters and providing a user friendly error - * message. + * Class for parsing long parameters and providing a user friendly error message. */ public class LongParameter { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java index de54dd24fb..a853acab99 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java @@ -32,12 +32,8 @@ import org.springframework.context.ApplicationContext; import org.springframework.web.context.support.WebApplicationContextUtils; /** - * Application context listener for starting the application. If the application - * is configured for a standalone environment or the application is a node in a - * clustered environment then a flow controller is created and managed. - * Otherwise, we assume the application is running as the cluster manager in a - * clustered environment. In this case, the cluster manager is created and - * managed. + * Application context listener for starting the application. If the application is configured for a standalone environment or the application is a node in a clustered environment then a flow + * controller is created and managed. Otherwise, we assume the application is running as the cluster manager in a clustered environment. In this case, the cluster manager is created and managed. * */ public class ApplicationStartupContextListener implements ServletContextListener { diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java index 0f384e3243..b614f0ac2f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java @@ -118,9 +118,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.security.access.AccessDeniedException; -/** - * - */ public class ControllerFacade { private static final Logger logger = LoggerFactory.getLogger(ControllerFacade.class); @@ -144,8 +141,8 @@ public class ControllerFacade { /** * Returns the group id that contains the specified processor. * - * @param processorId - * @return + * @param processorId processor id + * @return group id */ public String findProcessGroupIdForProcessor(String processorId) { final ProcessGroup rootGroup = flowController.getGroup(flowController.getRootGroupId()); @@ -160,7 +157,7 @@ public class ControllerFacade { /** * Sets the name of this controller. * - * @param name + * @param name name */ public void setName(String name) { flowController.setName(name); @@ -169,7 +166,7 @@ public class ControllerFacade { /** * Sets the comments of this controller. * - * @param comments + * @param comments comments */ public void setComments(String comments) { flowController.setComments(comments); @@ -178,7 +175,7 @@ public class ControllerFacade { /** * Sets the max timer driven thread count of this controller. * - * @param maxTimerDrivenThreadCount + * @param maxTimerDrivenThreadCount count */ public void setMaxTimerDrivenThreadCount(int maxTimerDrivenThreadCount) { flowController.setMaxTimerDrivenThreadCount(maxTimerDrivenThreadCount); @@ -187,7 +184,7 @@ public class ControllerFacade { /** * Sets the max event driven thread count of this controller. * - * @param maxEventDrivenThreadCount + * @param maxEventDrivenThreadCount count */ public void setMaxEventDrivenThreadCount(int maxEventDrivenThreadCount) { flowController.setMaxEventDrivenThreadCount(maxEventDrivenThreadCount); @@ -196,7 +193,7 @@ public class ControllerFacade { /** * Gets the root group id. * - * @return + * @return group id */ public String getRootGroupId() { return flowController.getRootGroupId(); @@ -205,7 +202,7 @@ public class ControllerFacade { /** * Gets the input ports on the root group. * - * @return + * @return input ports */ public Set getInputPorts() { final Set inputPorts = new HashSet<>(); @@ -221,7 +218,7 @@ public class ControllerFacade { /** * Gets the output ports on the root group. * - * @return + * @return output ports */ public Set getOutputPorts() { final Set outputPorts = new HashSet<>(); @@ -237,9 +234,9 @@ public class ControllerFacade { /** * Returns the status history for the specified processor. * - * @param groupId - * @param processorId - * @return + * @param groupId group id + * @param processorId processor id + * @return status history */ public StatusHistoryDTO getProcessorStatusHistory(final String groupId, final String processorId) { return flowController.getProcessorStatusHistory(processorId); @@ -248,9 +245,9 @@ public class ControllerFacade { /** * Returns the status history for the specified connection. * - * @param groupId - * @param connectionId - * @return + * @param groupId group id + * @param connectionId connection id + * @return status history */ public StatusHistoryDTO getConnectionStatusHistory(final String groupId, final String connectionId) { return flowController.getConnectionStatusHistory(connectionId); @@ -259,8 +256,8 @@ public class ControllerFacade { /** * Returns the status history for the specified process group. * - * @param groupId - * @return + * @param groupId group id + * @return status history */ public StatusHistoryDTO getProcessGroupStatusHistory(final String groupId) { return flowController.getProcessGroupStatusHistory(groupId); @@ -269,9 +266,9 @@ public class ControllerFacade { /** * Returns the status history for the specified remote process group. * - * @param groupId - * @param remoteProcessGroupId - * @return + * @param groupId group id + * @param remoteProcessGroupId remote process group id + * @return status history */ public StatusHistoryDTO getRemoteProcessGroupStatusHistory(final String groupId, final String remoteProcessGroupId) { return flowController.getRemoteProcessGroupStatusHistory(remoteProcessGroupId); @@ -280,12 +277,15 @@ public class ControllerFacade { /** * Get the node id of this controller. * - * @return + * @return node identifier */ public NodeIdentifier getNodeId() { return flowController.getNodeId(); } + /** + * @return true if is clustered + */ public boolean isClustered() { return flowController.isClustered(); } @@ -293,7 +293,7 @@ public class ControllerFacade { /** * Gets the name of this controller. * - * @return + * @return name */ public String getName() { return flowController.getName(); @@ -306,7 +306,7 @@ public class ControllerFacade { /** * Gets the comments of this controller. * - * @return + * @return comments */ public String getComments() { return flowController.getComments(); @@ -315,7 +315,7 @@ public class ControllerFacade { /** * Gets the max timer driven thread count of this controller. * - * @return + * @return count */ public int getMaxTimerDrivenThreadCount() { return flowController.getMaxTimerDrivenThreadCount(); @@ -324,7 +324,7 @@ public class ControllerFacade { /** * Gets the max event driven thread count of this controller. * - * @return + * @return count */ public int getMaxEventDrivenThreadCount() { return flowController.getMaxEventDrivenThreadCount(); @@ -333,7 +333,7 @@ public class ControllerFacade { /** * Gets the FlowFileProcessor types that this controller supports. * - * @return + * @return types */ public Set getFlowFileProcessorTypes() { return dtoFactory.fromDocumentedTypes(ExtensionManager.getExtensions(Processor.class)); @@ -342,7 +342,7 @@ public class ControllerFacade { /** * Gets the FlowFileComparator types that this controller supports. * - * @return + * @return the FlowFileComparator types that this controller supports */ public Set getFlowFileComparatorTypes() { return dtoFactory.fromDocumentedTypes(ExtensionManager.getExtensions(FlowFilePrioritizer.class)); @@ -351,9 +351,9 @@ public class ControllerFacade { /** * Returns whether the specified type implements the specified serviceType. * - * @param baseType - * @param type - * @return + * @param serviceType type + * @param type type + * @return whether the specified type implements the specified serviceType */ private boolean implementsServiceType(final String serviceType, final Class type) { final List> interfaces = ClassUtils.getAllInterfaces(type); @@ -369,8 +369,8 @@ public class ControllerFacade { /** * Gets the ControllerService types that this controller supports. * - * @param serviceType - * @return + * @param serviceType type + * @return the ControllerService types that this controller supports */ public Set getControllerServiceTypes(final String serviceType) { final Set serviceImplementations = ExtensionManager.getExtensions(ControllerService.class); @@ -396,7 +396,7 @@ public class ControllerFacade { /** * Gets the ReportingTask types that this controller supports. * - * @return + * @return the ReportingTask types that this controller supports */ public Set getReportingTaskTypes() { return dtoFactory.fromDocumentedTypes(ExtensionManager.getExtensions(ReportingTask.class)); @@ -405,7 +405,7 @@ public class ControllerFacade { /** * Gets the counters for this controller. * - * @return + * @return the counters for this controller */ public List getCounters() { return flowController.getCounters(); @@ -414,8 +414,8 @@ public class ControllerFacade { /** * Resets the counter with the specified id. * - * @param id - * @return + * @param id id + * @return the counter with the specified id */ public Counter resetCounter(final String id) { final Counter counter = flowController.resetCounter(id); @@ -430,7 +430,7 @@ public class ControllerFacade { /** * Gets the status of this controller. * - * @return + * @return the status of this controller */ public ControllerStatusDTO getControllerStatus() { final ProcessGroup rootGroup = flowController.getGroup(flowController.getRootGroupId()); @@ -462,8 +462,8 @@ public class ControllerFacade { /** * Gets the status for the specified process group. * - * @param groupId - * @return + * @param groupId group id + * @return the status for the specified process group */ public ProcessGroupStatusDTO getProcessGroupStatus(final String groupId) { final ProcessGroupStatus processGroupStatus = flowController.getGroupStatus(groupId); @@ -476,7 +476,7 @@ public class ControllerFacade { /** * Gets the BulletinRepository. * - * @return + * @return the BulletinRepository */ public BulletinRepository getBulletinRepository() { return flowController.getBulletinRepository(); @@ -485,7 +485,7 @@ public class ControllerFacade { /** * Saves the state of the flow controller. * - * @throws NiFiCoreException + * @throws NiFiCoreException ex */ public void save() throws NiFiCoreException { // save the flow controller @@ -494,40 +494,36 @@ public class ControllerFacade { } /** - * Returns the socket port that the Cluster Manager is listening on for - * Site-to-Site communications + * Returns the socket port that the Cluster Manager is listening on for Site-to-Site communications * - * @return + * @return the socket port that the Cluster Manager is listening on for Site-to-Site communications */ public Integer getClusterManagerRemoteSiteListeningPort() { return flowController.getClusterManagerRemoteSiteListeningPort(); } /** - * Indicates whether or not Site-to-Site communications with the Cluster - * Manager are secure + * Indicates whether or not Site-to-Site communications with the Cluster Manager are secure * - * @return + * @return whether or not Site-to-Site communications with the Cluster Manager are secure */ public Boolean isClusterManagerRemoteSiteCommsSecure() { return flowController.isClusterManagerRemoteSiteCommsSecure(); } /** - * Returns the socket port that the local instance is listening on for - * Site-to-Site communications + * Returns the socket port that the local instance is listening on for Site-to-Site communications * - * @return + * @return the socket port that the local instance is listening on for Site-to-Site communications */ public Integer getRemoteSiteListeningPort() { return flowController.getRemoteSiteListeningPort(); } /** - * Indicates whether or not Site-to-Site communications with the local - * instance are secure + * Indicates whether or not Site-to-Site communications with the local instance are secure * - * @return + * @return whether or not Site-to-Site communications with the local instance are secure */ public Boolean isRemoteSiteCommsSecure() { return flowController.isRemoteSiteCommsSecure(); @@ -536,7 +532,7 @@ public class ControllerFacade { /** * Returns a SystemDiagnostics that describes the current state of the node * - * @return + * @return a SystemDiagnostics that describes the current state of the node */ public SystemDiagnostics getSystemDiagnostics() { return flowController.getSystemDiagnostics(); @@ -545,7 +541,7 @@ public class ControllerFacade { /** * Gets the available options for searching provenance. * - * @return + * @return the available options for searching provenance */ public ProvenanceOptionsDTO getProvenanceSearchOptions() { final ProvenanceEventRepository provenanceRepository = flowController.getProvenanceRepository(); @@ -578,8 +574,8 @@ public class ControllerFacade { /** * Submits a provenance query. * - * @param provenanceDto - * @return + * @param provenanceDto dto + * @return provenance info */ public ProvenanceDTO submitProvenance(ProvenanceDTO provenanceDto) { final ProvenanceRequestDTO requestDto = provenanceDto.getRequest(); @@ -632,8 +628,8 @@ public class ControllerFacade { /** * Retrieves the results of a provenance query. * - * @param provenanceId - * @return + * @param provenanceId id + * @return the results of a provenance query */ public ProvenanceDTO getProvenanceQuery(String provenanceId) { try { @@ -717,8 +713,8 @@ public class ControllerFacade { /** * Submits the specified lineage request. * - * @param lineageDto - * @return + * @param lineageDto dto + * @return updated lineage */ public LineageDTO submitLineage(LineageDTO lineageDto) { final LineageRequestDTO requestDto = lineageDto.getRequest(); @@ -746,8 +742,8 @@ public class ControllerFacade { /** * Gets the lineage with the specified id. * - * @param lineageId - * @return + * @param lineageId id + * @return the lineage with the specified id */ public LineageDTO getLineage(final String lineageId) { // get the query to the provenance repository @@ -765,7 +761,7 @@ public class ControllerFacade { /** * Deletes the query with the specified id. * - * @param provenanceId + * @param provenanceId id */ public void deleteProvenanceQuery(final String provenanceId) { // get the query to the provenance repository @@ -779,7 +775,7 @@ public class ControllerFacade { /** * Deletes the lineage with the specified id. * - * @param lineageId + * @param lineageId id */ public void deleteLineage(final String lineageId) { // get the query to the provenance repository @@ -793,10 +789,10 @@ public class ControllerFacade { /** * Gets the content for the specified claim. * - * @param eventId - * @param uri - * @param contentDirection - * @return + * @param eventId event id + * @param uri uri + * @param contentDirection direction + * @return the content for the specified claim */ public DownloadableContent getContent(final Long eventId, final String uri, final ContentDirection contentDirection) { try { @@ -856,8 +852,8 @@ public class ControllerFacade { /** * Submits a replay request for the specified event id. * - * @param eventId - * @return + * @param eventId event id + * @return provenance event */ public ProvenanceEventDTO submitReplay(final Long eventId) { try { @@ -885,8 +881,8 @@ public class ControllerFacade { /** * Get the provenance event with the specified event id. * - * @param eventId - * @return + * @param eventId event id + * @return the provenance event with the specified event id */ public ProvenanceEventDTO getProvenanceEvent(final Long eventId) { try { @@ -905,8 +901,8 @@ public class ControllerFacade { /** * Creates a ProvenanceEventDTO for the specified ProvenanceEventRecord. * - * @param event - * @return + * @param event event + * @return event */ private ProvenanceEventDTO createProvenanceEventDto(final ProvenanceEventRecord event) { // convert the attributes @@ -1018,12 +1014,6 @@ public class ControllerFacade { return dto; } - /** - * Gets the name for the component with the specified id. - * - * @param dto - * @return - */ private void setComponentDetails(final ProvenanceEventDTO dto) { final ProcessGroup root = flowController.getGroup(flowController.getRootGroupId()); @@ -1037,8 +1027,8 @@ public class ControllerFacade { /** * Searches this controller for the specified term. * - * @param search - * @return + * @param search search + * @return result */ public SearchResultsDTO search(final String search) { final ProcessGroup rootGroup = flowController.getGroup(flowController.getRootGroupId()); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java index 52cba66ffc..bb18b1b167 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java @@ -81,8 +81,7 @@ public interface ControllerServiceDAO { void verifyUpdate(ControllerServiceDTO controllerServiceDTO); /** - * Determines whether the referencing component of the specified controller - * service can be updated. + * Determines whether the referencing component of the specified controller service can be updated. * * @param controllerServiceId service id * @param scheduledState scheduled state diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java index 33ae2bded9..1df13e50ed 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java @@ -25,7 +25,7 @@ public interface PortDAO { /** * @param groupId group id - * @param portId port id + * @param portId port id * @return Determines if the specified port exists in the specified group */ boolean hasPort(String groupId, String portId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java index 2cd85060c7..3655083f30 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java @@ -20,16 +20,13 @@ import java.util.Set; import org.apache.nifi.groups.ProcessGroup; import org.apache.nifi.web.api.dto.ProcessGroupDTO; -/** - * - */ public interface ProcessGroupDAO { /** * Determines if the specified remote process group exists. * - * @param groupId - * @return + * @param groupId id + * @return true if group exists */ boolean hasProcessGroup(String groupId); @@ -61,7 +58,7 @@ public interface ProcessGroupDAO { /** * Verifies the specified process group can be modified. * - * @param processGroupDTO + * @param processGroupDTO dto */ void verifyUpdate(ProcessGroupDTO processGroupDTO); @@ -76,7 +73,7 @@ public interface ProcessGroupDAO { /** * Verifies the specified process group can be removed. * - * @param groupId + * @param groupId id */ void verifyDelete(String groupId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java index 8f2416a3a5..30cce5da18 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java @@ -64,8 +64,7 @@ public interface ProcessorDAO { void verifyUpdate(String groupId, ProcessorDTO processorDTO); /** - * Updates the configuration for the processor using the specified - * processorDTO. + * Updates the configuration for the processor using the specified processorDTO. * * @param groupId group id * @param processorDTO processor diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java index cf1ac30901..d9eafb06bc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java @@ -100,7 +100,7 @@ public interface RemoteProcessGroupDAO { * @param groupId id * @param remoteProcessGroupId id * @param remoteProcessGroupPort port - * @return + * @return updated group port */ RemoteGroupPort updateRemoteProcessGroupInputPort(String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort); @@ -110,7 +110,7 @@ public interface RemoteProcessGroupDAO { * @param groupId group id * @param remoteProcessGroupId group id * @param remoteProcessGroupPort port - * @return + * @return group port */ RemoteGroupPort updateRemoteProcessGroupOutputPort(String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java index cbdd4a1c6d..43852c24d0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java @@ -21,16 +21,13 @@ import org.apache.nifi.controller.ReportingTaskNode; import org.apache.nifi.web.api.dto.ReportingTaskDTO; -/** - * - */ public interface ReportingTaskDAO { /** * Determines if the specified reporting task exists. * - * @param reportingTaskId - * @return + * @param reportingTaskId id + * @return true if reporting task exists */ boolean hasReportingTask(String reportingTaskId); @@ -68,14 +65,14 @@ public interface ReportingTaskDAO { /** * Determines whether this reporting task can be updated. * - * @param reportingTaskDTO + * @param reportingTaskDTO dto */ void verifyUpdate(ReportingTaskDTO reportingTaskDTO); /** * Determines whether this reporting task can be removed. * - * @param reportingTaskId + * @param reportingTaskId id */ void verifyDelete(String reportingTaskId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java index 9ea60cb531..a3cbed4562 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java @@ -23,8 +23,7 @@ import org.apache.nifi.web.api.dto.SnippetDTO; public interface SnippetDAO { /** - * Copies the specified snippet and added the copy to the flow in the - * specified group. + * Copies the specified snippet and added the copy to the flow in the specified group. * * @param groupId group id * @param snippetId snippet id diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java index 52641197b7..014a607607 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java @@ -21,9 +21,6 @@ import org.apache.nifi.controller.Template; import org.apache.nifi.web.api.dto.FlowSnippetDTO; import org.apache.nifi.web.api.dto.TemplateDTO; -/** - * - */ public interface TemplateDAO { /** @@ -37,19 +34,19 @@ public interface TemplateDAO { /** * Import the specified template. * - * @param templateDTO - * @return + * @param templateDTO dto + * @return template */ Template importTemplate(TemplateDTO templateDTO); /** * Instantiate the corresponding template. * - * @param groupId - * @param originX - * @param originY - * @param templateId - * @return + * @param groupId group id + * @param originX x + * @param originY y + * @param templateId template id + * @return flow snippet */ FlowSnippetDTO instantiateTemplate(String groupId, Double originX, Double originY, String templateId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java index a2c9567245..165e7a5aa9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java @@ -20,17 +20,14 @@ import org.apache.nifi.controller.FlowController; import org.apache.nifi.groups.ProcessGroup; import org.apache.nifi.web.ResourceNotFoundException; -/** - * - */ public abstract class ComponentDAO { /** * Returns whether the specified object is not null. * - * @param - * @param object - * @return + * @param type + * @param object object + * @return true if the specified object is not null */ protected boolean isNotNull(T object) { return object != null; @@ -39,9 +36,9 @@ public abstract class ComponentDAO { /** * Returns whether any of the specified objects are not null. * - * @param - * @param objects - * @return + * @param type + * @param objects objects + * @return true if any of the specified objects are not null */ protected boolean isAnyNotNull(T... objects) { for (final T object : objects) { @@ -56,9 +53,9 @@ public abstract class ComponentDAO { /** * Locates the specified ProcessGroup. * - * @param flowController - * @param groupId - * @return + * @param flowController controller + * @param groupId id + * @return group */ protected ProcessGroup locateProcessGroup(FlowController flowController, String groupId) { ProcessGroup group = flowController.getGroup(groupId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java index a984867df8..5fbc3936b1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java @@ -63,23 +63,11 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO return connection; } - /** - * Gets the specified connection. - * - * @return The connections - */ @Override public Connection getConnection(final String groupId, final String id) { return locateConnection(groupId, id); } - /** - * Gets the connections for the specified source processor. - * - * @param groupId - * @param processorId - * @return - */ @Override public Set getConnectionsForSource(final String groupId, final String processorId) { final Set connections = new HashSet<>(getConnections(groupId)); @@ -93,13 +81,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO return connections; } - /** - * Determines if the specified connection exists. Returns false when either - * the group or connection do not exist. - * - * @param id - * @return - */ @Override public boolean hasConnection(final String groupId, final String id) { final ProcessGroup group = flowController.getGroup(groupId); @@ -111,11 +92,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO return group.getConnection(id) != null; } - /** - * Gets all of the connections. - * - * @return The connections - */ @Override public Set getConnections(final String groupId) { final ProcessGroup group = locateProcessGroup(flowController, groupId); @@ -124,9 +100,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO /** * Configures the specified connection using the specified dto. - * - * @param connection - * @param connectionDTO */ private void configureConnection(Connection connection, ConnectionDTO connectionDTO) { // validate flow file comparators/prioritizers @@ -181,10 +154,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO /** * Validates the proposed processor configuration. - * - * @param processorNode - * @param config - * @return */ private List validateProposedConfiguration(final String groupId, final ConnectionDTO connectionDTO) { List validationErrors = new ArrayList<>(); @@ -233,12 +202,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO return validationErrors; } - /** - * Creates a new Connection. - * - * @param connectionDTO The connection DTO - * @return The connection - */ @Override public Connection createConnection(final String groupId, final ConnectionDTO connectionDTO) { final ProcessGroup group = locateProcessGroup(flowController, groupId); @@ -371,12 +334,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO } } - /** - * Updates the specified Connection. - * - * @param connectionDTO The connection DTO - * @return The connection - */ @Override public Connection updateConnection(final String groupId, final ConnectionDTO connectionDTO) { final ProcessGroup group = locateProcessGroup(flowController, groupId); @@ -500,11 +457,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO connection.verifyCanDelete(); } - /** - * Deletes the specified Connection. - * - * @param id The id of the connection - */ @Override public void deleteConnection(final String groupId, final String id) { final ProcessGroup group = locateProcessGroup(flowController, groupId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardControllerServiceDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardControllerServiceDAO.java index dd9fc0d1e6..486e6d77ff 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardControllerServiceDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardControllerServiceDAO.java @@ -37,12 +37,6 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro private ControllerServiceProvider serviceProvider; - /** - * Locates the specified controller service. - * - * @param controllerServiceId - * @return - */ private ControllerServiceNode locateControllerService(final String controllerServiceId) { // get the controller service final ControllerServiceNode controllerService = serviceProvider.getControllerServiceNode(controllerServiceId); @@ -55,12 +49,6 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro return controllerService; } - /** - * Creates a controller service. - * - * @param controllerServiceDTO The controller service DTO - * @return The controller service - */ @Override public ControllerServiceNode createControllerService(final ControllerServiceDTO controllerServiceDTO) { // ensure the type is specified @@ -72,7 +60,7 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro // create the controller service final ControllerServiceNode controllerService = serviceProvider.createControllerService(controllerServiceDTO.getType(), controllerServiceDTO.getId(), true); - // ensure we can perform the update + // ensure we can perform the update verifyUpdate(controllerService, controllerServiceDTO); // perform the update @@ -84,50 +72,27 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro } } - /** - * Gets the specified controller service. - * - * @param controllerServiceId The controller service id - * @return The controller service - */ @Override public ControllerServiceNode getControllerService(final String controllerServiceId) { return locateControllerService(controllerServiceId); } - /** - * Determines if the specified controller service exists. - * - * @param controllerServiceId - * @return - */ @Override public boolean hasControllerService(final String controllerServiceId) { return serviceProvider.getControllerServiceNode(controllerServiceId) != null; } - /** - * Gets all of the controller services. - * - * @return The controller services - */ @Override public Set getControllerServices() { return serviceProvider.getAllControllerServices(); } - /** - * Updates the specified controller service. - * - * @param controllerServiceDTO The controller service DTO - * @return The controller service - */ @Override public ControllerServiceNode updateControllerService(final ControllerServiceDTO controllerServiceDTO) { // get the controller service final ControllerServiceNode controllerService = locateControllerService(controllerServiceDTO.getId()); - // ensure we can perform the update + // ensure we can perform the update verifyUpdate(controllerService, controllerServiceDTO); // perform the update @@ -151,7 +116,8 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro } @Override - public ControllerServiceReference updateControllerServiceReferencingComponents(final String controllerServiceId, final ScheduledState scheduledState, final ControllerServiceState controllerServiceState) { + public ControllerServiceReference updateControllerServiceReferencingComponents( + final String controllerServiceId, final ScheduledState scheduledState, final ControllerServiceState controllerServiceState) { // get the controller service final ControllerServiceNode controllerService = locateControllerService(controllerServiceId); @@ -173,14 +139,6 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro return controllerService.getReferences(); } - /** - * Validates the specified configuration for the specified controller - * service. - * - * @param controllerService - * @param controllerServiceDTO - * @return - */ private List validateProposedConfiguration(final ControllerServiceNode controllerService, final ControllerServiceDTO controllerServiceDTO) { final List validationErrors = new ArrayList<>(); return validationErrors; @@ -217,12 +175,6 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro } } - /** - * Verifies the controller service can be updated. - * - * @param controllerService - * @param controllerServiceDTO - */ private void verifyUpdate(final ControllerServiceNode controllerService, final ControllerServiceDTO controllerServiceDTO) { // validate the new controller service state if appropriate if (isNotNull(controllerServiceDTO.getState())) { @@ -269,12 +221,6 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro } } - /** - * Configures the specified controller service. - * - * @param controllerService - * @param controllerServiceDTO - */ private void configureControllerService(final ControllerServiceNode controllerService, final ControllerServiceDTO controllerServiceDTO) { final String name = controllerServiceDTO.getName(); final String annotationData = controllerServiceDTO.getAnnotationData(); @@ -303,11 +249,6 @@ public class StandardControllerServiceDAO extends ComponentDAO implements Contro } } - /** - * Deletes the specified controller service. - * - * @param controllerServiceId The controller service id - */ @Override public void deleteControllerService(String controllerServiceId) { final ControllerServiceNode controllerService = locateControllerService(controllerServiceId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardFunnelDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardFunnelDAO.java index d54e2e60fc..2be8e26fc4 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardFunnelDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardFunnelDAO.java @@ -30,24 +30,10 @@ public class StandardFunnelDAO extends ComponentDAO implements FunnelDAO { private FlowController flowController; - /** - * Locates the specified funnel. - * - * @param groupId - * @param funnelId - * @return - */ private Funnel locateFunnel(String groupId, String funnelId) { return locateFunnel(locateProcessGroup(flowController, groupId), funnelId); } - /** - * Locates the specified funnel. - * - * @param group - * @param funnelId - * @return - */ private Funnel locateFunnel(ProcessGroup group, String funnelId) { // get the funnel Funnel funnel = group.getFunnel(funnelId); @@ -60,12 +46,6 @@ public class StandardFunnelDAO extends ComponentDAO implements FunnelDAO { return funnel; } - /** - * Creates a funnel. - * - * @param funnelDTO The funnel DTO - * @return The funnel - */ @Override public Funnel createFunnel(String groupId, FunnelDTO funnelDTO) { if (funnelDTO.getParentGroupId() != null && !flowController.areGroupsSame(groupId, funnelDTO.getParentGroupId())) { @@ -87,23 +67,11 @@ public class StandardFunnelDAO extends ComponentDAO implements FunnelDAO { return funnel; } - /** - * Gets the specified funnel. - * - * @param funnelId The funnel id - * @return The funnel - */ @Override public Funnel getFunnel(String groupId, String funnelId) { return locateFunnel(groupId, funnelId); } - /** - * Determines if the specified funnel exists. - * - * @param funnelId - * @return - */ @Override public boolean hasFunnel(String groupId, String funnelId) { ProcessGroup group; @@ -116,23 +84,12 @@ public class StandardFunnelDAO extends ComponentDAO implements FunnelDAO { return group.getFunnel(funnelId) != null; } - /** - * Gets all of the funnels. - * - * @return The funnels - */ @Override public Set getFunnels(String groupId) { ProcessGroup group = locateProcessGroup(flowController, groupId); return group.getFunnels(); } - /** - * Updates the specified funnel. - * - * @param funnelDTO The funnel DTO - * @return The funnel - */ @Override public Funnel updateFunnel(String groupId, FunnelDTO funnelDTO) { ProcessGroup group = locateProcessGroup(flowController, groupId); @@ -157,11 +114,6 @@ public class StandardFunnelDAO extends ComponentDAO implements FunnelDAO { funnel.verifyCanDelete(); } - /** - * Deletes the specified funnel. - * - * @param funnelId The funnel id - */ @Override public void deleteFunnel(String groupId, String funnelId) { ProcessGroup group = locateProcessGroup(flowController, groupId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardInputPortDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardInputPortDAO.java index 6e79956cfc..fd133a5efc 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardInputPortDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardInputPortDAO.java @@ -51,12 +51,6 @@ public class StandardInputPortDAO extends ComponentDAO implements PortDAO { return port; } - /** - * Creates a port. - * - * @param portDTO The port DTO - * @return The port - */ @Override public Port createPort(String groupId, PortDTO portDTO) { if (isNotNull(portDTO.getParentGroupId()) && !flowController.areGroupsSame(groupId, portDTO.getParentGroupId())) { @@ -93,23 +87,11 @@ public class StandardInputPortDAO extends ComponentDAO implements PortDAO { return port; } - /** - * Gets the specified port. - * - * @param portId The port id - * @return The port - */ @Override public Port getPort(String groupId, String portId) { return locatePort(groupId, portId); } - /** - * Determines if the specified port exists. - * - * @param portId - * @return - */ @Override public boolean hasPort(String groupId, String portId) { ProcessGroup group = flowController.getGroup(groupId); @@ -121,11 +103,6 @@ public class StandardInputPortDAO extends ComponentDAO implements PortDAO { return group.getInputPort(portId) != null; } - /** - * Gets all of the ports. - * - * @return The ports - */ @Override public Set getPorts(String groupId) { ProcessGroup group = locateProcessGroup(flowController, groupId); @@ -187,13 +164,6 @@ public class StandardInputPortDAO extends ComponentDAO implements PortDAO { } } - /** - * Validates the proposed processor configuration. - * - * @param processorNode - * @param config - * @return - */ private List validateProposedConfiguration(PortDTO portDTO) { List validationErrors = new ArrayList<>(); @@ -207,12 +177,6 @@ public class StandardInputPortDAO extends ComponentDAO implements PortDAO { return validationErrors; } - /** - * Updates the specified port. - * - * @param portDTO The port DTO - * @return The port - */ @Override public Port updatePort(String groupId, PortDTO portDTO) { ProcessGroup group = locateProcessGroup(flowController, groupId); @@ -290,11 +254,6 @@ public class StandardInputPortDAO extends ComponentDAO implements PortDAO { inputPort.verifyCanDelete(); } - /** - * Deletes the specified port. - * - * @param portId The port id - */ @Override public void deletePort(final String groupId, final String portId) { final ProcessGroup group = locateProcessGroup(flowController, groupId); diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardLabelDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardLabelDAO.java index ea16ae354f..bd774e2594 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardLabelDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardLabelDAO.java @@ -31,24 +31,10 @@ public class StandardLabelDAO extends ComponentDAO implements LabelDAO { private FlowController flowController; - /** - * Locates the specified label. - * - * @param groupId - * @param labelId - * @return - */ private Label locateLabel(String groupId, String labelId) { return locateLabel(locateProcessGroup(flowController, groupId), labelId); } - /** - * Locates the specified label. - * - * @param group - * @param labelId - * @return - */ private Label locateLabel(ProcessGroup group, String labelId) { // get the label Label label = group.getLabel(labelId); @@ -61,12 +47,6 @@ public class StandardLabelDAO extends ComponentDAO implements LabelDAO { return label; } - /** - * Creates a label. - * - * @param labelDTO The label DTO - * @return The label - */ @Override public Label createLabel(String groupId, LabelDTO labelDTO) { if (labelDTO.getParentGroupId() != null && !flowController.areGroupsSame(groupId, labelDTO.getParentGroupId())) { @@ -91,23 +71,11 @@ public class StandardLabelDAO extends ComponentDAO implements LabelDAO { return label; } - /** - * Gets the specified label. - * - * @param labelId The label id - * @return The label - */ @Override public Label getLabel(String groupId, String labelId) { return locateLabel(groupId, labelId); } - /** - * Determines if the specified label exists. - * - * @param labelId - * @return - */ @Override public boolean hasLabel(String groupId, String labelId) { ProcessGroup group; @@ -120,23 +88,12 @@ public class StandardLabelDAO extends ComponentDAO implements LabelDAO { return group.getLabel(labelId) != null; } - /** - * Gets all of the labels. - * - * @return The labels - */ @Override public Set