http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java ---------------------------------------------------------------------- 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 1bf3f77..2b3657e 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<ProcessGroupDTO> populateRemainingProcessGroupsContent(Set<ProcessGroupDTO> 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
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java ---------------------------------------------------------------------- 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 00b6fe3..16c7e19 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<ProcessorDTO> populateRemainingProcessorsContent(Set<ProcessorDTO> 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: * <br> * <ul> * <li>properties[required.file.path]=/path/to/file</li> @@ -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. */ http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceResource.java ---------------------------------------------------------------------- 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 5fef27f..4bfe3a0 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: * <br> * <ul> * <li>search[filename]=myFile.txt</li> @@ -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 */ http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java ---------------------------------------------------------------------- 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 b171835..c506b9b 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<RemoteProcessGroupDTO> populateRemainingRemoteProcessGroupsContent(Set<RemoteProcessGroupDTO> 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. http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java ---------------------------------------------------------------------- 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 485b8fd..8aea04c 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<ReportingTaskDTO> populateRemainingReportingTasksContent(final String availability, final Set<ReportingTaskDTO> 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: * <br> * <ul> * <li>properties[required.file.path]=/path/to/file</li> @@ -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. */ http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SnippetResource.java ---------------------------------------------------------------------- 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 275b133..997fe4a 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. */ http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SystemDiagnosticsResource.java ---------------------------------------------------------------------- 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 915c55e..f747c47 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 http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TemplateResource.java ---------------------------------------------------------------------- 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 24292e9..00707be 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<TemplateDTO> populateRemainingTemplatesContent(Set<TemplateDTO> 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("<errorResponse status=\"%s\" statusText=\"Unable to import the specified template: %s\"/>", Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), e.getMessage()); + String responseXml = String.format("<errorResponse status=\"%s\" statusText=\"Unable to import the specified template: %s\"/>", + 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("<errorResponse status=\"%s\" statusText=\"Unable to import the specified template: %s\"/>", Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(), e.getMessage()); + String responseXml + = String.format("<errorResponse status=\"%s\" statusText=\"Unable to import the specified template: %s\"/>", 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. */
