NIFI-292: - Continuing to annotate endpoints using swagger. Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/9bdc752a Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/9bdc752a Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/9bdc752a
Branch: refs/heads/NIFI-292 Commit: 9bdc752aa8964787d6e72c7a74a2cc6826577d2c Parents: 180534b Author: Matt Gilman <[email protected]> Authored: Tue Apr 28 09:28:01 2015 -0400 Committer: Matt Gilman <[email protected]> Committed: Tue Apr 28 09:28:01 2015 -0400 ---------------------------------------------------------------------- .../nifi/web/api/BulletinBoardResource.java | 1 - .../apache/nifi/web/api/ClusterResource.java | 131 +++--- .../apache/nifi/web/api/ConnectionResource.java | 93 +++-- .../apache/nifi/web/api/ControllerResource.java | 124 ++++-- .../nifi/web/api/ControllerServiceResource.java | 394 ++++++++++++++++--- .../org/apache/nifi/web/api/FunnelResource.java | 167 +++++++- .../apache/nifi/web/api/InputPortResource.java | 138 ++++++- 7 files changed, 856 insertions(+), 192 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9bdc752a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.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/BulletinBoardResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java index d496ed7..6cc1c8a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/BulletinBoardResource.java @@ -20,7 +20,6 @@ import com.wordnik.swagger.annotations.Api; import javax.ws.rs.Consumes; import javax.ws.rs.DefaultValue; import javax.ws.rs.GET; -import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.QueryParam; import javax.ws.rs.core.MediaType; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9bdc752a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.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/ClusterResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java index 7d76179..a937467 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ClusterResource.java @@ -111,7 +111,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the status of 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. * @return A clusterStatusEntity */ @GET @@ -139,7 +141,7 @@ public class ClusterResource extends ApplicationResource { ) public Response getClusterStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -182,9 +184,12 @@ public class ClusterResource extends ApplicationResource { } /** - * Gets the contents of this NiFi cluster. This includes all nodes and their status. + * Gets the contents of this NiFi cluster. This includes all nodes and their + * status. * - * @param clientId Optional client id. If 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 clusterEntity */ @GET @@ -212,7 +217,7 @@ public class ClusterResource extends ApplicationResource { ) public Response getCluster( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -269,7 +274,7 @@ public class ClusterResource extends ApplicationResource { ) public Response searchCluster( @ApiParam( - value = "Node address to search for", + value = "Node address to search for.", required = true ) @QueryParam("q") @DefaultValue(StringUtils.EMPTY) String value) { @@ -314,7 +319,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the 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 * @return A processorEntity */ @@ -344,16 +351,16 @@ public class ClusterResource extends ApplicationResource { ) public Response getProcessor( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The processor id", + value = "The processor id.", required = true ) @PathParam("id") String id) { - + if (!properties.isClusterManager()) { final ProcessorDTO dto = serviceFacade.getProcessor(id); @@ -378,8 +385,11 @@ public class ClusterResource extends ApplicationResource { * Updates the processors annotation data. * * @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 version The revision is used to verify the client is working with + * the latest version of the flow. + * @param clientId Optional client id. If the client id is not specified, a + * new one will be generated. This value (whether specified or generated) is + * included in the response. * @param processorId The id of the processor. * @param annotationData The annotation data to set. * @return A processorEntity. @@ -462,7 +472,7 @@ public class ClusterResource extends ApplicationResource { public Response updateProcessor( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "The processor id", + value = "The processor id.", required = true ) @PathParam("id") final String processorId, @@ -529,7 +539,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the processor status for every 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 processor * @return A clusterProcessorStatusEntity */ @@ -559,10 +571,10 @@ public class ClusterResource extends ApplicationResource { ) public Response getProcessorStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( value = "The processor id", required = true @@ -592,7 +604,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the processor status history for every 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 processor * @return A clusterProcessorStatusHistoryEntity */ @@ -622,7 +636,7 @@ public class ClusterResource extends ApplicationResource { ) public Response getProcessorStatusHistory( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @@ -654,7 +668,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the connection status for every 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 processor * @return A clusterProcessorStatusEntity */ @@ -684,10 +700,10 @@ public class ClusterResource extends ApplicationResource { ) public Response getConnectionStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( value = "The connection id", required = true @@ -717,7 +733,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the connections status history for every 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 processor * @return A clusterProcessorStatusHistoryEntity */ @@ -747,12 +765,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getConnectionStatusHistory( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The connection id", + value = "The connection id.", required = true ) @PathParam("id") String id) { @@ -779,7 +797,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the process group status for every 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 process group * @return A clusterProcessGroupStatusEntity */ @@ -809,12 +829,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getProcessGroupStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The process group id", + value = "The process group id.", required = true ) @PathParam("id") String id) { @@ -842,7 +862,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the process group status history for every 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 process group * @return A clusterProcessGroupStatusHistoryEntity */ @@ -872,12 +894,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getProcessGroupStatusHistory( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The process group id", + value = "The process group id.", required = true ) @PathParam("id") String id) { @@ -904,7 +926,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the remote process group status for every 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 remote process group * @return A clusterRemoteProcessGroupStatusEntity */ @@ -934,12 +958,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getRemoteProcessGroupStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The remote process group id", + value = "The remote process group id.", required = true ) @PathParam("id") String id) { @@ -967,7 +991,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the input port status for every 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 input port * @return A clusterPortStatusEntity */ @@ -997,12 +1023,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getInputPortStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The input port id", + value = "The input port id.", required = true ) @PathParam("id") String id) { @@ -1030,7 +1056,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the output port status for every 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 output port * @return A clusterPortStatusEntity */ @@ -1060,12 +1088,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getOutputPortStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The output port id", + value = "The output port id.", required = true ) @PathParam("id") String id) { @@ -1093,7 +1121,9 @@ public class ClusterResource extends ApplicationResource { /** * Gets the remote process group status history for every 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 processor * @return A clusterRemoteProcessGroupStatusHistoryEntity */ @@ -1123,12 +1153,12 @@ public class ClusterResource extends ApplicationResource { ) public Response getRemoteProcessGroupStatusHistory( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The remote process group id", + value = "The remote process group id.", required = true ) @PathParam("id") String id) { @@ -1153,7 +1183,6 @@ public class ClusterResource extends ApplicationResource { } // setters - public void setServiceFacade(NiFiServiceFacade serviceFacade) { this.serviceFacade = serviceFacade; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9bdc752a/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 1e06fa4..503d6ba 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 @@ -114,12 +114,15 @@ 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 @Consumes(MediaType.WILDCARD) @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) + @Path("") // necessary due to bug in swagger @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')") @TypeHint(ConnectionsEntity.class) @ApiOperation( @@ -141,7 +144,7 @@ public class ConnectionResource extends ApplicationResource { ) public Response getConnections( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -170,7 +173,9 @@ 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. */ @@ -200,12 +205,12 @@ public class ConnectionResource extends ApplicationResource { ) public Response getConnection( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The connection id", + value = "The connection id.", required = true ) @PathParam("id") String id) { @@ -234,7 +239,9 @@ 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. */ @@ -264,12 +271,12 @@ public class ConnectionResource extends ApplicationResource { ) public Response getConnectionStatusHistory( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) - @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, + @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The connection id", + value = "The connection id.", required = true ) @PathParam("id") String id) { @@ -299,8 +306,11 @@ public class ConnectionResource extends ApplicationResource { * Creates a connection. * * @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 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. @@ -308,10 +318,15 @@ 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. @@ -321,6 +336,7 @@ public class ConnectionResource extends ApplicationResource { @POST @Consumes(MediaType.APPLICATION_FORM_URLENCODED) @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) + @Path("") // necessary due to bug in swagger @PreAuthorize("hasRole('ROLE_DFM')") @TypeHint(ConnectionEntity.class) public Response createConnection( @@ -455,6 +471,7 @@ public class ConnectionResource extends ApplicationResource { @POST @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) + @Path("") // necessary due to bug in swagger @PreAuthorize("hasRole('ROLE_DFM')") @TypeHint(ConnectionEntity.class) @ApiOperation( @@ -476,10 +493,9 @@ public class ConnectionResource extends ApplicationResource { public Response createConnection( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "The connection configuration details", + value = "The connection configuration details.", required = true - ) - ConnectionEntity connectionEntity) { + ) ConnectionEntity connectionEntity) { if (connectionEntity == null || connectionEntity.getConnection() == null) { throw new IllegalArgumentException("Connection details must be specified."); @@ -557,8 +573,11 @@ public class ConnectionResource extends ApplicationResource { * Updates the specified relationship target. * * @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 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. @@ -566,10 +585,15 @@ 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. @@ -739,15 +763,14 @@ public class ConnectionResource extends ApplicationResource { public Response updateConnection( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "The connection id", + value = "The connection id.", required = true ) @PathParam("id") String id, @ApiParam( - value = "The connection configuration details", + value = "The connection configuration details.", required = true - ) - ConnectionEntity connectionEntity) { + ) ConnectionEntity connectionEntity) { if (connectionEntity == null || connectionEntity.getConnection() == null) { throw new IllegalArgumentException("Connection details must be specified."); @@ -805,8 +828,11 @@ public class ConnectionResource extends ApplicationResource { * Removes the specified connection. * * @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 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. */ @@ -835,17 +861,17 @@ public class ConnectionResource extends ApplicationResource { public Response deleteRelationshipTarget( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "The revision is used to verify the client is working with the latest version of the flow", + value = "The revision is used to verify the client is working with the latest version of the flow.", required = false ) @QueryParam(VERSION) LongParameter version, @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "The connection id", + value = "The connection id.", required = true ) @PathParam("id") String id) { @@ -885,7 +911,6 @@ public class ConnectionResource extends ApplicationResource { } // setters - public void setServiceFacade(NiFiServiceFacade serviceFacade) { this.serviceFacade = serviceFacade; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/9bdc752a/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 821ca2f..418d475 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 @@ -249,7 +249,8 @@ 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. */ @@ -266,7 +267,9 @@ 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 @@ -289,7 +292,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getController( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -361,14 +364,22 @@ 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 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 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 @@ -380,9 +391,9 @@ public class ControllerResource extends ApplicationResource { @ApiOperation( value = "Creates a new archive of this NiFi flow configuration", notes = "This POST operation 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.", + + "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.", response = ProcessGroupEntity.class, authorizations = { @Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @@ -399,12 +410,12 @@ public class ControllerResource extends ApplicationResource { public Response createArchive( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "The revision is used to verify the client is working with the latest version of the flow", + value = "The revision is used to verify the client is working with the latest version of the flow.", required = true ) @FormParam(VERSION) LongParameter version, @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @FormParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -487,7 +498,9 @@ 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 @@ -515,7 +528,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getControllerStatus( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -538,7 +551,9 @@ 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 @@ -566,7 +581,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getCounters( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -590,7 +605,9 @@ public class ControllerResource extends ApplicationResource { * Update the specified counter. This will reset the counter value to 0. * * @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 clientId Optional client id. If 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. */ @@ -619,7 +636,7 @@ public class ControllerResource extends ApplicationResource { public Response updateCounter( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @FormParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @@ -655,7 +672,9 @@ 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 @@ -684,7 +703,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getControllerConfig( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -714,12 +733,17 @@ public class ControllerResource extends ApplicationResource { * Update the configuration for this NiFi. * * @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 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 @@ -798,7 +822,7 @@ public class ControllerResource extends ApplicationResource { public Response updateControllerConfig( @Context HttpServletRequest httpServletRequest, @ApiParam( - value = "The controller configuration", + value = "The controller configuration.", required = true ) ControllerConfigurationEntity configEntity) { @@ -847,9 +871,12 @@ 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 @@ -877,7 +904,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getAuthorities( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -905,7 +932,9 @@ 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 @@ -933,7 +962,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getBanners( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -966,7 +995,9 @@ 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 @@ -994,7 +1025,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getProcessorTypes( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -1020,7 +1051,9 @@ 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. */ @@ -1049,12 +1082,12 @@ public class ControllerResource extends ApplicationResource { ) public Response getControllerServiceTypes( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId, @ApiParam( - value = "If specified, will only return controller services of this type", + value = "If specified, will only return controller services of this type.", required = false ) @QueryParam("serviceType") String serviceType) { @@ -1080,7 +1113,9 @@ 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 @@ -1108,7 +1143,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getReportingTaskTypes( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -1134,7 +1169,9 @@ 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 @@ -1162,7 +1199,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getPrioritizers( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -1188,7 +1225,9 @@ 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 @@ -1216,7 +1255,7 @@ public class ControllerResource extends ApplicationResource { ) public Response getAboutInfo( @ApiParam( - value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response", + value = "If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.", required = false ) @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) ClientIdParameter clientId) { @@ -1247,7 +1286,6 @@ public class ControllerResource extends ApplicationResource { } // setters - public void setServiceFacade(NiFiServiceFacade serviceFacade) { this.serviceFacade = serviceFacade; }
