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/ConnectionResource.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/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 5d233f7..137cc07 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<ConnectionDTO> populateRemainingConnectionsContent(Set<ConnectionDTO> 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. */
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/ControllerResource.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/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 9228be4..9e34201 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 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/ControllerServiceResource.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/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 bd3daf2..90d031d 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<ControllerServiceDTO> populateRemainingControllerServicesContent(final String availability, final Set<ControllerServiceDTO> 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: * <br> * <ul> * <li>properties[required.file.path]=/path/to/file</li> @@ -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. */ 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/FunnelResource.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/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 4e6095e..fd97dca 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<FunnelDTO> populateRemainingFunnelsContent(Set<FunnelDTO> 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. */ 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/HistoryResource.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/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 49bede82..749863c 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. */ 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/InputPortResource.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/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 9b5eeba..4e446fb 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<PortDTO> populateRemainingInputPortsContent(Set<PortDTO> 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. */ 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/LabelResource.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/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 4905ad3..6b12d0e 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<LabelDTO> populateRemainingLabelsContent(Set<LabelDTO> 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: * <br> * <ul> * <li>style[background-color]=#aaaaaa</li> @@ -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. */ 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/NodeResource.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/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 db3d040..bb0eba9 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 */ 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/OutputPortResource.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/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 168ec90..a600d35 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<PortDTO> populateRemainingOutputPortsContent(Set<PortDTO> 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. */
