Search in sources :

Example 6 with ComponentStateEntity

use of org.apache.nifi.web.api.entity.ComponentStateEntity in project nifi by apache.

the class ReportingTaskResource method getState.

/**
 * Gets the state for a reporting task.
 *
 * @param id The id of the reporting task
 * @return a componentStateEntity
 */
@GET
@Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON)
@Path("{id}/state")
@ApiOperation(value = "Gets the state for a reporting task", response = ComponentStateEntity.class, authorizations = { @Authorization(value = "Write - /reporting-tasks/{uuid}") })
@ApiResponses(value = { @ApiResponse(code = 400, message = "NiFi was unable to complete the request because it was invalid. The request should not be retried without modification."), @ApiResponse(code = 401, message = "Client could not be authenticated."), @ApiResponse(code = 403, message = "Client is not authorized to make this request."), @ApiResponse(code = 404, message = "The specified resource could not be found."), @ApiResponse(code = 409, message = "The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.") })
public Response getState(@ApiParam(value = "The reporting task id.", required = true) @PathParam("id") final String id) {
    if (isReplicateRequest()) {
        return replicate(HttpMethod.GET);
    }
    // authorize access
    serviceFacade.authorizeAccess(lookup -> {
        final Authorizable reportingTask = lookup.getReportingTask(id).getAuthorizable();
        reportingTask.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser());
    });
    // get the component state
    final ComponentStateDTO state = serviceFacade.getReportingTaskState(id);
    // generate the response entity
    final ComponentStateEntity entity = new ComponentStateEntity();
    entity.setComponentState(state);
    // generate the response
    return generateOkResponse(entity).build();
}
Also used : ComponentAuthorizable(org.apache.nifi.authorization.ComponentAuthorizable) Authorizable(org.apache.nifi.authorization.resource.Authorizable) ComponentStateDTO(org.apache.nifi.web.api.dto.ComponentStateDTO) ComponentStateEntity(org.apache.nifi.web.api.entity.ComponentStateEntity) Path(javax.ws.rs.Path) Consumes(javax.ws.rs.Consumes) Produces(javax.ws.rs.Produces) GET(javax.ws.rs.GET) ApiOperation(io.swagger.annotations.ApiOperation) ApiResponses(io.swagger.annotations.ApiResponses)

Aggregations

ApiOperation (io.swagger.annotations.ApiOperation)6 ApiResponses (io.swagger.annotations.ApiResponses)6 Consumes (javax.ws.rs.Consumes)6 Path (javax.ws.rs.Path)6 Produces (javax.ws.rs.Produces)6 ComponentAuthorizable (org.apache.nifi.authorization.ComponentAuthorizable)6 Authorizable (org.apache.nifi.authorization.resource.Authorizable)6 ComponentStateEntity (org.apache.nifi.web.api.entity.ComponentStateEntity)6 GET (javax.ws.rs.GET)3 POST (javax.ws.rs.POST)3 ComponentStateDTO (org.apache.nifi.web.api.dto.ComponentStateDTO)3 ControllerServiceEntity (org.apache.nifi.web.api.entity.ControllerServiceEntity)1 ProcessorEntity (org.apache.nifi.web.api.entity.ProcessorEntity)1 ReportingTaskEntity (org.apache.nifi.web.api.entity.ReportingTaskEntity)1