| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.nifi.web.api; |
| |
| import io.swagger.annotations.Api; |
| import io.swagger.annotations.ApiOperation; |
| import io.swagger.annotations.ApiParam; |
| import io.swagger.annotations.ApiResponse; |
| import io.swagger.annotations.ApiResponses; |
| import io.swagger.annotations.Authorization; |
| import org.apache.commons.lang3.StringUtils; |
| import org.apache.nifi.authorization.AuthorizeControllerServiceReference; |
| import org.apache.nifi.authorization.AuthorizeParameterReference; |
| import org.apache.nifi.authorization.Authorizer; |
| import org.apache.nifi.authorization.ComponentAuthorizable; |
| import org.apache.nifi.authorization.RequestAction; |
| import org.apache.nifi.authorization.resource.Authorizable; |
| import org.apache.nifi.authorization.resource.OperationAuthorizable; |
| import org.apache.nifi.authorization.user.NiFiUser; |
| import org.apache.nifi.authorization.user.NiFiUserUtils; |
| import org.apache.nifi.ui.extension.UiExtension; |
| import org.apache.nifi.ui.extension.UiExtensionMapping; |
| import org.apache.nifi.web.NiFiServiceFacade; |
| import org.apache.nifi.web.Revision; |
| import org.apache.nifi.web.UiExtensionType; |
| import org.apache.nifi.web.api.concurrent.AsyncRequestManager; |
| import org.apache.nifi.web.api.concurrent.AsynchronousWebRequest; |
| import org.apache.nifi.web.api.concurrent.RequestManager; |
| import org.apache.nifi.web.api.concurrent.StandardAsynchronousWebRequest; |
| import org.apache.nifi.web.api.concurrent.StandardUpdateStep; |
| import org.apache.nifi.web.api.concurrent.UpdateStep; |
| import org.apache.nifi.web.api.dto.BundleDTO; |
| import org.apache.nifi.web.api.dto.ComponentStateDTO; |
| import org.apache.nifi.web.api.dto.ConfigVerificationResultDTO; |
| import org.apache.nifi.web.api.dto.PositionDTO; |
| import org.apache.nifi.web.api.dto.ProcessorConfigDTO; |
| import org.apache.nifi.web.api.dto.ProcessorDTO; |
| import org.apache.nifi.web.api.dto.PropertyDescriptorDTO; |
| import org.apache.nifi.web.api.dto.VerifyProcessorConfigRequestDTO; |
| import org.apache.nifi.web.api.entity.ComponentStateEntity; |
| import org.apache.nifi.web.api.entity.ProcessorDiagnosticsEntity; |
| import org.apache.nifi.web.api.entity.ProcessorEntity; |
| import org.apache.nifi.web.api.entity.ProcessorRunStatusEntity; |
| import org.apache.nifi.web.api.entity.ProcessorsRunStatusDetailsEntity; |
| import org.apache.nifi.web.api.entity.PropertyDescriptorEntity; |
| import org.apache.nifi.web.api.entity.RunStatusDetailsRequestEntity; |
| import org.apache.nifi.web.api.entity.VerifyProcessorConfigRequestEntity; |
| import org.apache.nifi.web.api.request.ClientIdParameter; |
| import org.apache.nifi.web.api.request.LongParameter; |
| import org.slf4j.Logger; |
| import org.slf4j.LoggerFactory; |
| |
| import javax.servlet.ServletContext; |
| import javax.servlet.http.HttpServletRequest; |
| import javax.ws.rs.Consumes; |
| import javax.ws.rs.DELETE; |
| import javax.ws.rs.DefaultValue; |
| import javax.ws.rs.GET; |
| import javax.ws.rs.HttpMethod; |
| import javax.ws.rs.POST; |
| import javax.ws.rs.PUT; |
| import javax.ws.rs.Path; |
| import javax.ws.rs.PathParam; |
| import javax.ws.rs.Produces; |
| import javax.ws.rs.QueryParam; |
| import javax.ws.rs.core.Context; |
| import javax.ws.rs.core.MediaType; |
| import javax.ws.rs.core.Response; |
| import java.util.Collections; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| import java.util.concurrent.TimeUnit; |
| import java.util.function.Consumer; |
| |
| /** |
| * RESTful endpoint for managing a Processor. |
| */ |
| @Path("/processors") |
| @Api( |
| value = "/processors", |
| description = "Endpoint for managing a Processor." |
| ) |
| public class ProcessorResource extends ApplicationResource { |
| private static final Logger logger = LoggerFactory.getLogger(ProcessorResource.class); |
| |
| private static final String VERIFICATION_REQUEST_TYPE = "verification-request"; |
| private RequestManager<VerifyProcessorConfigRequestEntity, List<ConfigVerificationResultDTO>> updateRequestManager = |
| new AsyncRequestManager<>(100, TimeUnit.MINUTES.toMillis(1L), "Verify Processor Config Thread"); |
| |
| private NiFiServiceFacade serviceFacade; |
| private Authorizer authorizer; |
| |
| @Context |
| private ServletContext servletContext; |
| |
| /** |
| * Populate the uri's for the specified processors and their relationships. |
| * |
| * @param processorEntities processors |
| * @return dtos |
| */ |
| public Set<ProcessorEntity> populateRemainingProcessorEntitiesContent(Set<ProcessorEntity> processorEntities) { |
| for (ProcessorEntity processorEntity : processorEntities) { |
| populateRemainingProcessorEntityContent(processorEntity); |
| } |
| return processorEntities; |
| } |
| |
| /** |
| * Populate the uri's for the specified processors and their relationships. |
| * |
| * @param processorEntity processors |
| * @return dtos |
| */ |
| public ProcessorEntity populateRemainingProcessorEntityContent(ProcessorEntity processorEntity) { |
| processorEntity.setUri(generateResourceUri("processors", processorEntity.getId())); |
| |
| // populate remaining content |
| if (processorEntity.getComponent() != null) { |
| populateRemainingProcessorContent(processorEntity.getComponent()); |
| } |
| return processorEntity; |
| } |
| |
| /** |
| * Populate the uri's for the specified processors and their relationships. |
| * |
| * @param processorDiagnosticsEntity processor's diagnostics entity |
| * @return processor diagnostics entity |
| */ |
| public ProcessorDiagnosticsEntity populateRemainingProcessorDiagnosticsEntityContent(ProcessorDiagnosticsEntity processorDiagnosticsEntity) { |
| processorDiagnosticsEntity.setUri(generateResourceUri("processors", processorDiagnosticsEntity.getId(), "diagnostics")); |
| |
| // populate remaining content |
| if (processorDiagnosticsEntity.getComponent() != null && processorDiagnosticsEntity.getComponent().getProcessor() != null) { |
| populateRemainingProcessorContent(processorDiagnosticsEntity.getComponent().getProcessor()); |
| } |
| return processorDiagnosticsEntity; |
| } |
| |
| /** |
| * Populate the uri's for the specified processor and its relationships. |
| */ |
| public ProcessorDTO populateRemainingProcessorContent(ProcessorDTO processor) { |
| // get the config details and see if there is a custom ui for this processor type |
| ProcessorConfigDTO config = processor.getConfig(); |
| if (config != null) { |
| // consider legacy custom ui fist |
| String customUiUrl = servletContext.getInitParameter(processor.getType()); |
| if (StringUtils.isNotBlank(customUiUrl)) { |
| config.setCustomUiUrl(customUiUrl); |
| } else { |
| final BundleDTO bundle = processor.getBundle(); |
| |
| // see if this processor has any ui extensions |
| final UiExtensionMapping uiExtensionMapping = (UiExtensionMapping) servletContext.getAttribute("nifi-ui-extensions"); |
| if (uiExtensionMapping.hasUiExtension(processor.getType(), bundle.getGroup(), bundle.getArtifact(), bundle.getVersion())) { |
| final List<UiExtension> uiExtensions = uiExtensionMapping.getUiExtension(processor.getType(), bundle.getGroup(), bundle.getArtifact(), bundle.getVersion()); |
| for (final UiExtension uiExtension : uiExtensions) { |
| if (UiExtensionType.ProcessorConfiguration.equals(uiExtension.getExtensionType())) { |
| config.setCustomUiUrl(uiExtension.getContextPath() + "/configure"); |
| } |
| } |
| } |
| } |
| } |
| |
| return processor; |
| } |
| |
| /** |
| * Retrieves the specified processor. |
| * |
| * @param id The id of the processor to retrieve. |
| * @return A processorEntity. |
| * @throws InterruptedException if interrupted |
| */ |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}") |
| @ApiOperation( |
| value = "Gets a processor", |
| response = ProcessorEntity.class, |
| authorizations = { |
| @Authorization(value = "Read - /processors/{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 getProcessor( |
| @ApiParam( |
| value = "The processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id) throws InterruptedException { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| // authorize access |
| serviceFacade.authorizeAccess(lookup -> { |
| final Authorizable processor = lookup.getProcessor(id).getAuthorizable(); |
| processor.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); |
| }); |
| |
| // get the specified processor |
| final ProcessorEntity entity = serviceFacade.getProcessor(id); |
| populateRemainingProcessorEntityContent(entity); |
| |
| // generate the response |
| return generateOkResponse(entity).build(); |
| } |
| |
| |
| @POST |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/run-status-details/queries") |
| @ApiOperation( |
| value = "Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs", |
| response = ProcessorsRunStatusDetailsEntity.class, |
| authorizations = { |
| @Authorization(value = "Read - /processors/{uuid} for each processor whose run status information is requested") |
| } |
| ) |
| @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 getProcessorRunStatusDetails( |
| @ApiParam(value = "The request for the processors that should be included in the results") |
| final RunStatusDetailsRequestEntity requestEntity) { |
| |
| if (requestEntity.getProcessorIds() == null) { |
| throw new IllegalArgumentException("List of Processor IDs must be provided"); |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.POST, requestEntity); |
| } |
| |
| return withWriteLock(serviceFacade, |
| requestEntity, |
| lookup -> {}, |
| null, |
| providedEntity -> { |
| final ProcessorsRunStatusDetailsEntity entity = serviceFacade.getProcessorsRunStatusDetails(requestEntity.getProcessorIds(), NiFiUserUtils.getNiFiUser()); |
| return generateOkResponse(entity).build(); |
| }); |
| } |
| |
| |
| @DELETE |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}/threads") |
| @ApiOperation(value = "Terminates a processor, essentially \"deleting\" its threads and any active tasks", response = ProcessorEntity.class, authorizations = { |
| @Authorization(value = "Write - /processors/{uuid} or /operation/processors/{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 terminateProcessor( |
| @ApiParam(value = "The processor id.", required = true) @PathParam("id") final String id) { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.DELETE); |
| } |
| |
| final ProcessorEntity requestProcessorEntity = new ProcessorEntity(); |
| requestProcessorEntity.setId(id); |
| |
| return withWriteLock( |
| serviceFacade, |
| requestProcessorEntity, |
| lookup -> { |
| final Authorizable authorizable = lookup.getProcessor(id).getAuthorizable(); |
| OperationAuthorizable.authorizeOperation(authorizable, authorizer, NiFiUserUtils.getNiFiUser()); |
| }, |
| () -> serviceFacade.verifyTerminateProcessor(id), |
| processorEntity -> { |
| final ProcessorEntity entity = serviceFacade.terminateProcessor(processorEntity.getId()); |
| populateRemainingProcessorEntityContent(entity); |
| |
| return generateOkResponse(entity).build(); |
| }); |
| } |
| |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}/diagnostics") |
| @ApiOperation(value = "Gets diagnostics information about a processor", |
| response = ProcessorEntity.class, |
| notes = NON_GUARANTEED_ENDPOINT, |
| authorizations = { @Authorization(value = "Read - /processors/{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 getProcessorDiagnostics( |
| @ApiParam(value = "The processor id.", required = true) @PathParam("id") final String id) throws InterruptedException { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| // authorize access |
| serviceFacade.authorizeAccess(lookup -> { |
| final Authorizable processor = lookup.getProcessor(id).getAuthorizable(); |
| processor.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); |
| }); |
| |
| // get the specified processor's diagnostics |
| final ProcessorDiagnosticsEntity entity = serviceFacade.getProcessorDiagnostics(id); |
| populateRemainingProcessorDiagnosticsEntityContent(entity); |
| |
| // generate the response |
| return generateOkResponse(entity).build(); |
| } |
| |
| /** |
| * Returns the descriptor for the specified property. |
| * |
| * @param id The id of the processor |
| * @param propertyName The property |
| * @return a propertyDescriptorEntity |
| * @throws InterruptedException if interrupted |
| */ |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}/descriptors") |
| @ApiOperation( |
| value = "Gets the descriptor for a processor property", |
| response = PropertyDescriptorEntity.class, |
| authorizations = { |
| @Authorization(value = "Read - /processors/{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 getPropertyDescriptor( |
| @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.", |
| required = false |
| ) |
| @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) final ClientIdParameter clientId, |
| @ApiParam( |
| value = "The processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id, |
| @ApiParam( |
| value = "The property name.", |
| required = true |
| ) |
| @QueryParam("propertyName") final String propertyName) throws InterruptedException { |
| |
| // ensure the property name is specified |
| if (propertyName == null) { |
| throw new IllegalArgumentException("The property name must be specified."); |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| // authorize access |
| serviceFacade.authorizeAccess(lookup -> { |
| final Authorizable processor = lookup.getProcessor(id).getAuthorizable(); |
| processor.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); |
| }); |
| |
| // get the property descriptor |
| final PropertyDescriptorDTO descriptor = serviceFacade.getProcessorPropertyDescriptor(id, propertyName); |
| |
| // generate the response entity |
| final PropertyDescriptorEntity entity = new PropertyDescriptorEntity(); |
| entity.setPropertyDescriptor(descriptor); |
| |
| // generate the response |
| return generateOkResponse(entity).build(); |
| } |
| |
| /** |
| * Gets the state for a processor. |
| * |
| * @param id The id of the processor |
| * @return a componentStateEntity |
| * @throws InterruptedException if interrupted |
| */ |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}/state") |
| @ApiOperation( |
| value = "Gets the state for a processor", |
| response = ComponentStateEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /processors/{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 processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id) throws InterruptedException { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| // authorize access |
| serviceFacade.authorizeAccess(lookup -> { |
| final Authorizable processor = lookup.getProcessor(id).getAuthorizable(); |
| processor.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| }); |
| |
| // get the component state |
| final ComponentStateDTO state = serviceFacade.getProcessorState(id); |
| |
| // generate the response entity |
| final ComponentStateEntity entity = new ComponentStateEntity(); |
| entity.setComponentState(state); |
| |
| // generate the response |
| return generateOkResponse(entity).build(); |
| } |
| |
| /** |
| * Clears the state for a processor. |
| * |
| * @param httpServletRequest servlet request |
| * @param id The id of the processor |
| * @return a componentStateEntity |
| * @throws InterruptedException if interrupted |
| */ |
| @POST |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{id}/state/clear-requests") |
| @ApiOperation( |
| value = "Clears the state for a processor", |
| response = ComponentStateEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /processors/{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 clearState( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id) throws InterruptedException { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.POST); |
| } |
| |
| final ProcessorEntity requestProcessorEntity = new ProcessorEntity(); |
| requestProcessorEntity.setId(id); |
| |
| return withWriteLock( |
| serviceFacade, |
| requestProcessorEntity, |
| lookup -> { |
| final Authorizable processor = lookup.getProcessor(id).getAuthorizable(); |
| processor.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| }, |
| () -> serviceFacade.verifyCanClearProcessorState(id), |
| (processorEntity) -> { |
| // get the component state |
| serviceFacade.clearProcessorState(processorEntity.getId()); |
| |
| // generate the response entity |
| final ComponentStateEntity entity = new ComponentStateEntity(); |
| |
| // generate the response |
| return generateOkResponse(entity).build(); |
| } |
| ); |
| } |
| |
| |
| @POST |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}/config/verification-requests") |
| @ApiOperation( |
| value = "Performs verification of the Processor's configuration", |
| response = VerifyProcessorConfigRequestEntity.class, |
| notes = "This will initiate the process of verifying a given Processor configuration. This may be a long-running task. As a result, this endpoint will immediately return a " + |
| "ProcessorConfigVerificationRequestEntity, and the process of performing the verification will occur asynchronously in the background. " + |
| "The client may then periodically poll the status of the request by " + |
| "issuing a GET request to /processors/{processorId}/verification-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to " + |
| "/processors/{processorId}/verification-requests/{requestId}.", |
| authorizations = { |
| @Authorization(value = "Read - /processors/{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 submitProcessorVerificationRequest( |
| @ApiParam(value = "The processor id.", required = true) @PathParam("id") final String processorId, |
| @ApiParam(value = "The processor configuration verification request.", required = true) final VerifyProcessorConfigRequestEntity processorConfigRequest) { |
| |
| if (processorConfigRequest == null) { |
| throw new IllegalArgumentException("Processor's configuration must be specified"); |
| } |
| |
| final VerifyProcessorConfigRequestDTO requestDto = processorConfigRequest.getRequest(); |
| if (requestDto == null || requestDto.getProcessorConfig() == null) { |
| throw new IllegalArgumentException("Processor's configuration must be specified"); |
| } |
| |
| if (requestDto.getProcessorId() == null) { |
| throw new IllegalArgumentException("Processor's identifier must be specified in the request"); |
| } |
| |
| if (!requestDto.getProcessorId().equals(processorId)) { |
| throw new IllegalArgumentException("Processor's identifier in the request must match the identifier provided in the URL"); |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.POST, processorConfigRequest); |
| } |
| |
| final NiFiUser user = NiFiUserUtils.getNiFiUser(); |
| |
| return withWriteLock( |
| serviceFacade, |
| processorConfigRequest, |
| lookup -> { |
| final ComponentAuthorizable processor = lookup.getProcessor(processorId); |
| processor.getAuthorizable().authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); |
| }, |
| () -> { |
| serviceFacade.verifyCanVerifyProcessorConfig(processorId); |
| }, |
| entity -> performAsyncConfigVerification(entity, user) |
| ); |
| } |
| |
| @GET |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{id}/config/verification-requests/{requestId}") |
| @ApiOperation( |
| value = "Returns the Verification Request with the given ID", |
| response = VerifyProcessorConfigRequestEntity.class, |
| notes = "Returns the Verification Request with the given ID. Once an Verification Request has been created, " |
| + "that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the " |
| + "current state of the request, and any failures. ", |
| authorizations = { |
| @Authorization(value = "Only the user that submitted the request can get it") |
| }) |
| @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 getVerificationRequest( |
| @ApiParam("The ID of the Processor") @PathParam("id") final String processorId, |
| @ApiParam("The ID of the Verification Request") @PathParam("requestId") final String requestId) { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.GET); |
| } |
| |
| final NiFiUser user = NiFiUserUtils.getNiFiUser(); |
| |
| // request manager will ensure that the current is the user that submitted this request |
| final AsynchronousWebRequest<VerifyProcessorConfigRequestEntity, List<ConfigVerificationResultDTO>> asyncRequest = updateRequestManager.getRequest(VERIFICATION_REQUEST_TYPE, requestId, user); |
| final VerifyProcessorConfigRequestEntity updateRequestEntity = createVerifyProcessorConfigRequestEntity(asyncRequest, requestId); |
| return generateOkResponse(updateRequestEntity).build(); |
| } |
| |
| |
| @DELETE |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("{id}/config/verification-requests/{requestId}") |
| @ApiOperation( |
| value = "Deletes the Verification Request with the given ID", |
| response = VerifyProcessorConfigRequestEntity.class, |
| notes = "Deletes the Verification Request with the given ID. After a request is created, it is expected " |
| + "that the client will properly clean up the request by DELETE'ing it, once the Verification process has completed. If the request is deleted before the request " |
| + "completes, then the Verification request will finish the step that it is currently performing and then will cancel any subsequent steps.", |
| authorizations = { |
| @Authorization(value = "Only the user that submitted the request can remove it") |
| }) |
| @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 deleteVerificationRequest( |
| @ApiParam("The ID of the Processor") @PathParam("id") final String processorId, |
| @ApiParam("The ID of the Verification Request") @PathParam("requestId") final String requestId) { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.DELETE); |
| } |
| |
| final NiFiUser user = NiFiUserUtils.getNiFiUser(); |
| final boolean twoPhaseRequest = isTwoPhaseRequest(httpServletRequest); |
| final boolean executionPhase = isExecutionPhase(httpServletRequest); |
| |
| // If this is a standalone node, or if this is the execution phase of the request, perform the actual request. |
| if (!twoPhaseRequest || executionPhase) { |
| // request manager will ensure that the current is the user that submitted this request |
| final AsynchronousWebRequest<VerifyProcessorConfigRequestEntity, List<ConfigVerificationResultDTO>> asyncRequest = |
| updateRequestManager.removeRequest(VERIFICATION_REQUEST_TYPE, requestId, user); |
| |
| if (!asyncRequest.isComplete()) { |
| asyncRequest.cancel(); |
| } |
| |
| final VerifyProcessorConfigRequestEntity updateRequestEntity = createVerifyProcessorConfigRequestEntity(asyncRequest, requestId); |
| return generateOkResponse(updateRequestEntity).build(); |
| } |
| |
| if (isValidationPhase(httpServletRequest)) { |
| // Perform authorization by attempting to get the request |
| updateRequestManager.getRequest(VERIFICATION_REQUEST_TYPE, requestId, user); |
| return generateContinueResponse().build(); |
| } else if (isCancellationPhase(httpServletRequest)) { |
| return generateOkResponse().build(); |
| } else { |
| throw new IllegalStateException("This request does not appear to be part of the two phase commit."); |
| } |
| } |
| |
| |
| /** |
| * Updates the specified processor with the specified values. |
| * |
| * @param httpServletRequest request |
| * @param id The id of the processor to update. |
| * @param requestProcessorEntity A processorEntity. |
| * @return A processorEntity. |
| */ |
| @PUT |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}") |
| @ApiOperation( |
| value = "Updates a processor", |
| response = ProcessorEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /processors/{uuid}"), |
| @Authorization(value = "Read - any referenced Controller Services if this request changes the reference - /controller-services/{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 updateProcessor( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id, |
| @ApiParam( |
| value = "The processor configuration details.", |
| required = true |
| ) final ProcessorEntity requestProcessorEntity) { |
| |
| if (requestProcessorEntity == null || requestProcessorEntity.getComponent() == null) { |
| throw new IllegalArgumentException("Processor details must be specified."); |
| } |
| |
| if (requestProcessorEntity.getRevision() == null) { |
| throw new IllegalArgumentException("Revision must be specified."); |
| } |
| |
| // ensure the same id is being used |
| final ProcessorDTO requestProcessorDTO = requestProcessorEntity.getComponent(); |
| if (!id.equals(requestProcessorDTO.getId())) { |
| throw new IllegalArgumentException(String.format("The processor id (%s) in the request body does " |
| + "not equal the processor id of the requested resource (%s).", requestProcessorDTO.getId(), id)); |
| } |
| |
| final PositionDTO proposedPosition = requestProcessorDTO.getPosition(); |
| if (proposedPosition != null) { |
| if (proposedPosition.getX() == null || proposedPosition.getY() == null) { |
| throw new IllegalArgumentException("The x and y coordinate of the proposed position must be specified."); |
| } |
| } |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.PUT, requestProcessorEntity); |
| } else if (isDisconnectedFromCluster()) { |
| verifyDisconnectedNodeModification(requestProcessorEntity.isDisconnectedNodeAcknowledged()); |
| } |
| |
| // handle expects request (usually from the cluster manager) |
| final Revision requestRevision = getRevision(requestProcessorEntity, id); |
| return withWriteLock( |
| serviceFacade, |
| requestProcessorEntity, |
| requestRevision, |
| lookup -> { |
| final NiFiUser user = NiFiUserUtils.getNiFiUser(); |
| |
| final ComponentAuthorizable authorizable = lookup.getProcessor(id); |
| authorizable.getAuthorizable().authorize(authorizer, RequestAction.WRITE, user); |
| |
| final ProcessorConfigDTO config = requestProcessorDTO.getConfig(); |
| if (config != null) { |
| AuthorizeControllerServiceReference.authorizeControllerServiceReferences(config.getProperties(), authorizable, authorizer, lookup); |
| AuthorizeParameterReference.authorizeParameterReferences(config.getProperties(), authorizer, authorizable.getParameterContext(), user); |
| } |
| }, |
| () -> serviceFacade.verifyUpdateProcessor(requestProcessorDTO), |
| (revision, processorEntity) -> { |
| final ProcessorDTO processorDTO = processorEntity.getComponent(); |
| |
| // update the processor |
| final ProcessorEntity entity = serviceFacade.updateProcessor(revision, processorDTO); |
| populateRemainingProcessorEntityContent(entity); |
| |
| return generateOkResponse(entity).build(); |
| } |
| ); |
| } |
| |
| /** |
| * Removes the specified processor. |
| * |
| * @param httpServletRequest request |
| * @param version The revision is used to verify the client is working with the latest version of the flow. |
| * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response. |
| * @param id The id of the processor to remove. |
| * @return A processorEntity. |
| * @throws InterruptedException if interrupted |
| */ |
| @DELETE |
| @Consumes(MediaType.WILDCARD) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}") |
| @ApiOperation( |
| value = "Deletes a processor", |
| response = ProcessorEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /processors/{uuid}"), |
| @Authorization(value = "Write - Parent Process Group - /process-groups/{uuid}"), |
| @Authorization(value = "Read - any referenced Controller Services - /controller-services/{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 deleteProcessor( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The revision is used to verify the client is working with the latest version of the flow.", |
| required = false |
| ) |
| @QueryParam(VERSION) final 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.", |
| required = false |
| ) |
| @QueryParam(CLIENT_ID) @DefaultValue(StringUtils.EMPTY) final ClientIdParameter clientId, |
| @ApiParam( |
| value = "Acknowledges that this node is disconnected to allow for mutable requests to proceed.", |
| required = false |
| ) |
| @QueryParam(DISCONNECTED_NODE_ACKNOWLEDGED) @DefaultValue("false") final Boolean disconnectedNodeAcknowledged, |
| @ApiParam( |
| value = "The processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id) throws InterruptedException { |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.DELETE); |
| } else if (isDisconnectedFromCluster()) { |
| verifyDisconnectedNodeModification(disconnectedNodeAcknowledged); |
| } |
| |
| final ProcessorEntity requestProcessorEntity = new ProcessorEntity(); |
| requestProcessorEntity.setId(id); |
| |
| final Revision requestRevision = new Revision(version == null ? null : version.getLong(), clientId.getClientId(), id); |
| return withWriteLock( |
| serviceFacade, |
| requestProcessorEntity, |
| requestRevision, |
| lookup -> { |
| final ComponentAuthorizable processor = lookup.getProcessor(id); |
| |
| // ensure write permission to the processor |
| processor.getAuthorizable().authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| |
| // ensure write permission to the parent process group |
| processor.getAuthorizable().getParentAuthorizable().authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); |
| |
| // verify any referenced services |
| AuthorizeControllerServiceReference.authorizeControllerServiceReferences(processor, authorizer, lookup, false); |
| }, |
| () -> serviceFacade.verifyDeleteProcessor(id), |
| (revision, processorEntity) -> { |
| // delete the processor |
| final ProcessorEntity entity = serviceFacade.deleteProcessor(revision, processorEntity.getId()); |
| |
| // generate the response |
| return generateOkResponse(entity).build(); |
| } |
| ); |
| } |
| |
| /** |
| * Updates the operational status for the specified processor with the specified values. |
| * |
| * @param httpServletRequest request |
| * @param id The id of the processor to update. |
| * @param requestRunStatus A processorEntity. |
| * @return A processorEntity. |
| */ |
| @PUT |
| @Consumes(MediaType.APPLICATION_JSON) |
| @Produces(MediaType.APPLICATION_JSON) |
| @Path("/{id}/run-status") |
| @ApiOperation( |
| value = "Updates run status of a processor", |
| response = ProcessorEntity.class, |
| authorizations = { |
| @Authorization(value = "Write - /processors/{uuid} or /operation/processors/{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 updateRunStatus( |
| @Context final HttpServletRequest httpServletRequest, |
| @ApiParam( |
| value = "The processor id.", |
| required = true |
| ) |
| @PathParam("id") final String id, |
| @ApiParam( |
| value = "The processor run status.", |
| required = true |
| ) final ProcessorRunStatusEntity requestRunStatus) { |
| |
| if (requestRunStatus == null) { |
| throw new IllegalArgumentException("Processor run status must be specified."); |
| } |
| |
| if (requestRunStatus.getRevision() == null) { |
| throw new IllegalArgumentException("Revision must be specified."); |
| } |
| |
| requestRunStatus.validateState(); |
| |
| if (isReplicateRequest()) { |
| return replicate(HttpMethod.PUT, requestRunStatus); |
| } else if (isDisconnectedFromCluster()) { |
| verifyDisconnectedNodeModification(requestRunStatus.isDisconnectedNodeAcknowledged()); |
| } |
| |
| // handle expects request (usually from the cluster manager) |
| final Revision requestRevision = getRevision(requestRunStatus.getRevision(), id); |
| return withWriteLock( |
| serviceFacade, |
| requestRunStatus, |
| requestRevision, |
| lookup -> { |
| final NiFiUser user = NiFiUserUtils.getNiFiUser(); |
| |
| final Authorizable authorizable = lookup.getProcessor(id).getAuthorizable(); |
| OperationAuthorizable.authorizeOperation(authorizable, authorizer, user); |
| }, |
| () -> serviceFacade.verifyUpdateProcessor(createDTOWithDesiredRunStatus(id, requestRunStatus.getState())), |
| (revision, runStatusEntity) -> { |
| // update the processor |
| final ProcessorEntity entity = serviceFacade.updateProcessor(revision, createDTOWithDesiredRunStatus(id, runStatusEntity.getState())); |
| populateRemainingProcessorEntityContent(entity); |
| |
| return generateOkResponse(entity).build(); |
| } |
| ); |
| } |
| |
| private ProcessorDTO createDTOWithDesiredRunStatus(final String id, final String runStatus) { |
| final ProcessorDTO dto = new ProcessorDTO(); |
| dto.setId(id); |
| dto.setState(runStatus); |
| return dto; |
| } |
| |
| public Response performAsyncConfigVerification(final VerifyProcessorConfigRequestEntity processorConfigRequest, final NiFiUser user) { |
| // Create an asynchronous request that will occur in the background, because this request may take an indeterminate amount of time. |
| final String requestId = generateUuid(); |
| logger.debug("Generated Config Verification Request with ID {} for Processor {}", requestId, processorConfigRequest.getRequest().getProcessorId()); |
| |
| final VerifyProcessorConfigRequestDTO requestDto = processorConfigRequest.getRequest(); |
| final String processorId = requestDto.getProcessorId(); |
| final List<UpdateStep> updateSteps = Collections.singletonList(new StandardUpdateStep("Verify Processor Configuration")); |
| |
| final AsynchronousWebRequest<VerifyProcessorConfigRequestEntity, List<ConfigVerificationResultDTO>> request = |
| new StandardAsynchronousWebRequest<>(requestId, processorConfigRequest, processorId, user, updateSteps); |
| |
| // Submit the request to be performed in the background |
| final Consumer<AsynchronousWebRequest<VerifyProcessorConfigRequestEntity, List<ConfigVerificationResultDTO>>> updateTask = asyncRequest -> { |
| try { |
| final Map<String, String> attributes = requestDto.getAttributes() == null ? Collections.emptyMap() : requestDto.getAttributes(); |
| final List<ConfigVerificationResultDTO> results = serviceFacade.verifyProcessorConfiguration(processorId, requestDto.getProcessorConfig(), attributes); |
| asyncRequest.markStepComplete(results); |
| } catch (final Exception e) { |
| logger.error("Failed to verify Processor configuration", e); |
| asyncRequest.fail("Failed to verify Processor configuration due to " + e); |
| } |
| }; |
| |
| updateRequestManager.submitRequest(VERIFICATION_REQUEST_TYPE, requestId, request, updateTask); |
| |
| // Generate the response |
| final VerifyProcessorConfigRequestEntity resultsEntity = createVerifyProcessorConfigRequestEntity(request, requestId); |
| return generateOkResponse(resultsEntity).build(); |
| } |
| |
| private VerifyProcessorConfigRequestEntity createVerifyProcessorConfigRequestEntity( |
| final AsynchronousWebRequest<VerifyProcessorConfigRequestEntity, List<ConfigVerificationResultDTO>> asyncRequest, |
| final String requestId) { |
| final VerifyProcessorConfigRequestDTO requestDto = asyncRequest.getRequest().getRequest(); |
| final List<ConfigVerificationResultDTO> resultsList = asyncRequest.getResults(); |
| |
| final VerifyProcessorConfigRequestDTO dto = new VerifyProcessorConfigRequestDTO(); |
| dto.setProcessorId(requestDto.getProcessorId()); |
| dto.setProcessorConfig(requestDto.getProcessorConfig()); |
| dto.setResults(resultsList); |
| |
| dto.setComplete(resultsList != null); |
| dto.setFailureReason(asyncRequest.getFailureReason()); |
| dto.setLastUpdated(asyncRequest.getLastUpdated()); |
| dto.setPercentCompleted(asyncRequest.getPercentComplete()); |
| dto.setRequestId(requestId); |
| dto.setState(asyncRequest.getState()); |
| dto.setUri(generateResourceUri("processors", requestDto.getProcessorId(), "config", "verification-requests", requestId)); |
| |
| final VerifyProcessorConfigRequestEntity entity = new VerifyProcessorConfigRequestEntity(); |
| entity.setRequest(dto); |
| return entity; |
| } |
| |
| // setters |
| |
| public void setServiceFacade(NiFiServiceFacade serviceFacade) { |
| this.serviceFacade = serviceFacade; |
| } |
| |
| public void setAuthorizer(Authorizer authorizer) { |
| this.authorizer = authorizer; |
| } |
| } |
