Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-2237: 

- Updating Rest Endpoint documentation specifically regarding access policies.
- Ensuring the resource listing is accurate.
- Removing unnecessary code.
This commit is contained in:
Matt Gilman 2016-08-02 11:35:44 -04:00
parent fca59ff9d0
commit 9338f102cb
29 changed files with 2453 additions and 2968 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

210
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-authorization/src/main/java/org/apache/nifi/authorization/resource/ResourceFactory.java
View File

@ -34,30 +34,6 @@ public final class ResourceFactory {
} }
}; };
private final static Resource CONTROLLER_SERVICE_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.ControllerService.getValue();
}
@Override
public String getName() {
return "Controller Service";
}
};
private final static Resource FUNNEL_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.Funnel.getValue();
}
@Override
public String getName() {
return "Funnel";
}
};
private final static Resource FLOW_RESOURCE = new Resource() { private final static Resource FLOW_RESOURCE = new Resource() {
@Override @Override
public String getIdentifier() { public String getIdentifier() {
@ -70,42 +46,6 @@ public final class ResourceFactory {
} }
}; };
private final static Resource INPUT_PORT_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.InputPort.getValue();
}
@Override
public String getName() {
return "Input Port";
}
};
private final static Resource LABEL_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.Label.getValue();
}
@Override
public String getName() {
return "Label";
}
};
private final static Resource OUTPUT_PORT_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.OutputPort.getValue();
}
@Override
public String getName() {
return "Output Port";
}
};
private final static Resource POLICY_RESOURCE = new Resource() { private final static Resource POLICY_RESOURCE = new Resource() {
@Override @Override
public String getIdentifier() { public String getIdentifier() {
@ -118,30 +58,6 @@ public final class ResourceFactory {
} }
}; };
private final static Resource PROCESSOR_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.Processor.getValue();
}
@Override
public String getName() {
return "Processor";
}
};
private final static Resource PROCESS_GROUP_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.ProcessGroup.getValue();
}
@Override
public String getName() {
return "Process Group";
}
};
private final static Resource COUNTERS_RESOURCE = new Resource() { private final static Resource COUNTERS_RESOURCE = new Resource() {
@Override @Override
public String getIdentifier() { public String getIdentifier() {
@ -190,30 +106,6 @@ public final class ResourceFactory {
} }
}; };
private final static Resource REMOTE_PROCESS_GROUP_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.RemoteProcessGroup.getValue();
}
@Override
public String getName() {
return "Remote Process Group";
}
};
private final static Resource REPORTING_TASK_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.ReportingTask.getValue();
}
@Override
public String getName() {
return "Reporting Task";
}
};
private final static Resource RESOURCE_RESOURCE = new Resource() { private final static Resource RESOURCE_RESOURCE = new Resource() {
@Override @Override
public String getIdentifier() { public String getIdentifier() {
@ -250,18 +142,6 @@ public final class ResourceFactory {
} }
}; };
private final static Resource TEMPLATE_RESOURCE = new Resource() {
@Override
public String getIdentifier() {
return ResourceType.Template.getValue();
}
@Override
public String getName() {
return "Template";
}
};
private final static Resource TENANT_RESOURCE = new Resource() { private final static Resource TENANT_RESOURCE = new Resource() {
@Override @Override
public String getIdentifier() { public String getIdentifier() {
@ -296,24 +176,6 @@ public final class ResourceFactory {
return CONTROLLER_RESOURCE; return CONTROLLER_RESOURCE;
} }
/**
* Gets the Resource for accessing Controller Services.
*
* @return The resource for accessing Controller Services
*/
public static Resource getControllerServiceResource() {
return CONTROLLER_SERVICE_RESOURCE;
}
/**
* Gets the Resource for accessing Funnels.
*
* @return The resource for accessing Funnels.
*/
public static Resource getFunnelResource() {
return FUNNEL_RESOURCE;
}
/** /**
* Gets the Resource for accessing the NiFi flow. This includes the data flow structure, component status, search results, and banner/about text. * Gets the Resource for accessing the NiFi flow. This includes the data flow structure, component status, search results, and banner/about text.
* *
@ -323,51 +185,6 @@ public final class ResourceFactory {
return FLOW_RESOURCE; return FLOW_RESOURCE;
} }
/**
* Gets the Resource for accessing Input Ports.
*
* @return The resource for accessing Input Ports
*/
public static Resource getInputPortResource() {
return INPUT_PORT_RESOURCE;
}
/**
* Gets the Resource for accessing Labels.
*
* @return The resource for accessing Labels
*/
public static Resource getLabelResource() {
return LABEL_RESOURCE;
}
/**
* Gets the Resource for accessing Output Ports.
*
* @return The resource for accessing Output Ports
*/
public static Resource getOutputPortResource() {
return OUTPUT_PORT_RESOURCE;
}
/**
* Gets the Resource for accessing Processors.
*
* @return The resource for accessing Processors
*/
public static Resource getProcessorResource() {
return PROCESSOR_RESOURCE;
}
/**
* Gets the Resource for accessing Process Groups.
*
* @return The resource for accessing Process Groups
*/
public static Resource getProcessGroupResource() {
return PROCESS_GROUP_RESOURCE;
}
/** /**
* Gets the Resource for accessing the Counters.. * Gets the Resource for accessing the Counters..
* *
@ -396,24 +213,6 @@ public final class ResourceFactory {
return PROXY_RESOURCE; return PROXY_RESOURCE;
} }
/**
* Gets the Resource for accessing Remote Process Groups.
*
* @return The resource accessing Remote Process Groups
*/
public static Resource getRemoteProcessGroupResource() {
return REMOTE_PROCESS_GROUP_RESOURCE;
}
/**
* Gets the Resource for accessing Reporting Tasks.
*
* @return The resource for accessing Reporting Tasks
*/
public static Resource getReportingTaskResource() {
return REPORTING_TASK_RESOURCE;
}
/** /**
* Gets the Resource for detailing all available NiFi Resources. * Gets the Resource for detailing all available NiFi Resources.
* *
@ -442,15 +241,6 @@ public final class ResourceFactory {
return SYSTEM_RESOURCE; return SYSTEM_RESOURCE;
} }
/**
* Gets the Resource for accessing Templates.
*
* @return The Resource for accessing Tempaltes
*/
public static Resource getTemplateResource() {
return TEMPLATE_RESOURCE;
}
/** /**
* Gets the Resource for accessing Tenants which includes creating, modifying, and deleting Users and UserGroups. * Gets the Resource for accessing Tenants which includes creating, modifying, and deleting Users and UserGroups.
* *

28
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/AccessPolicyResource.java
View File

@ -102,14 +102,18 @@ public class AccessPolicyResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{action}/{resource: .+}") @Path("{action}/{resource: .+}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets an access policy", value = "Gets an access policy for the specified action and resource",
notes = "Will return the effective policy if no component specific policy exists for the specified action and resource. "
+ "Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is "
+ "returned will be indicated in the response. This means the client could be authorized to get the policy for a "
+ "given component but the effective policy may be inherited from an ancestor Process Group. If the client does not "
+ "have permissions to that policy, the response will not include the policy and the permissions in the response "
+ "will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource "
+ "a 403 response will be returned.",
response = AccessPolicyEntity.class, response = AccessPolicyEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /policies/{resource}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -172,12 +176,11 @@ public class AccessPolicyResource extends ApplicationResource {
@POST @POST
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates an access policy", value = "Creates an access policy",
response = AccessPolicyEntity.class, response = AccessPolicyEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /policies/{resource}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -263,14 +266,11 @@ public class AccessPolicyResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets an access policy", value = "Gets an access policy",
response = AccessPolicyEntity.class, response = AccessPolicyEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /policies/{resource}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -323,12 +323,11 @@ public class AccessPolicyResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a access policy", value = "Updates a access policy",
response = AccessPolicyEntity.class, response = AccessPolicyEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /policies/{resource}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -412,12 +411,11 @@ public class AccessPolicyResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes an access policy", value = "Deletes an access policy",
response = AccessPolicyEntity.class, response = AccessPolicyEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /policies/{resource}", type = "")
} }
) )
@ApiResponses( @ApiResponses(

40
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/AccessResource.java
View File

@ -29,13 +29,6 @@ import org.apache.nifi.authentication.LoginIdentityProvider;
import org.apache.nifi.authentication.exception.IdentityAccessException; import org.apache.nifi.authentication.exception.IdentityAccessException;
import org.apache.nifi.authentication.exception.InvalidLoginCredentialsException; import org.apache.nifi.authentication.exception.InvalidLoginCredentialsException;
import org.apache.nifi.authorization.AccessDeniedException; import org.apache.nifi.authorization.AccessDeniedException;
import org.apache.nifi.authorization.AuthorizationRequest;
import org.apache.nifi.authorization.AuthorizationResult;
import org.apache.nifi.authorization.AuthorizationResult.Result;
import org.apache.nifi.authorization.Authorizer;
import org.apache.nifi.authorization.RequestAction;
import org.apache.nifi.authorization.UserContextKeys;
import org.apache.nifi.authorization.resource.ResourceFactory;
import org.apache.nifi.authorization.user.NiFiUser; import org.apache.nifi.authorization.user.NiFiUser;
import org.apache.nifi.authorization.user.NiFiUserDetails; import org.apache.nifi.authorization.user.NiFiUserDetails;
import org.apache.nifi.authorization.user.NiFiUserUtils; import org.apache.nifi.authorization.user.NiFiUserUtils;
@ -78,8 +71,6 @@ import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;
import java.net.URI; import java.net.URI;
import java.security.cert.X509Certificate; import java.security.cert.X509Certificate;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
/** /**
@ -105,33 +96,6 @@ public class AccessResource extends ApplicationResource {
private KerberosService kerberosService; private KerberosService kerberosService;
private Authorizer authorizer;
/**
* Authorizes access to the flow.
*/
private boolean hasFlowAccess(final NiFiUser user) {
final Map<String,String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
} else {
userContext = null;
}
final AuthorizationRequest request = new AuthorizationRequest.Builder()
.resource(ResourceFactory.getFlowResource())
.identity(user.getIdentity())
.anonymous(user.isAnonymous())
.accessAttempt(true)
.action(RequestAction.READ)
.userContext(userContext)
.build();
final AuthorizationResult result = authorizer.authorize(request);
return Result.Approved.equals(result.getResult());
}
/** /**
* Retrieves the access configuration for this NiFi. * Retrieves the access configuration for this NiFi.
* *
@ -173,6 +137,7 @@ public class AccessResource extends ApplicationResource {
@Path("") @Path("")
@ApiOperation( @ApiOperation(
value = "Gets the status the client's access", value = "Gets the status the client's access",
notes = NON_GUARANTEED_ENDPOINT,
response = AccessStatusEntity.class response = AccessStatusEntity.class
) )
@ApiResponses( @ApiResponses(
@ -507,9 +472,6 @@ public class AccessResource extends ApplicationResource {
} }
// setters // setters
public void setAuthorizer(Authorizer authorizer) {
this.authorizer = authorizer;
}
public void setLoginIdentityProvider(LoginIdentityProvider loginIdentityProvider) { public void setLoginIdentityProvider(LoginIdentityProvider loginIdentityProvider) {
this.loginIdentityProvider = loginIdentityProvider; this.loginIdentityProvider = loginIdentityProvider;

6
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ApplicationResource.java
View File

@ -95,6 +95,8 @@ public abstract class ApplicationResource {
public static final String PROXY_PORT_HTTP_HEADER = "X-ProxyPort"; public static final String PROXY_PORT_HTTP_HEADER = "X-ProxyPort";
public static final String PROXY_CONTEXT_PATH_HTTP_HEADER = "X-ProxyContextPath"; public static final String PROXY_CONTEXT_PATH_HTTP_HEADER = "X-ProxyContextPath";
protected static final String NON_GUARANTEED_ENDPOINT = "Note: This endpoint is subject to change as the NiFi and it's REST API evolve.";
private static final Logger logger = LoggerFactory.getLogger(ApplicationResource.class); private static final Logger logger = LoggerFactory.getLogger(ApplicationResource.class);
public static final String NODEWISE = "false"; public static final String NODEWISE = "false";
@ -686,9 +688,7 @@ public abstract class ApplicationResource {
* @param method the HTTP method to use * @param method the HTTP method to use
* @param entity the entity to replicate * @param entity the entity to replicate
* @param headersToOverride the headers to override * @param headersToOverride the headers to override
*
* @return the response from the request * @return the response from the request
*
* @throws InterruptedException if interrupted while replicating the request * @throws InterruptedException if interrupted while replicating the request
* @see #replicate(String, Object, Map) * @see #replicate(String, Object, Map)
*/ */
@ -851,7 +851,7 @@ public abstract class ApplicationResource {
} }
public Response handshakeExceptionResponse(HandshakeException e) { public Response handshakeExceptionResponse(HandshakeException e) {
if(logger.isDebugEnabled()){ if (logger.isDebugEnabled()) {
logger.debug("Handshake failed, {}", e.getMessage()); logger.debug("Handshake failed, {}", e.getMessage());
} }
ResponseCode handshakeRes = e.getResponseCode(); ResponseCode handshakeRes = e.getResponseCode();

50
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ConnectionResource.java
View File

@ -32,8 +32,6 @@ import org.apache.nifi.connectable.Connectable;
import org.apache.nifi.web.NiFiServiceFacade; import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.Revision; import org.apache.nifi.web.Revision;
import org.apache.nifi.web.api.dto.ConnectionDTO; import org.apache.nifi.web.api.dto.ConnectionDTO;
import org.apache.nifi.web.api.dto.FlowFileSummaryDTO;
import org.apache.nifi.web.api.dto.ListingRequestDTO;
import org.apache.nifi.web.api.entity.ConnectionEntity; import org.apache.nifi.web.api.entity.ConnectionEntity;
import org.apache.nifi.web.api.request.ClientIdParameter; import org.apache.nifi.web.api.request.ClientIdParameter;
import org.apache.nifi.web.api.request.LongParameter; import org.apache.nifi.web.api.request.LongParameter;
@ -91,38 +89,6 @@ public class ConnectionResource extends ApplicationResource {
return connectionEntity; return connectionEntity;
} }
/**
* Populate the URIs for the specified flowfile listing.
*
* @param connectionId connection
* @param flowFileListing flowfile listing
* @return dto
*/
public ListingRequestDTO populateRemainingFlowFileListingContent(final String connectionId, final ListingRequestDTO flowFileListing) {
// uri of the listing
flowFileListing.setUri(generateResourceUri("connections", connectionId, "listing-requests", flowFileListing.getId()));
// uri of each flowfile
if (flowFileListing.getFlowFileSummaries() != null) {
for (final FlowFileSummaryDTO flowFile : flowFileListing.getFlowFileSummaries()) {
populateRemainingFlowFileContent(connectionId, flowFile);
}
}
return flowFileListing;
}
/**
* Populate the URIs for the specified flowfile.
*
* @param connectionId the connection id
* @param flowFile the flowfile
* @return the dto
*/
public FlowFileSummaryDTO populateRemainingFlowFileContent(final String connectionId, final FlowFileSummaryDTO flowFile) {
flowFile.setUri(generateResourceUri("connections", connectionId, "flowfiles", flowFile.getUuid()));
return flowFile;
}
/** /**
* Retrieves the specified connection. * Retrieves the specified connection.
* *
@ -134,14 +100,12 @@ public class ConnectionResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}") @Path("/{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a connection", value = "Gets a connection",
response = ConnectionEntity.class, response = ConnectionEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read Source - /{component-type}/{uuid}", type = ""),
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"), @Authorization(value = "Read Destination - /{component-type}/{uuid}", type = "")
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -192,12 +156,14 @@ public class ConnectionResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}") @Path("/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a connection", value = "Updates a connection",
response = ConnectionEntity.class, response = ConnectionEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write Source - /{component-type}/{uuid}", type = ""),
@Authorization(value = "Write Destination - /{component-type}/{uuid}", type = ""),
@Authorization(value = "Write New Destination - /{component-type}/{uuid} - if updating Destination", type = ""),
@Authorization(value = "Write Process Group - /process-groups/{uuid} - if updating Destination", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -289,12 +255,12 @@ public class ConnectionResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}") @Path("/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a connection", value = "Deletes a connection",
response = ConnectionEntity.class, response = ConnectionEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write Source - /{component-type}/{uuid}", type = ""),
@Authorization(value = "Write Destination - /{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(

85
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerResource.java
View File

@ -16,25 +16,13 @@
*/ */
package org.apache.nifi.web.api; package org.apache.nifi.web.api;
import java.net.URI; import com.sun.jersey.api.core.ResourceContext;
import java.util.HashMap; import com.wordnik.swagger.annotations.Api;
import java.util.Map; import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiParam;
import javax.servlet.http.HttpServletRequest; import com.wordnik.swagger.annotations.ApiResponse;
import javax.ws.rs.Consumes; import com.wordnik.swagger.annotations.ApiResponses;
import javax.ws.rs.DELETE; import com.wordnik.swagger.annotations.Authorization;
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 org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.nifi.authorization.AccessDeniedException; import org.apache.nifi.authorization.AccessDeniedException;
import org.apache.nifi.authorization.AuthorizationRequest; import org.apache.nifi.authorization.AuthorizationRequest;
@ -60,13 +48,23 @@ import org.apache.nifi.web.api.entity.NodeEntity;
import org.apache.nifi.web.api.entity.ReportingTaskEntity; import org.apache.nifi.web.api.entity.ReportingTaskEntity;
import org.apache.nifi.web.api.request.DateTimeParameter; import org.apache.nifi.web.api.request.DateTimeParameter;
import com.sun.jersey.api.core.ResourceContext; import javax.servlet.http.HttpServletRequest;
import com.wordnik.swagger.annotations.Api; import javax.ws.rs.Consumes;
import com.wordnik.swagger.annotations.ApiOperation; import javax.ws.rs.DELETE;
import com.wordnik.swagger.annotations.ApiParam; import javax.ws.rs.GET;
import com.wordnik.swagger.annotations.ApiResponse; import javax.ws.rs.HttpMethod;
import com.wordnik.swagger.annotations.ApiResponses; import javax.ws.rs.POST;
import com.wordnik.swagger.annotations.Authorization; 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.net.URI;
import java.util.HashMap;
import java.util.Map;
/** /**
* RESTful endpoint for managing a Flow Controller. * RESTful endpoint for managing a Flow Controller.
@ -93,7 +91,7 @@ public class ControllerResource extends ApplicationResource {
private void authorizeController(final RequestAction action) { private void authorizeController(final RequestAction action) {
final NiFiUser user = NiFiUserUtils.getNiFiUser(); final NiFiUser user = NiFiUserUtils.getNiFiUser();
final Map<String,String> userContext; final Map<String, String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) { if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -126,15 +124,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("config") @Path("config")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN', 'ROLE_NIFI')")
@ApiOperation( @ApiOperation(
value = "Retrieves the configuration for this NiFi Controller", value = "Retrieves the configuration for this NiFi Controller",
response = ControllerConfigurationEntity.class, response = ControllerConfigurationEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /controller", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN"),
@Authorization(value = "ROLE_NIFI", type = "ROLE_NIFI")
} }
) )
@ApiResponses( @ApiResponses(
@ -168,12 +162,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("config") @Path("config")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Retrieves the configuration for this NiFi", value = "Retrieves the configuration for this NiFi",
response = ControllerConfigurationEntity.class, response = ControllerConfigurationEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -233,12 +226,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("reporting-tasks") @Path("reporting-tasks")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a new reporting task", value = "Creates a new reporting task",
response = ReportingTaskEntity.class, response = ReportingTaskEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -315,12 +307,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("controller-services") @Path("controller-services")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a new controller service", value = "Creates a new controller service",
response = ControllerServiceEntity.class, response = ControllerServiceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -395,15 +386,12 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("cluster") @Path("cluster")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the contents of the cluster", value = "Gets the contents of the cluster",
notes = "Returns the contents of the cluster including all nodes and their status.", notes = "Returns the contents of the cluster including all nodes and their status.",
response = ClusterEntity.class, response = ClusterEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /controller", type = "")
@Authorization(value = "DFM", type = "ROLE_DFM"),
@Authorization(value = "Admin", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -447,14 +435,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("cluster/nodes/{id}") @Path("cluster/nodes/{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a node in the cluster", value = "Gets a node in the cluster",
response = NodeEntity.class, response = NodeEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /controller", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -507,7 +492,7 @@ public class ControllerResource extends ApplicationResource {
value = "Updates a node in the cluster", value = "Updates a node in the cluster",
response = NodeEntity.class, response = NodeEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Administrator", type = "ROLE_ADMIN") @Authorization(value = "Write - /controller", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -573,12 +558,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("cluster/nodes/{id}") @Path("cluster/nodes/{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Removes a node from the cluster", value = "Removes a node from the cluster",
response = NodeEntity.class, response = NodeEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Administrator", type = "ROLE_ADMIN") @Authorization(value = "Write - /controller", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -631,12 +615,11 @@ public class ControllerResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("history") @Path("history")
// TODO - @PreAuthorize("hasRole('ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Purges history", value = "Purges history",
response = HistoryEntity.class, response = HistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Administrator", type = "ROLE_ADMIN") @Authorization(value = "Write - /controller", type = "")
} }
) )
@ApiResponses( @ApiResponses(

34
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ControllerServiceResource.java
View File

@ -148,14 +148,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a controller service", value = "Gets a controller service",
response = ControllerServiceEntity.class, response = ControllerServiceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /controller-services/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -202,14 +199,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/descriptors") @Path("{id}/descriptors")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a controller service property descriptor", value = "Gets a controller service property descriptor",
response = PropertyDescriptorEntity.class, response = PropertyDescriptorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /controller-services/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -269,12 +263,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/state") @Path("{id}/state")
// TODO - @PreAuthorize("hasAnyRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets the state for a controller service", value = "Gets the state for a controller service",
response = ComponentStateDTO.class, response = ComponentStateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller-services/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -325,12 +318,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/state/clear-requests") @Path("{id}/state/clear-requests")
// TODO - @PreAuthorize("hasAnyRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Clears the state for a controller service", value = "Clears the state for a controller service",
response = ComponentStateDTO.class, response = ComponentStateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller-services/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -358,8 +350,8 @@ public class ControllerServiceResource extends ApplicationResource {
if (validationPhase || !isTwoPhaseRequest(httpServletRequest)) { if (validationPhase || !isTwoPhaseRequest(httpServletRequest)) {
// authorize access // authorize access
serviceFacade.authorizeAccess(lookup -> { serviceFacade.authorizeAccess(lookup -> {
final Authorizable processor = lookup.getControllerService(id); final Authorizable controllerService = lookup.getControllerService(id);
processor.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); controllerService.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser());
}); });
} }
if (validationPhase) { if (validationPhase) {
@ -387,14 +379,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/references") @Path("{id}/references")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a controller service", value = "Gets a controller service",
response = ControllerServiceEntity.class, response = ControllerServiceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /controller-services/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -440,12 +429,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/references") @Path("{id}/references")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a controller services references", value = "Updates a controller services references",
response = ControllerServiceReferencingComponentsEntity.class, response = ControllerServiceReferencingComponentsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /{component-type}/{uuid} - For each referencing component specified", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -555,12 +543,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a controller service", value = "Updates a controller service",
response = ControllerServiceEntity.class, response = ControllerServiceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller-services/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -639,12 +626,11 @@ public class ControllerServiceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a controller service", value = "Deletes a controller service",
response = ControllerServiceEntity.class, response = ControllerServiceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /controller-services/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(

14
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/CountersResource.java
View File

@ -42,7 +42,6 @@ import org.apache.nifi.web.api.dto.CounterDTO;
import org.apache.nifi.web.api.dto.CountersDTO; import org.apache.nifi.web.api.dto.CountersDTO;
import org.apache.nifi.web.api.entity.CounterEntity; import org.apache.nifi.web.api.entity.CounterEntity;
import org.apache.nifi.web.api.entity.CountersEntity; import org.apache.nifi.web.api.entity.CountersEntity;
import org.apache.nifi.web.api.entity.Entity;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes; import javax.ws.rs.Consumes;
@ -85,7 +84,7 @@ public class CountersResource extends ApplicationResource {
private void authorizeCounters(final RequestAction action) { private void authorizeCounters(final RequestAction action) {
final NiFiUser user = NiFiUserUtils.getNiFiUser(); final NiFiUser user = NiFiUserUtils.getNiFiUser();
final Map<String,String> userContext; final Map<String, String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) { if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -119,14 +118,12 @@ public class CountersResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("") // necessary due to a bug in swagger @Path("") // necessary due to a bug in swagger
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the current counters for this NiFi", value = "Gets the current counters for this NiFi",
response = Entity.class, notes = NON_GUARANTEED_ENDPOINT,
response = CountersEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /counters", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -214,9 +211,10 @@ public class CountersResource extends ApplicationResource {
// TODO - @PreAuthorize("hasRole('ROLE_DFM')") // TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates the specified counter. This will reset the counter value to 0", value = "Updates the specified counter. This will reset the counter value to 0",
notes = NON_GUARANTEED_ENDPOINT,
response = CounterEntity.class, response = CounterEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /counters", type = "")
} }
) )
@ApiResponses( @ApiResponses(

68
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/DataTransferResource.java
View File

@ -119,7 +119,7 @@ public class DataTransferResource extends ApplicationResource {
/** /**
* Authorizes access to data transfers. * Authorizes access to data transfers.
* * <p>
* Note: Protected for testing purposes * Note: Protected for testing purposes
*/ */
protected void authorizeDataTransfer(final ResourceType resourceType, final String identifier) { protected void authorizeDataTransfer(final ResourceType resourceType, final String identifier) {
@ -129,7 +129,7 @@ public class DataTransferResource extends ApplicationResource {
throw new IllegalArgumentException("The resource must be an Input or Output Port."); throw new IllegalArgumentException("The resource must be an Input or Output Port.");
} }
final Map<String,String> userContext; final Map<String, String> userContext;
if (user.getClientAddress() != null && !user.getClientAddress().trim().isEmpty()) { if (user.getClientAddress() != null && !user.getClientAddress().trim().isEmpty()) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -137,7 +137,6 @@ public class DataTransferResource extends ApplicationResource {
userContext = null; userContext = null;
} }
// TODO - use DataTransferAuthorizable after looking up underlying component for consistentency
final Resource resource = ResourceFactory.getComponentResource(resourceType, identifier, identifier); final Resource resource = ResourceFactory.getComponentResource(resourceType, identifier, identifier);
final AuthorizationRequest request = new AuthorizationRequest.Builder() final AuthorizationRequest request = new AuthorizationRequest.Builder()
.resource(ResourceFactory.getDataTransferResource(resource)) .resource(ResourceFactory.getDataTransferResource(resource))
@ -158,14 +157,11 @@ public class DataTransferResource extends ApplicationResource {
@POST @POST
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{portType}/{portId}/transactions") @Path("{portType}/{portId}/transactions")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Create a transaction to the specified output port or input port", value = "Create a transaction to the specified output port or input port",
response = TransactionResultEntity.class, response = TransactionResultEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/{component-type}/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -192,7 +188,7 @@ public class DataTransferResource extends ApplicationResource {
InputStream inputStream) { InputStream inputStream) {
if(!PORT_TYPE_INPUT.equals(portType) && !PORT_TYPE_OUTPUT.equals(portType)){ if (!PORT_TYPE_INPUT.equals(portType) && !PORT_TYPE_OUTPUT.equals(portType)) {
return responseCreator.wrongPortTypeResponse(portType, portId); return responseCreator.wrongPortTypeResponse(portType, portId);
} }
@ -235,14 +231,11 @@ public class DataTransferResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_OCTET_STREAM) @Consumes(MediaType.APPLICATION_OCTET_STREAM)
@Produces(MediaType.TEXT_PLAIN) @Produces(MediaType.TEXT_PLAIN)
@Path("input-ports/{portId}/transactions/{transactionId}/flow-files") @Path("input-ports/{portId}/transactions/{transactionId}/flow-files")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Transfer flow files to the input port", value = "Transfer flow files to the input port",
response = String.class, response = String.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/input-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -301,7 +294,7 @@ public class DataTransferResource extends ApplicationResource {
return responseCreator.unexpectedErrorResponse(portId, e); return responseCreator.unexpectedErrorResponse(portId, e);
} }
String serverChecksum = ((HttpServerCommunicationsSession)peer.getCommunicationsSession()).getChecksum(); String serverChecksum = ((HttpServerCommunicationsSession) peer.getCommunicationsSession()).getChecksum();
return responseCreator.acceptedResponse(transactionManager, serverChecksum, transportProtocolVersion); return responseCreator.acceptedResponse(transactionManager, serverChecksum, transportProtocolVersion);
} }
@ -379,14 +372,11 @@ public class DataTransferResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_OCTET_STREAM) @Consumes(MediaType.APPLICATION_OCTET_STREAM)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("output-ports/{portId}/transactions/{transactionId}") @Path("output-ports/{portId}/transactions/{transactionId}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Commit or cancel the specified transaction", value = "Commit or cancel the specified transaction",
response = TransactionResultEntity.class, response = TransactionResultEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/output-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -445,12 +435,12 @@ public class DataTransferResource extends ApplicationResource {
String inputErrMessage = null; String inputErrMessage = null;
if (responseCode == null) { if (responseCode == null) {
inputErrMessage = "responseCode is required."; inputErrMessage = "responseCode is required.";
} else if(ResponseCode.CONFIRM_TRANSACTION.getCode() != responseCode } else if (ResponseCode.CONFIRM_TRANSACTION.getCode() != responseCode
&& ResponseCode.CANCEL_TRANSACTION.getCode() != responseCode) { && ResponseCode.CANCEL_TRANSACTION.getCode() != responseCode) {
inputErrMessage = "responseCode " + responseCode + " is invalid. "; inputErrMessage = "responseCode " + responseCode + " is invalid. ";
} }
if (inputErrMessage != null){ if (inputErrMessage != null) {
entity.setMessage(inputErrMessage); entity.setMessage(inputErrMessage);
entity.setResponseCode(ResponseCode.ABORT.getCode()); entity.setResponseCode(ResponseCode.ABORT.getCode());
return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); return Response.status(Response.Status.BAD_REQUEST).entity(entity).build();
@ -470,7 +460,7 @@ public class DataTransferResource extends ApplicationResource {
} catch (Exception e) { } catch (Exception e) {
HttpServerCommunicationsSession commsSession = (HttpServerCommunicationsSession) peer.getCommunicationsSession(); HttpServerCommunicationsSession commsSession = (HttpServerCommunicationsSession) peer.getCommunicationsSession();
logger.error("Failed to process the request", e); logger.error("Failed to process the request", e);
if(ResponseCode.BAD_CHECKSUM.equals(commsSession.getResponseCode())){ if (ResponseCode.BAD_CHECKSUM.equals(commsSession.getResponseCode())) {
entity.setResponseCode(commsSession.getResponseCode().getCode()); entity.setResponseCode(commsSession.getResponseCode().getCode());
entity.setMessage(e.getMessage()); entity.setMessage(e.getMessage());
@ -489,14 +479,11 @@ public class DataTransferResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_OCTET_STREAM) @Consumes(MediaType.APPLICATION_OCTET_STREAM)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("input-ports/{portId}/transactions/{transactionId}") @Path("input-ports/{portId}/transactions/{transactionId}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Commit or cancel the specified transaction", value = "Commit or cancel the specified transaction",
response = TransactionResultEntity.class, response = TransactionResultEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/input-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -552,13 +539,13 @@ public class DataTransferResource extends ApplicationResource {
String inputErrMessage = null; String inputErrMessage = null;
if (responseCode == null) { if (responseCode == null) {
inputErrMessage = "responseCode is required."; inputErrMessage = "responseCode is required.";
} else if(ResponseCode.BAD_CHECKSUM.getCode() != responseCode } else if (ResponseCode.BAD_CHECKSUM.getCode() != responseCode
&& ResponseCode.CONFIRM_TRANSACTION.getCode() != responseCode && ResponseCode.CONFIRM_TRANSACTION.getCode() != responseCode
&& ResponseCode.CANCEL_TRANSACTION.getCode() != responseCode) { && ResponseCode.CANCEL_TRANSACTION.getCode() != responseCode) {
inputErrMessage = "responseCode " + responseCode + " is invalid. "; inputErrMessage = "responseCode " + responseCode + " is invalid. ";
} }
if (inputErrMessage != null){ if (inputErrMessage != null) {
entity.setMessage(inputErrMessage); entity.setMessage(inputErrMessage);
entity.setResponseCode(ResponseCode.ABORT.getCode()); entity.setResponseCode(ResponseCode.ABORT.getCode());
return Response.status(Response.Status.BAD_REQUEST).entity(entity).build(); return Response.status(Response.Status.BAD_REQUEST).entity(entity).build();
@ -575,8 +562,8 @@ public class DataTransferResource extends ApplicationResource {
entity.setResponseCode(commsSession.getResponseCode().getCode()); entity.setResponseCode(commsSession.getResponseCode().getCode());
entity.setFlowFileSent(flowFileSent); entity.setFlowFileSent(flowFileSent);
} catch (IOException e){ } catch (IOException e) {
if (ResponseCode.BAD_CHECKSUM.getCode() == responseCode && e.getMessage().contains("Received a BadChecksum response")){ if (ResponseCode.BAD_CHECKSUM.getCode() == responseCode && e.getMessage().contains("Received a BadChecksum response")) {
// AbstractFlowFileServerProtocol throws IOException after it canceled transaction. // AbstractFlowFileServerProtocol throws IOException after it canceled transaction.
// This is a known behavior and if we return 500 with this exception, // This is a known behavior and if we return 500 with this exception,
// it's not clear if there is an issue at server side, or cancel operation has been accomplished. // it's not clear if there is an issue at server side, or cancel operation has been accomplished.
@ -610,14 +597,11 @@ public class DataTransferResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_OCTET_STREAM) @Produces(MediaType.APPLICATION_OCTET_STREAM)
@Path("output-ports/{portId}/transactions/{transactionId}/flow-files") @Path("output-ports/{portId}/transactions/{transactionId}/flow-files")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Transfer flow files from the output port", value = "Transfer flow files from the output port",
response = StreamingOutput.class, response = StreamingOutput.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/output-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -665,13 +649,13 @@ public class DataTransferResource extends ApplicationResource {
@Override @Override
public void write(OutputStream outputStream) throws IOException, WebApplicationException { public void write(OutputStream outputStream) throws IOException, WebApplicationException {
HttpOutput output = (HttpOutput)peer.getCommunicationsSession().getOutput(); HttpOutput output = (HttpOutput) peer.getCommunicationsSession().getOutput();
output.setOutputStream(outputStream); output.setOutputStream(outputStream);
try { try {
int numOfFlowFiles = serverProtocol.getPort().transferFlowFiles(peer, serverProtocol); int numOfFlowFiles = serverProtocol.getPort().transferFlowFiles(peer, serverProtocol);
logger.debug("finished transferring flow files, numOfFlowFiles={}", numOfFlowFiles); logger.debug("finished transferring flow files, numOfFlowFiles={}", numOfFlowFiles);
if(numOfFlowFiles < 1){ if (numOfFlowFiles < 1) {
// There was no flow file to transfer. Throw this exception to stop responding with SEE OTHER. // There was no flow file to transfer. Throw this exception to stop responding with SEE OTHER.
throw new WebApplicationException(Response.Status.OK); throw new WebApplicationException(Response.Status.OK);
} }
@ -697,14 +681,11 @@ public class DataTransferResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("input-ports/{portId}/transactions/{transactionId}") @Path("input-ports/{portId}/transactions/{transactionId}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Extend transaction TTL", value = "Extend transaction TTL",
response = TransactionResultEntity.class, response = TransactionResultEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/input-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -735,14 +716,11 @@ public class DataTransferResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("output-ports/{portId}/transactions/{transactionId}") @Path("output-ports/{portId}/transactions/{transactionId}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Extend transaction TTL", value = "Extend transaction TTL",
response = TransactionResultEntity.class, response = TransactionResultEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Write - /data-transfer/output-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -785,7 +763,7 @@ public class DataTransferResource extends ApplicationResource {
return validationResult.errResponse; return validationResult.errResponse;
} }
if(!PORT_TYPE_INPUT.equals(portType) && !PORT_TYPE_OUTPUT.equals(portType)){ if (!PORT_TYPE_INPUT.equals(portType) && !PORT_TYPE_OUTPUT.equals(portType)) {
return responseCreator.wrongPortTypeResponse(portType, portId); return responseCreator.wrongPortTypeResponse(portType, portId);
} }
@ -826,7 +804,7 @@ public class DataTransferResource extends ApplicationResource {
private ValidateRequestResult validateResult(HttpServletRequest req, String portId, String transactionId) { private ValidateRequestResult validateResult(HttpServletRequest req, String portId, String transactionId) {
ValidateRequestResult result = new ValidateRequestResult(); ValidateRequestResult result = new ValidateRequestResult();
if(!properties.isSiteToSiteHttpEnabled()) { if (!properties.isSiteToSiteHttpEnabled()) {
result.errResponse = responseCreator.httpSiteToSiteIsNotEnabledResponse(); result.errResponse = responseCreator.httpSiteToSiteIsNotEnabledResponse();
return result; return result;
} }
@ -838,7 +816,7 @@ public class DataTransferResource extends ApplicationResource {
return result; return result;
} }
if(!isEmpty(transactionId) && !transactionManager.isTransactionActive(transactionId)) { if (!isEmpty(transactionId) && !transactionManager.isTransactionActive(transactionId)) {
result.errResponse = responseCreator.transactionNotFoundResponse(portId, transactionId); result.errResponse = responseCreator.transactionNotFoundResponse(portId, transactionId);
return result; return result;
} }

24
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FlowFileQueueResource.java
View File

@ -122,11 +122,10 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/flowfiles/{flowfile-uuid}") @Path("{id}/flowfiles/{flowfile-uuid}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets a FlowFile from a Connection.", value = "Gets a FlowFile from a Connection.",
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Read Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -198,11 +197,10 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.WILDCARD) @Produces(MediaType.WILDCARD)
@Path("{id}/flowfiles/{flowfile-uuid}/content") @Path("{id}/flowfiles/{flowfile-uuid}/content")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets the content for a FlowFile in a Connection.", value = "Gets the content for a FlowFile in a Connection.",
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Read Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -294,12 +292,11 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/listing-requests") @Path("{id}/listing-requests")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Lists the contents of the queue in this connection.", value = "Lists the contents of the queue in this connection.",
response = ListingRequestEntity.class, response = ListingRequestEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Read Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -366,12 +363,11 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/listing-requests/{listing-request-id}") @Path("{id}/listing-requests/{listing-request-id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets the current status of a listing request for the specified connection.", value = "Gets the current status of a listing request for the specified connection.",
response = ListingRequestEntity.class, response = ListingRequestEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Read Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -429,12 +425,11 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/listing-requests/{listing-request-id}") @Path("{id}/listing-requests/{listing-request-id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Cancels and/or removes a request to list the contents of this connection.", value = "Cancels and/or removes a request to list the contents of this connection.",
response = DropRequestEntity.class, response = DropRequestEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Read Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -504,12 +499,11 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/drop-requests") @Path("{id}/drop-requests")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a request to drop the contents of the queue in this connection.", value = "Creates a request to drop the contents of the queue in this connection.",
response = DropRequestEntity.class, response = DropRequestEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -575,12 +569,11 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/drop-requests/{drop-request-id}") @Path("{id}/drop-requests/{drop-request-id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets the current status of a drop request for the specified connection.", value = "Gets the current status of a drop request for the specified connection.",
response = DropRequestEntity.class, response = DropRequestEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -638,12 +631,11 @@ public class FlowFileQueueResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/drop-requests/{drop-request-id}") @Path("{id}/drop-requests/{drop-request-id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Cancels and/or removes a request to drop the contents of this connection.", value = "Cancels and/or removes a request to drop the contents of this connection.",
response = DropRequestEntity.class, response = DropRequestEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write Source Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(

204
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FlowResource.java
View File

@ -103,7 +103,6 @@ import org.apache.nifi.web.api.entity.StatusHistoryEntity;
import org.apache.nifi.web.api.entity.TemplateEntity; import org.apache.nifi.web.api.entity.TemplateEntity;
import org.apache.nifi.web.api.entity.TemplatesEntity; import org.apache.nifi.web.api.entity.TemplatesEntity;
import org.apache.nifi.web.api.request.BulletinBoardPatternParameter; import org.apache.nifi.web.api.request.BulletinBoardPatternParameter;
import org.apache.nifi.web.api.request.ClientIdParameter;
import org.apache.nifi.web.api.request.DateTimeParameter; import org.apache.nifi.web.api.request.DateTimeParameter;
import org.apache.nifi.web.api.request.IntegerParameter; import org.apache.nifi.web.api.request.IntegerParameter;
import org.apache.nifi.web.api.request.LongParameter; import org.apache.nifi.web.api.request.LongParameter;
@ -212,7 +211,7 @@ public class FlowResource extends ApplicationResource {
private void authorizeFlow() { private void authorizeFlow() {
final NiFiUser user = NiFiUserUtils.getNiFiUser(); final NiFiUser user = NiFiUserUtils.getNiFiUser();
final Map<String,String> userContext; final Map<String, String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) { if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -249,9 +248,7 @@ public class FlowResource extends ApplicationResource {
value = "Generates a client id.", value = "Generates a client id.",
response = String.class, response = String.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -259,7 +256,6 @@ public class FlowResource extends ApplicationResource {
@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 = 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 = 401, message = "Client could not be authenticated."),
@ApiResponse(code = 403, message = "Client is not authorized to make this request."), @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.") @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.")
} }
) )
@ -277,15 +273,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("config") @Path("config")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN', 'ROLE_NIFI')")
@ApiOperation( @ApiOperation(
value = "Retrieves the configuration for this NiFi flow", value = "Retrieves the configuration for this NiFi flow",
response = FlowConfigurationEntity.class, response = FlowConfigurationEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN"),
@Authorization(value = "ROLE_NIFI", type = "ROLE_NIFI")
} }
) )
@ApiResponses( @ApiResponses(
@ -319,7 +311,10 @@ public class FlowResource extends ApplicationResource {
@Path("current-user") @Path("current-user")
@ApiOperation( @ApiOperation(
value = "Retrieves the user identity of the user making the request", value = "Retrieves the user identity of the user making the request",
response = CurrentUserEntity.class response = CurrentUserEntity.class,
authorizations = {
@Authorization(value = "Read - /flow", type = "")
}
) )
public Response getCurrentUser() { public Response getCurrentUser() {
@ -357,9 +352,7 @@ public class FlowResource extends ApplicationResource {
value = "Gets a process group", value = "Gets a process group",
response = ProcessGroupFlowEntity.class, response = ProcessGroupFlowEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -403,14 +396,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("controller/controller-services") @Path("controller/controller-services")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all controller services", value = "Gets all controller services",
response = ControllerServicesEntity.class, response = ControllerServicesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -451,14 +441,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("process-groups/{id}/controller-services") @Path("process-groups/{id}/controller-services")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all controller services", value = "Gets all controller services",
response = ControllerServicesEntity.class, response = ControllerServicesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -497,23 +484,17 @@ public class FlowResource extends ApplicationResource {
/** /**
* Retrieves all the of reporting tasks in this NiFi. * Retrieves all the of reporting tasks in this NiFi.
* *
* @param clientId Optional client id. If the client id is not specified, a
* new one will be generated. This value (whether specified or generated) is
* included in the response.
* @return A reportingTasksEntity. * @return A reportingTasksEntity.
*/ */
@GET @GET
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("reporting-tasks") @Path("reporting-tasks")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all reporting tasks", value = "Gets all reporting tasks",
response = ReportingTasksEntity.class, response = ReportingTasksEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -524,12 +505,7 @@ public class FlowResource extends ApplicationResource {
@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.") @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 getReportingTasks( public Response getReportingTasks() {
@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) ClientIdParameter clientId) {
authorizeFlow(); authorizeFlow();
@ -561,12 +537,13 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("process-groups/{id}") @Path("process-groups/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a process group", value = "Schedule or unschedule comopnents in the specified Process Group.",
notes = "",
response = ScheduleComponentsEntity.class, response = ScheduleComponentsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Read - /flow", type = ""),
@Authorization(value = "Write - /{component-type}/{uuid} - For every component being scheduled/unscheduled", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -587,8 +564,6 @@ public class FlowResource extends ApplicationResource {
@PathParam("id") String id, @PathParam("id") String id,
ScheduleComponentsEntity scheduleComponentsEntity) { ScheduleComponentsEntity scheduleComponentsEntity) {
authorizeFlow();
// ensure the same id is being used // ensure the same id is being used
if (!id.equals(scheduleComponentsEntity.getId())) { if (!id.equals(scheduleComponentsEntity.getId())) {
throw new IllegalArgumentException(String.format("The process group id (%s) in the request body does " throw new IllegalArgumentException(String.format("The process group id (%s) in the request body does "
@ -669,6 +644,9 @@ public class FlowResource extends ApplicationResource {
serviceFacade, serviceFacade,
revisions, revisions,
lookup -> { lookup -> {
// ensure access to the flow
authorizeFlow();
// ensure access to every component being scheduled // ensure access to every component being scheduled
componentsToSchedule.keySet().forEach(componentId -> { componentsToSchedule.keySet().forEach(componentId -> {
final Authorizable connectable = lookup.getConnectable(componentId); final Authorizable connectable = lookup.getConnectable(componentId);
@ -699,14 +677,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("search-results") @Path("search-results")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Performs a search against this NiFi using the specified search term", value = "Performs a search against this NiFi using the specified search term",
notes = "Only search results from authorized components will be returned.",
response = SearchResultsEntity.class, response = SearchResultsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -741,14 +717,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("status") @Path("status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the current status of this NiFi", value = "Gets the current status of this NiFi",
response = ControllerStatusEntity.class, response = ControllerStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -787,14 +760,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("cluster/summary") @Path("cluster/summary")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the current status of this NiFi", value = "Gets the current status of this NiFi",
response = ControllerStatusEntity.class, response = ControllerStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -846,14 +816,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("controller/bulletins") @Path("controller/bulletins")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves Controller level bulletins", value = "Retrieves Controller level bulletins",
response = ControllerBulletinsEntity.class, response = ControllerBulletinsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -886,14 +853,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("banners") @Path("banners")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves the banners for this NiFi", value = "Retrieves the banners for this NiFi",
response = BannerEntity.class, response = BannerEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -934,14 +898,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("processor-types") @Path("processor-types")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves the types of processors that this NiFi supports", value = "Retrieves the types of processors that this NiFi supports",
notes = NON_GUARANTEED_ENDPOINT,
response = ProcessorTypesEntity.class, response = ProcessorTypesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -974,14 +936,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("controller-service-types") @Path("controller-service-types")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves the types of controller services that this NiFi supports", value = "Retrieves the types of controller services that this NiFi supports",
notes = NON_GUARANTEED_ENDPOINT,
response = ControllerServiceTypesEntity.class, response = ControllerServiceTypesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -998,6 +958,7 @@ public class FlowResource extends ApplicationResource {
required = false required = false
) )
@QueryParam("serviceType") String serviceType) throws InterruptedException { @QueryParam("serviceType") String serviceType) throws InterruptedException {
authorizeFlow(); authorizeFlow();
// create response entity // create response entity
@ -1018,14 +979,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("reporting-task-types") @Path("reporting-task-types")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves the types of reporting tasks that this NiFi supports", value = "Retrieves the types of reporting tasks that this NiFi supports",
notes = NON_GUARANTEED_ENDPOINT,
response = ReportingTaskTypesEntity.class, response = ReportingTaskTypesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1057,14 +1016,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("prioritizers") @Path("prioritizers")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves the types of prioritizers that this NiFi supports", value = "Retrieves the types of prioritizers that this NiFi supports",
notes = NON_GUARANTEED_ENDPOINT,
response = PrioritizerTypesEntity.class, response = PrioritizerTypesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1095,14 +1052,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("about") @Path("about")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Retrieves details about this NiFi to put in the About dialog", value = "Retrieves details about this NiFi to put in the About dialog",
response = AboutEntity.class, response = AboutEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1118,7 +1072,7 @@ public class FlowResource extends ApplicationResource {
// create the about dto // create the about dto
final AboutDTO aboutDTO = new AboutDTO(); final AboutDTO aboutDTO = new AboutDTO();
aboutDTO.setTitle("NiFi"); // TODO - where to load title from aboutDTO.setTitle("NiFi");
aboutDTO.setVersion(getProperties().getUiTitle()); aboutDTO.setVersion(getProperties().getUiTitle());
aboutDTO.setUri(generateResourceUri()); aboutDTO.setUri(generateResourceUri());
@ -1154,14 +1108,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("bulletin-board") @Path("bulletin-board")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets current bulletins", value = "Gets current bulletins",
response = BulletinBoardEntity.class, response = BulletinBoardEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1259,14 +1210,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("processors/{id}/status") @Path("processors/{id}/status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status for a processor", value = "Gets status for a processor",
response = ProcessorStatusEntity.class, response = ProcessorStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1341,14 +1289,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("input-ports/{id}/status") @Path("input-ports/{id}/status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status for an input port", value = "Gets status for an input port",
response = PortStatusEntity.class, response = PortStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1423,14 +1368,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("output-ports/{id}/status") @Path("output-ports/{id}/status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status for an output port", value = "Gets status for an output port",
response = PortStatusEntity.class, response = PortStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1505,14 +1447,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("remote-process-groups/{id}/status") @Path("remote-process-groups/{id}/status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status for a remote process group", value = "Gets status for a remote process group",
response = ProcessorStatusEntity.class, response = ProcessorStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1588,17 +1527,13 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("process-groups/{id}/status") @Path("process-groups/{id}/status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN', 'ROLE_NIFI')")
@ApiOperation( @ApiOperation(
value = "Gets the status for a process group", value = "Gets the status for a process group",
notes = "The status for a process group includes status for all descendent components. When invoked on the root group with " notes = "The status for a process group includes status for all descendent components. When invoked on the root group with "
+ "recursive set to true, it will return the current status of every component in the flow.", + "recursive set to true, it will return the current status of every component in the flow.",
response = ProcessGroupStatusEntity.class, response = ProcessGroupStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN"),
@Authorization(value = "NiFi", type = "ROLE_NIFI")
} }
) )
@ApiResponses( @ApiResponses(
@ -1699,14 +1634,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("connections/{id}/status") @Path("connections/{id}/status")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status for a connection", value = "Gets status for a connection",
response = ConnectionStatusEntity.class, response = ConnectionStatusEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1785,14 +1717,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("processors/{id}/status/history") @Path("processors/{id}/status/history")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status history for a processor", value = "Gets status history for a processor",
response = StatusHistoryEntity.class, response = StatusHistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1840,14 +1769,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("process-groups/{id}/status/history") @Path("process-groups/{id}/status/history")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets status history for a remote process group", value = "Gets status history for a remote process group",
response = StatusHistoryEntity.class, response = StatusHistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1895,14 +1821,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("remote-process-groups/{id}/status/history") @Path("remote-process-groups/{id}/status/history")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the status history", value = "Gets the status history",
response = StatusHistoryEntity.class, response = StatusHistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1950,14 +1873,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("connections/{id}/status/history") @Path("connections/{id}/status/history")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the status history for a connection", value = "Gets the status history for a connection",
response = StatusHistoryEntity.class, response = StatusHistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -2027,14 +1947,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("history") @Path("history")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets configuration history", value = "Gets configuration history",
notes = NON_GUARANTEED_ENDPOINT,
response = HistoryEntity.class, response = HistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -2166,15 +2084,13 @@ public class FlowResource extends ApplicationResource {
@GET @GET
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@Path("history/{id}") @Path("history/{id}")
@ApiOperation( @ApiOperation(
value = "Gets an action", value = "Gets an action",
notes = NON_GUARANTEED_ENDPOINT,
response = ActionEntity.class, response = ActionEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -2223,14 +2139,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("history/components/{componentId}") @Path("history/components/{componentId}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets configuration history for a processor", value = "Gets configuration history for a processor",
notes = NON_GUARANTEED_ENDPOINT,
response = ComponentHistoryEntity.class, response = ComponentHistoryEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -2274,14 +2188,11 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("templates") @Path("templates")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all templates", value = "Gets all templates",
response = TemplatesEntity.class, response = TemplatesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -2328,14 +2239,12 @@ public class FlowResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("cluster/search-results") @Path("cluster/search-results")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Searches the cluster for a node with the specified address", value = "Searches the cluster for a node with the specified address",
notes = NON_GUARANTEED_ENDPOINT,
response = ClusterSearchResultsEntity.class, response = ClusterSearchResultsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /flow", type = "")
@Authorization(value = "DFM", type = "ROLE_DFM"),
@Authorization(value = "Admin", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -2394,6 +2303,7 @@ public class FlowResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

12
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/FunnelResource.java
View File

@ -97,14 +97,11 @@ public class FunnelResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a funnel", value = "Gets a funnel",
response = FunnelEntity.class, response = FunnelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /funnels/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -152,12 +149,11 @@ public class FunnelResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a funnel", value = "Updates a funnel",
response = FunnelEntity.class, response = FunnelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /funnels/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -236,12 +232,11 @@ public class FunnelResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a funnel", value = "Deletes a funnel",
response = FunnelEntity.class, response = FunnelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /funnels/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -294,6 +289,7 @@ public class FunnelResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

12
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/InputPortResource.java
View File

@ -97,14 +97,11 @@ public class InputPortResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets an input port", value = "Gets an input port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /input-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -152,12 +149,11 @@ public class InputPortResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates an input port", value = "Updates an input port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /input-ports/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -233,12 +229,11 @@ public class InputPortResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes an input port", value = "Deletes an input port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /input-ports/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -291,6 +286,7 @@ public class InputPortResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

12
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/LabelResource.java
View File

@ -97,14 +97,11 @@ public class LabelResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a label", value = "Gets a label",
response = LabelEntity.class, response = LabelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /labels/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -152,12 +149,11 @@ public class LabelResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a label", value = "Updates a label",
response = LabelEntity.class, response = LabelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /labels/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -233,12 +229,11 @@ public class LabelResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a label", value = "Deletes a label",
response = LabelEntity.class, response = LabelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /labels/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -291,6 +286,7 @@ public class LabelResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

12
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/OutputPortResource.java
View File

@ -97,14 +97,11 @@ public class OutputPortResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets an output port", value = "Gets an output port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /output-ports/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -152,12 +149,11 @@ public class OutputPortResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates an output port", value = "Updates an output port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /output-ports/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -233,12 +229,11 @@ public class OutputPortResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes an output port", value = "Deletes an output port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /output-ports/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -291,6 +286,7 @@ public class OutputPortResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

129
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessGroupResource.java
View File

@ -179,14 +179,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a process group", value = "Gets a process group",
response = ProcessGroupEntity.class, response = ProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -238,12 +235,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a process group", value = "Updates a process group",
response = ProcessGroupEntity.class, response = ProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -319,12 +315,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a process group", value = "Deletes a process group",
response = ProcessGroupEntity.class, response = ProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -391,12 +386,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/process-groups") @Path("{id}/process-groups")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a process group", value = "Creates a process group",
response = ProcessGroupEntity.class, response = ProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -477,14 +471,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/process-groups") @Path("{id}/process-groups")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all process groups", value = "Gets all process groups",
response = ProcessorsEntity.class, response = ProcessorsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -547,12 +538,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/processors") @Path("{id}/processors")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a new processor", value = "Creates a new processor",
response = ProcessorEntity.class, response = ProcessorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "ROLE_DFM", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -638,14 +628,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/processors") @Path("{id}/processors")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all processors", value = "Gets all processors",
response = ProcessorsEntity.class, response = ProcessorsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -701,12 +688,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/input-ports") @Path("{id}/input-ports")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates an input port", value = "Creates an input port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -786,14 +772,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/input-ports") @Path("{id}/input-ports")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all input ports", value = "Gets all input ports",
response = InputPortsEntity.class, response = InputPortsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -848,12 +831,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/output-ports") @Path("{id}/output-ports")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates an output port", value = "Creates an output port",
response = PortEntity.class, response = PortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -933,14 +915,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/output-ports") @Path("{id}/output-ports")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all output ports", value = "Gets all output ports",
response = OutputPortsEntity.class, response = OutputPortsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -996,12 +975,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/funnels") @Path("{id}/funnels")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a funnel", value = "Creates a funnel",
response = FunnelEntity.class, response = FunnelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1081,14 +1059,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/funnels") @Path("{id}/funnels")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all funnels", value = "Gets all funnels",
response = FunnelsEntity.class, response = FunnelsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1144,12 +1119,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/labels") @Path("{id}/labels")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a label", value = "Creates a label",
response = LabelEntity.class, response = LabelEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1229,14 +1203,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/labels") @Path("{id}/labels")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all labels", value = "Gets all labels",
response = LabelsEntity.class, response = LabelsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1292,12 +1263,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/remote-process-groups") @Path("{id}/remote-process-groups")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a new process group", value = "Creates a new process group",
response = RemoteProcessGroupEntity.class, response = RemoteProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"), @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1408,14 +1378,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/remote-process-groups") @Path("{id}/remote-process-groups")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all remote process groups", value = "Gets all remote process groups",
response = RemoteProcessGroupsEntity.class, response = RemoteProcessGroupsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1478,12 +1445,13 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/connections") @Path("{id}/connections")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a connection", value = "Creates a connection",
response = ConnectionEntity.class, response = ConnectionEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = ""),
@Authorization(value = "Write Source - /{component-type}/{uuid}", type = ""),
@Authorization(value = "Write Destination - /{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1585,14 +1553,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/connections") @Path("{id}/connections")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all connections", value = "Gets all connections",
response = ConnectionsEntity.class, response = ConnectionsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -1639,7 +1604,7 @@ public class ProcessGroupResource extends ApplicationResource {
/** /**
* Copies the specified snippet within this ProcessGroup. The snippet instance that is instantiated cannot be referenced at a later time, therefore there is no * Copies the specified snippet within this ProcessGroup. The snippet instance that is instantiated cannot be referenced at a later time, therefore there is no
* corresponding URI. Instead the request URI is returned. * corresponding URI. Instead the request URI is returned.
* * <p>
* 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 httpServletRequest request
@ -1651,12 +1616,12 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/snippet-instance") @Path("{id}/snippet-instance")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Copies a snippet", value = "Copies a snippet",
response = FlowSnippetEntity.class, response = FlowSnippetEntity.class,
authorizations = { authorizations = {
@Authorization(value = "ROLE_DFM", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = ""),
@Authorization(value = "Read - /{component-type}/{uuid} - For each component in the snippet", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1731,7 +1696,7 @@ public class ProcessGroupResource extends ApplicationResource {
/** /**
* Instantiates the specified template within this ProcessGroup. The template instance that is instantiated cannot be referenced at a later time, therefore there is no * Instantiates the specified template within this ProcessGroup. The template instance that is instantiated cannot be referenced at a later time, therefore there is no
* corresponding URI. Instead the request URI is returned. * corresponding URI. Instead the request URI is returned.
* * <p>
* 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 httpServletRequest request
@ -1743,12 +1708,12 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/template-instance") @Path("{id}/template-instance")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Instantiates a template", value = "Instantiates a template",
response = FlowEntity.class, response = FlowEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = ""),
@Authorization(value = "Read - /templates/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1839,12 +1804,12 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/templates") @Path("{id}/templates")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a template", value = "Creates a template",
response = TemplateEntity.class, response = TemplateEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = ""),
@Authorization(value = "Read - /{component-type}/{uuid} - For each component in the snippet", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -1914,7 +1879,21 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.MULTIPART_FORM_DATA) @Consumes(MediaType.MULTIPART_FORM_DATA)
@Produces(MediaType.APPLICATION_XML) @Produces(MediaType.APPLICATION_XML)
@Path("{id}/templates/upload") @Path("{id}/templates/upload")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')") @ApiOperation(
value = "Uploads a template",
response = TemplateEntity.class,
authorizations = {
@Authorization(value = "Write - /process-groups/{uuid}", type = "")
}
)
@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 = 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 uploadTemplate( public Response uploadTemplate(
@Context final HttpServletRequest httpServletRequest, @Context final HttpServletRequest httpServletRequest,
@ApiParam( @ApiParam(
@ -1988,7 +1967,21 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_XML) @Consumes(MediaType.APPLICATION_XML)
@Produces(MediaType.APPLICATION_XML) @Produces(MediaType.APPLICATION_XML)
@Path("{id}/templates/import") @Path("{id}/templates/import")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')") @ApiOperation(
value = "Imports a template",
response = TemplateEntity.class,
authorizations = {
@Authorization(value = "Write - /process-groups/{uuid}", type = "")
}
)
@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 = 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 importTemplate( public Response importTemplate(
@Context final HttpServletRequest httpServletRequest, @Context final HttpServletRequest httpServletRequest,
@ApiParam( @ApiParam(
@ -2059,12 +2052,11 @@ public class ProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/controller-services") @Path("{id}/controller-services")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a new controller service", value = "Creates a new controller service",
response = ControllerServiceEntity.class, response = ControllerServiceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -2139,6 +2131,7 @@ public class ProcessGroupResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

23
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProcessorResource.java
View File

@ -144,14 +144,11 @@ public class ProcessorResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}") @Path("/{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a processor", value = "Gets a processor",
response = ProcessorEntity.class, response = ProcessorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /processors/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -200,14 +197,11 @@ public class ProcessorResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}/descriptors") @Path("/{id}/descriptors")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the descriptor for a processor property", value = "Gets the descriptor for a processor property",
response = PropertyDescriptorEntity.class, response = PropertyDescriptorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /processors/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -273,12 +267,11 @@ public class ProcessorResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}/state") @Path("/{id}/state")
// TODO - @PreAuthorize("hasAnyRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets the state for a processor", value = "Gets the state for a processor",
response = ComponentStateDTO.class, response = ComponentStateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /processors/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -330,12 +323,11 @@ public class ProcessorResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/state/clear-requests") @Path("{id}/state/clear-requests")
// TODO - @PreAuthorize("hasAnyRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Clears the state for a processor", value = "Clears the state for a processor",
response = ComponentStateDTO.class, response = ComponentStateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /processors/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -395,12 +387,11 @@ public class ProcessorResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}") @Path("/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a processor", value = "Updates a processor",
response = ProcessorEntity.class, response = ProcessorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /processors/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -477,12 +468,11 @@ public class ProcessorResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("/{id}") @Path("/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a processor", value = "Deletes a processor",
response = ProcessorEntity.class, response = ProcessorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /processors/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -536,6 +526,7 @@ public class ProcessorResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

33
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceEventResource.java
View File

@ -27,9 +27,7 @@ import org.apache.nifi.controller.repository.claim.ContentDirection;
import org.apache.nifi.stream.io.StreamUtils; import org.apache.nifi.stream.io.StreamUtils;
import org.apache.nifi.web.DownloadableContent; import org.apache.nifi.web.DownloadableContent;
import org.apache.nifi.web.NiFiServiceFacade; import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.api.dto.provenance.ProvenanceDTO;
import org.apache.nifi.web.api.dto.provenance.ProvenanceEventDTO; import org.apache.nifi.web.api.dto.provenance.ProvenanceEventDTO;
import org.apache.nifi.web.api.dto.provenance.lineage.LineageDTO;
import org.apache.nifi.web.api.entity.ProvenanceEventEntity; import org.apache.nifi.web.api.entity.ProvenanceEventEntity;
import org.apache.nifi.web.api.entity.SubmitReplayRequestEntity; import org.apache.nifi.web.api.entity.SubmitReplayRequestEntity;
import org.apache.nifi.web.api.request.LongParameter; import org.apache.nifi.web.api.request.LongParameter;
@ -66,22 +64,6 @@ public class ProvenanceEventResource extends ApplicationResource {
private NiFiServiceFacade serviceFacade; private NiFiServiceFacade serviceFacade;
/**
* Populates the uri for the specified provenance.
*/
private ProvenanceDTO populateRemainingProvenanceContent(ProvenanceDTO provenance) {
provenance.setUri(generateResourceUri("provenance", provenance.getId()));
return provenance;
}
/**
* Populates the uri for the specified lineage.
*/
private LineageDTO populateRemainingLineageContent(LineageDTO lineage) {
lineage.setUri(generateResourceUri("provenance", "lineage", lineage.getId()));
return lineage;
}
/** /**
* Gets the content for the input of the specified event. * Gets the content for the input of the specified event.
* *
@ -93,11 +75,10 @@ public class ProvenanceEventResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.WILDCARD) @Produces(MediaType.WILDCARD)
@Path("{id}/content/input") @Path("{id}/content/input")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Gets the input content for a provenance event", value = "Gets the input content for a provenance event",
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read Component Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -176,11 +157,10 @@ public class ProvenanceEventResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.WILDCARD) @Produces(MediaType.WILDCARD)
@Path("{id}/content/output") @Path("{id}/content/output")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Gets the output content for a provenance event", value = "Gets the output content for a provenance event",
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read Component Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -259,12 +239,11 @@ public class ProvenanceEventResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Gets a provenance event", value = "Gets a provenance event",
response = ProvenanceEventEntity.class, response = ProvenanceEventEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read Component Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -283,7 +262,7 @@ public class ProvenanceEventResource extends ApplicationResource {
) )
@QueryParam("clusterNodeId") final String clusterNodeId, @QueryParam("clusterNodeId") final String clusterNodeId,
@ApiParam( @ApiParam(
value = "The provenence event id.", value = "The provenance event id.",
required = true required = true
) )
@PathParam("id") final LongParameter id) { @PathParam("id") final LongParameter id) {
@ -326,12 +305,12 @@ public class ProvenanceEventResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("replays") @Path("replays")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE') and hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Replays content from a provenance event", value = "Replays content from a provenance event",
response = ProvenanceEventEntity.class, response = ProvenanceEventEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance and Data Flow Manager", type = "ROLE_PROVENANCE and ROLE_DFM") @Authorization(value = "Read Component Data - /data/{component-type}/{uuid}", type = ""),
@Authorization(value = "Write Component Data - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(

32
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ProvenanceResource.java
View File

@ -93,7 +93,7 @@ public class ProvenanceResource extends ApplicationResource {
private void authorizeProvenanceRequest() { private void authorizeProvenanceRequest() {
final NiFiUser user = NiFiUserUtils.getNiFiUser(); final NiFiUser user = NiFiUserUtils.getNiFiUser();
final Map<String,String> userContext; final Map<String, String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) { if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -126,12 +126,11 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("search-options") @Path("search-options")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Gets the searchable attributes for provenance events", value = "Gets the searchable attributes for provenance events",
response = ProvenanceOptionsEntity.class, response = ProvenanceOptionsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -172,7 +171,6 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("") // necessary due to bug in swagger @Path("") // necessary due to bug in swagger
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Submits a provenance query", value = "Submits a provenance query",
notes = "Provenance queries may be long running so this endpoint submits a request. The response will include the " notes = "Provenance queries may be long running so this endpoint submits a request. The response will include the "
@ -181,7 +179,8 @@ public class ProvenanceResource extends ApplicationResource {
+ "should be deleted by the client who originally submitted it.", + "should be deleted by the client who originally submitted it.",
response = ProvenanceEntity.class, response = ProvenanceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = ""),
@Authorization(value = "Read - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -268,12 +267,12 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Gets a provenance query", value = "Gets a provenance query",
response = ProvenanceEntity.class, response = ProvenanceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = ""),
@Authorization(value = "Read - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -335,12 +334,11 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Deletes a provenance query", value = "Deletes a provenance query",
response = ProvenanceEntity.class, response = ProvenanceEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -396,10 +394,10 @@ public class ProvenanceResource extends ApplicationResource {
/** /**
* Submits a lineage request based on an event or a flowfile uuid. * Submits a lineage request based on an event or a flowfile uuid.
* * <p>
* When querying for the lineage of an event you must specify the eventId and the eventDirection. The eventDirection must be 'parents' or 'children' and specifies whether we are going up or down * When querying for the lineage of an event you must specify the eventId and the eventDirection. The eventDirection must be 'parents' or 'children' and specifies whether we are going up or down
* the flowfile ancestry. The uuid cannot be specified in these cases. * the flowfile ancestry. The uuid cannot be specified in these cases.
* * <p>
* When querying for the lineage of a flowfile you must specify the uuid. The eventId and eventDirection cannot be specified in this case. * When querying for the lineage of a flowfile you must specify the uuid. The eventId and eventDirection cannot be specified in this case.
* *
* @param httpServletRequest request * @param httpServletRequest request
@ -410,7 +408,6 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("lineage") @Path("lineage")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Submits a lineage query", value = "Submits a lineage query",
notes = "Lineage queries may be long running so this endpoint submits a request. The response will include the " notes = "Lineage queries may be long running so this endpoint submits a request. The response will include the "
@ -419,7 +416,8 @@ public class ProvenanceResource extends ApplicationResource {
+ "should be deleted by the client who originally submitted it.", + "should be deleted by the client who originally submitted it.",
response = LineageEntity.class, response = LineageEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = ""),
@Authorization(value = "Read - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -512,12 +510,12 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("lineage/{id}") @Path("lineage/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Gets a lineage query", value = "Gets a lineage query",
response = LineageEntity.class, response = LineageEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = ""),
@Authorization(value = "Read - /data/{component-type}/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -573,12 +571,11 @@ public class ProvenanceResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("lineage/{id}") @Path("lineage/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_PROVENANCE')")
@ApiOperation( @ApiOperation(
value = "Deletes a lineage query", value = "Deletes a lineage query",
response = LineageEntity.class, response = LineageEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Provenance", type = "ROLE_PROVENANCE") @Authorization(value = "Read - /provenance", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -627,6 +624,7 @@ public class ProvenanceResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

22
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/RemoteProcessGroupResource.java
View File

@ -101,14 +101,11 @@ public class RemoteProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a remote process group", value = "Gets a remote process group",
response = RemoteProcessGroupEntity.class, response = RemoteProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /remote-process-groups/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -157,12 +154,11 @@ public class RemoteProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a remote process group", value = "Deletes a remote process group",
response = RemoteProcessGroupEntity.class, response = RemoteProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /remote-process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -220,19 +216,18 @@ public class RemoteProcessGroupResource extends ApplicationResource {
* @param id The id of the remote process group to update. * @param id The id of the remote process group to update.
* @param portId The id of the input port to update. * @param portId The id of the input port to update.
* @param remoteProcessGroupPortEntity The remoteProcessGroupPortEntity * @param remoteProcessGroupPortEntity The remoteProcessGroupPortEntity
*
* @return A remoteProcessGroupPortEntity * @return A remoteProcessGroupPortEntity
*/ */
@PUT @PUT
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/input-ports/{port-id}") @Path("{id}/input-ports/{port-id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a remote port", value = "Updates a remote port",
notes = NON_GUARANTEED_ENDPOINT,
response = RemoteProcessGroupPortEntity.class, response = RemoteProcessGroupPortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /remote-process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -308,19 +303,18 @@ public class RemoteProcessGroupResource extends ApplicationResource {
* @param id The id of the remote process group to update. * @param id The id of the remote process group to update.
* @param portId The id of the output port to update. * @param portId The id of the output port to update.
* @param remoteProcessGroupPortEntity The remoteProcessGroupPortEntity * @param remoteProcessGroupPortEntity The remoteProcessGroupPortEntity
*
* @return A remoteProcessGroupPortEntity * @return A remoteProcessGroupPortEntity
*/ */
@PUT @PUT
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/output-ports/{port-id}") @Path("{id}/output-ports/{port-id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a remote port", value = "Updates a remote port",
notes = NON_GUARANTEED_ENDPOINT,
response = RemoteProcessGroupPortEntity.class, response = RemoteProcessGroupPortEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /remote-process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -402,12 +396,11 @@ public class RemoteProcessGroupResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a remote process group", value = "Updates a remote process group",
response = RemoteProcessGroupEntity.class, response = RemoteProcessGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /remote-process-groups/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -496,6 +489,7 @@ public class RemoteProcessGroupResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

23
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ReportingTaskResource.java
View File

@ -135,14 +135,11 @@ public class ReportingTaskResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a reporting task", value = "Gets a reporting task",
response = ReportingTaskEntity.class, response = ReportingTaskEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /reporting-tasks/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -189,14 +186,11 @@ public class ReportingTaskResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/descriptors") @Path("{id}/descriptors")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a reporting task property descriptor", value = "Gets a reporting task property descriptor",
response = PropertyDescriptorEntity.class, response = PropertyDescriptorEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /reporting-tasks/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -256,12 +250,11 @@ public class ReportingTaskResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/state") @Path("{id}/state")
// TODO - @PreAuthorize("hasAnyRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Gets the state for a reporting task", value = "Gets the state for a reporting task",
response = ComponentStateDTO.class, response = ComponentStateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /reporting-tasks/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -312,12 +305,11 @@ public class ReportingTaskResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}/state/clear-requests") @Path("{id}/state/clear-requests")
// TODO - @PreAuthorize("hasAnyRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Clears the state for a reporting task", value = "Clears the state for a reporting task",
response = ComponentStateDTO.class, response = ComponentStateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /reporting-tasks/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -376,12 +368,11 @@ public class ReportingTaskResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a reporting task", value = "Updates a reporting task",
response = ReportingTaskEntity.class, response = ReportingTaskEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /reporting-tasks/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -460,12 +451,11 @@ public class ReportingTaskResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a reporting task", value = "Deletes a reporting task",
response = ReportingTaskEntity.class, response = ReportingTaskEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /reporting-tasks/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -518,6 +508,7 @@ public class ReportingTaskResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

41
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/ResourceResource.java
View File

@ -16,18 +16,11 @@
*/ */
package org.apache.nifi.web.api; package org.apache.nifi.web.api;
import java.util.HashMap; import com.wordnik.swagger.annotations.Api;
import java.util.List; import com.wordnik.swagger.annotations.ApiOperation;
import java.util.Map; import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;
import javax.ws.rs.Consumes; import com.wordnik.swagger.annotations.Authorization;
import javax.ws.rs.GET;
import javax.ws.rs.HttpMethod;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.nifi.authorization.AccessDeniedException; import org.apache.nifi.authorization.AccessDeniedException;
import org.apache.nifi.authorization.AuthorizationRequest; import org.apache.nifi.authorization.AuthorizationRequest;
@ -43,11 +36,16 @@ import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.api.dto.ResourceDTO; import org.apache.nifi.web.api.dto.ResourceDTO;
import org.apache.nifi.web.api.entity.ResourcesEntity; import org.apache.nifi.web.api.entity.ResourcesEntity;
import com.wordnik.swagger.annotations.Api; import javax.ws.rs.Consumes;
import com.wordnik.swagger.annotations.ApiOperation; import javax.ws.rs.GET;
import com.wordnik.swagger.annotations.ApiResponse; import javax.ws.rs.HttpMethod;
import com.wordnik.swagger.annotations.ApiResponses; import javax.ws.rs.Path;
import com.wordnik.swagger.annotations.Authorization; import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/** /**
* RESTful endpoint for retrieving system diagnostics. * RESTful endpoint for retrieving system diagnostics.
@ -65,7 +63,7 @@ public class ResourceResource extends ApplicationResource {
private void authorizeResource() { private void authorizeResource() {
final NiFiUser user = NiFiUserUtils.getNiFiUser(); final NiFiUser user = NiFiUserUtils.getNiFiUser();
final Map<String,String> userContext; final Map<String, String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) { if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -97,14 +95,11 @@ public class ResourceResource extends ApplicationResource {
@GET @GET
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the available resources that support access/authorization policies", value = "Gets the available resources that support access/authorization policies",
response = ResourcesEntity.class, response = ResourcesEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /resources", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -120,7 +115,6 @@ public class ResourceResource extends ApplicationResource {
return replicate(HttpMethod.GET); return replicate(HttpMethod.GET);
} }
// TODO - if unsecure, return no resources?
final List<ResourceDTO> resources = serviceFacade.getResources(); final List<ResourceDTO> resources = serviceFacade.getResources();
// create the response // create the response
@ -132,6 +126,7 @@ public class ResourceResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

38
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SiteToSiteResource.java
View File

@ -34,6 +34,11 @@ import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType; import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;
import com.wordnik.swagger.annotations.Authorization;
import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.StringUtils;
import org.apache.nifi.authorization.AccessDeniedException; import org.apache.nifi.authorization.AccessDeniedException;
import org.apache.nifi.authorization.AuthorizationRequest; import org.apache.nifi.authorization.AuthorizationRequest;
@ -60,11 +65,20 @@ import org.apache.nifi.web.api.entity.PeersEntity;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import com.wordnik.swagger.annotations.Api; import javax.servlet.http.HttpServletRequest;
import com.wordnik.swagger.annotations.ApiOperation; import javax.ws.rs.Consumes;
import com.wordnik.swagger.annotations.ApiResponse; import javax.ws.rs.GET;
import com.wordnik.swagger.annotations.ApiResponses; import javax.ws.rs.HttpMethod;
import com.wordnik.swagger.annotations.Authorization; import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import static org.apache.commons.lang3.StringUtils.isEmpty;
/** /**
* RESTful endpoint for managing a SiteToSite connection. * RESTful endpoint for managing a SiteToSite connection.
@ -81,8 +95,6 @@ public class SiteToSiteResource extends ApplicationResource {
private NiFiServiceFacade serviceFacade; private NiFiServiceFacade serviceFacade;
private ClusterCoordinator clusterCoordinator; private ClusterCoordinator clusterCoordinator;
private Authorizer authorizer; private Authorizer authorizer;
public static final String CHECK_SUM = "checksum";
public static final String RESPONSE_CODE = "responseCode";
private final ResponseCreator responseCreator = new ResponseCreator(); private final ResponseCreator responseCreator = new ResponseCreator();
private final VersionNegotiator transportProtocolVersionNegotiator = new TransportProtocolVersionNegotiator(1); private final VersionNegotiator transportProtocolVersionNegotiator = new TransportProtocolVersionNegotiator(1);
@ -90,7 +102,7 @@ public class SiteToSiteResource extends ApplicationResource {
/** /**
* Authorizes access to Site To Site details. * Authorizes access to Site To Site details.
* * <p>
* Note: Protected for testing purposes * Note: Protected for testing purposes
*/ */
protected void authorizeSiteToSite() { protected void authorizeSiteToSite() {
@ -119,11 +131,12 @@ public class SiteToSiteResource extends ApplicationResource {
@GET @GET
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
// TODO - @PreAuthorize("hasRole('ROLE_NIFI')")
@ApiOperation( @ApiOperation(
value = "Returns the details about this NiFi necessary to communicate via site to site", value = "Returns the details about this NiFi necessary to communicate via site to site",
response = ControllerEntity.class, response = ControllerEntity.class,
authorizations = @Authorization(value = "NiFi", type = "ROLE_NIFI") authorizations = {
@Authorization(value = "Read - /site-to-site", type = "")
}
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -174,7 +187,9 @@ public class SiteToSiteResource extends ApplicationResource {
@ApiOperation( @ApiOperation(
value = "Returns the available Peers and its status of this NiFi", value = "Returns the available Peers and its status of this NiFi",
response = PeersEntity.class, response = PeersEntity.class,
authorizations = @Authorization(value = "NiFi", type = "ROLE_NIFI") authorizations = {
@Authorization(value = "Read - /site-to-site", type = "")
}
) )
@ApiResponses( @ApiResponses(
value = { value = {
@ -246,6 +261,7 @@ public class SiteToSiteResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(final NiFiServiceFacade serviceFacade) { public void setServiceFacade(final NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

56
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SnippetResource.java
View File

@ -16,9 +16,20 @@
*/ */
package org.apache.nifi.web.api; package org.apache.nifi.web.api;
import java.net.URI; import com.wordnik.swagger.annotations.Api;
import java.util.Set; import com.wordnik.swagger.annotations.ApiOperation;
import java.util.stream.Collectors; import com.wordnik.swagger.annotations.ApiParam;
import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;
import com.wordnik.swagger.annotations.Authorization;
import org.apache.nifi.authorization.Authorizer;
import org.apache.nifi.authorization.RequestAction;
import org.apache.nifi.authorization.user.NiFiUserUtils;
import org.apache.nifi.controller.Snippet;
import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.Revision;
import org.apache.nifi.web.api.dto.SnippetDTO;
import org.apache.nifi.web.api.entity.SnippetEntity;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes; import javax.ws.rs.Consumes;
@ -32,22 +43,9 @@ import javax.ws.rs.Produces;
import javax.ws.rs.core.Context; import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType; import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;
import java.net.URI;
import org.apache.nifi.authorization.Authorizer; import java.util.Set;
import org.apache.nifi.authorization.RequestAction; import java.util.stream.Collectors;
import org.apache.nifi.authorization.user.NiFiUserUtils;
import org.apache.nifi.controller.Snippet;
import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.Revision;
import org.apache.nifi.web.api.dto.SnippetDTO;
import org.apache.nifi.web.api.entity.SnippetEntity;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiParam;
import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;
import com.wordnik.swagger.annotations.Authorization;
/** /**
* RESTful endpoint for querying dataflow snippets. * RESTful endpoint for querying dataflow snippets.
@ -101,14 +99,11 @@ public class SnippetResource extends ApplicationResource {
@POST @POST
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a snippet", value = "Creates a snippet",
response = SnippetEntity.class, response = SnippetEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /{component-type}/{uuid} - For each component in the Snippet", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -165,8 +160,7 @@ public class SnippetResource extends ApplicationResource {
} }
/** /**
* Updates the specified snippet. The contents of the snippet (component * Move's the components in this Snippet into a new Process Group.
* ids) cannot be updated once the snippet is created.
* *
* @param httpServletRequest request * @param httpServletRequest request
* @param snippetId The id of the snippet. * @param snippetId The id of the snippet.
@ -177,12 +171,12 @@ public class SnippetResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a snippet", value = "Move's the components in this Snippet into a new Process Group and drops the snippet",
response = SnippetEntity.class, response = SnippetEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write Process Group - /process-groups/{uuid}", type = ""),
@Authorization(value = "Write - /{component-type}/{uuid} - For each component in the Snippet", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -232,7 +226,7 @@ public class SnippetResource extends ApplicationResource {
lookup.getProcessGroup(requestSnippetDTO.getParentGroupId()).authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser()); lookup.getProcessGroup(requestSnippetDTO.getParentGroupId()).authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser());
} }
// ensure read permission to every component in the snippet // ensure write permission to every component in the snippet
final Snippet snippet = lookup.getSnippet(snippetId); final Snippet snippet = lookup.getSnippet(snippetId);
authorizeSnippet(snippet, authorizer, lookup, RequestAction.WRITE); authorizeSnippet(snippet, authorizer, lookup, RequestAction.WRITE);
}, },
@ -257,12 +251,11 @@ public class SnippetResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes the components in a snippet and drops the snippet", value = "Deletes the components in a snippet and drops the snippet",
response = SnippetEntity.class, response = SnippetEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /{component-type}/{uuid} - For each component in the Snippet", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -306,6 +299,7 @@ public class SnippetResource extends ApplicationResource {
} }
/* setters */ /* setters */
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

8
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/SystemDiagnosticsResource.java
View File

@ -69,7 +69,7 @@ public class SystemDiagnosticsResource extends ApplicationResource {
private void authorizeSystem() { private void authorizeSystem() {
final NiFiUser user = NiFiUserUtils.getNiFiUser(); final NiFiUser user = NiFiUserUtils.getNiFiUser();
final Map<String,String> userContext; final Map<String, String> userContext;
if (!StringUtils.isBlank(user.getClientAddress())) { if (!StringUtils.isBlank(user.getClientAddress())) {
userContext = new HashMap<>(); userContext = new HashMap<>();
userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress()); userContext.put(UserContextKeys.CLIENT_ADDRESS.name(), user.getClientAddress());
@ -102,14 +102,11 @@ public class SystemDiagnosticsResource extends ApplicationResource {
@GET @GET
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets the diagnostics for the system NiFi is running on", value = "Gets the diagnostics for the system NiFi is running on",
response = SystemDiagnosticsEntity.class, response = SystemDiagnosticsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /system", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -174,6 +171,7 @@ public class SystemDiagnosticsResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

71
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TemplateResource.java
View File

@ -16,8 +16,21 @@
*/ */
package org.apache.nifi.web.api; package org.apache.nifi.web.api;
import java.nio.charset.StandardCharsets; import com.wordnik.swagger.annotations.Api;
import java.util.Set; import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiParam;
import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;
import com.wordnik.swagger.annotations.Authorization;
import org.apache.commons.lang3.StringUtils;
import org.apache.nifi.authorization.Authorizer;
import org.apache.nifi.authorization.RequestAction;
import org.apache.nifi.authorization.resource.Authorizable;
import org.apache.nifi.authorization.user.NiFiUserUtils;
import org.apache.nifi.persistence.TemplateSerializer;
import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.api.dto.TemplateDTO;
import org.apache.nifi.web.api.entity.TemplateEntity;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes; import javax.ws.rs.Consumes;
@ -30,23 +43,8 @@ import javax.ws.rs.Produces;
import javax.ws.rs.core.Context; import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType; import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response; import javax.ws.rs.core.Response;
import java.nio.charset.StandardCharsets;
import org.apache.commons.lang3.StringUtils; import java.util.Set;
import org.apache.nifi.authorization.Authorizer;
import org.apache.nifi.authorization.RequestAction;
import org.apache.nifi.authorization.resource.Authorizable;
import org.apache.nifi.authorization.user.NiFiUserUtils;
import org.apache.nifi.persistence.TemplateSerializer;
import org.apache.nifi.web.NiFiServiceFacade;
import org.apache.nifi.web.api.dto.TemplateDTO;
import org.apache.nifi.web.api.entity.TemplateEntity;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import com.wordnik.swagger.annotations.ApiParam;
import com.wordnik.swagger.annotations.ApiResponse;
import com.wordnik.swagger.annotations.ApiResponses;
import com.wordnik.swagger.annotations.Authorization;
/** /**
* RESTful endpoint for managing a Template. * RESTful endpoint for managing a Template.
@ -76,32 +74,6 @@ public class TemplateResource extends ApplicationResource {
return templateEntities; return templateEntities;
} }
/**
* Populate the uri's for the specified templates.
*
* @param templateEntity templates
* @return templates
*/
public TemplateEntity populateRemainingTemplateEntityContent(TemplateEntity templateEntity) {
if (templateEntity.getTemplate() != null) {
populateRemainingTemplateContent(templateEntity.getTemplate());
}
return templateEntity;
}
/**
* Populates the uri for the specified templates.
*
* @param templates templates
* @return templates
*/
public Set<TemplateDTO> populateRemainingTemplatesContent(Set<TemplateDTO> templates) {
for (TemplateDTO template : templates) {
populateRemainingTemplateContent(template);
}
return templates;
}
/** /**
* Populates the uri for the specified template. * Populates the uri for the specified template.
*/ */
@ -121,14 +93,11 @@ public class TemplateResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_XML) @Produces(MediaType.APPLICATION_XML)
@Path("{id}/download") @Path("{id}/download")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Exports a template", value = "Exports a template",
response = TemplateDTO.class, response = TemplateDTO.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /templates/{uuid}", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -192,12 +161,11 @@ public class TemplateResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("{id}") @Path("{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a template", value = "Deletes a template",
response = TemplateEntity.class, response = TemplateEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /templates/{uuid}", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -242,6 +210,7 @@ public class TemplateResource extends ApplicationResource {
} }
// setters // setters
public void setServiceFacade(NiFiServiceFacade serviceFacade) { public void setServiceFacade(NiFiServiceFacade serviceFacade) {
this.serviceFacade = serviceFacade; this.serviceFacade = serviceFacade;
} }

58
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/TenantsResource.java
View File

@ -122,12 +122,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("users") @Path("users")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a user", value = "Creates a user",
notes = NON_GUARANTEED_ENDPOINT,
response = UserEntity.class, response = UserEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /tenants", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -205,14 +205,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("users/{id}") @Path("users/{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a user", value = "Gets a user",
notes = NON_GUARANTEED_ENDPOINT,
response = UserEntity.class, response = UserEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /tenants", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -262,14 +260,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("users") @Path("users")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all users", value = "Gets all users",
notes = NON_GUARANTEED_ENDPOINT,
response = UsersEntity.class, response = UsersEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /tenants", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -322,12 +318,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("users/{id}") @Path("users/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a user", value = "Updates a user",
notes = NON_GUARANTEED_ENDPOINT,
response = UserEntity.class, response = UserEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /tenants", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -411,12 +407,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("users/{id}") @Path("users/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a user", value = "Deletes a user",
notes = NON_GUARANTEED_ENDPOINT,
response = UserEntity.class, response = UserEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /tenants", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -462,7 +458,7 @@ public class TenantsResource extends ApplicationResource {
revision, revision,
lookup -> { lookup -> {
final Authorizable tenants = lookup.getTenant(); final Authorizable tenants = lookup.getTenant();
tenants.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); tenants.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser());
}, },
null, null,
() -> { () -> {
@ -508,12 +504,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("user-groups") @Path("user-groups")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Creates a user group", value = "Creates a user group",
notes = NON_GUARANTEED_ENDPOINT,
response = UserGroupEntity.class, response = UserGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /tenants", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -591,14 +587,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("user-groups/{id}") @Path("user-groups/{id}")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets a user group", value = "Gets a user group",
notes = NON_GUARANTEED_ENDPOINT,
response = UserGroupEntity.class, response = UserGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /tenants", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -648,14 +642,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("user-groups") @Path("user-groups")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Gets all user groups", value = "Gets all user groups",
notes = NON_GUARANTEED_ENDPOINT,
response = UserGroupsEntity.class, response = UserGroupsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /tenants", type = "")
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM"),
@Authorization(value = "Administrator", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(
@ -707,12 +699,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("user-groups/{id}") @Path("user-groups/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Updates a user group", value = "Updates a user group",
notes = NON_GUARANTEED_ENDPOINT,
response = UserGroupEntity.class, response = UserGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /tenants", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -796,12 +788,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("user-groups/{id}") @Path("user-groups/{id}")
// TODO - @PreAuthorize("hasRole('ROLE_DFM')")
@ApiOperation( @ApiOperation(
value = "Deletes a user group", value = "Deletes a user group",
notes = NON_GUARANTEED_ENDPOINT,
response = UserGroupEntity.class, response = UserGroupEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Data Flow Manager", type = "ROLE_DFM") @Authorization(value = "Write - /tenants", type = "")
} }
) )
@ApiResponses( @ApiResponses(
@ -847,7 +839,7 @@ public class TenantsResource extends ApplicationResource {
revision, revision,
lookup -> { lookup -> {
final Authorizable tenants = lookup.getTenant(); final Authorizable tenants = lookup.getTenant();
tenants.authorize(authorizer, RequestAction.READ, NiFiUserUtils.getNiFiUser()); tenants.authorize(authorizer, RequestAction.WRITE, NiFiUserUtils.getNiFiUser());
}, },
null, null,
() -> { () -> {
@ -872,14 +864,12 @@ public class TenantsResource extends ApplicationResource {
@Consumes(MediaType.WILDCARD) @Consumes(MediaType.WILDCARD)
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Path("search-results") @Path("search-results")
// TODO - @PreAuthorize("hasAnyRole('ROLE_MONITOR', 'ROLE_DFM', 'ROLE_ADMIN')")
@ApiOperation( @ApiOperation(
value = "Searches the cluster for a node with the specified address", value = "Searches the cluster for a node with the specified address",
notes = NON_GUARANTEED_ENDPOINT,
response = ClusterSearchResultsEntity.class, response = ClusterSearchResultsEntity.class,
authorizations = { authorizations = {
@Authorization(value = "Read Only", type = "ROLE_MONITOR"), @Authorization(value = "Read - /tenants", type = "")
@Authorization(value = "DFM", type = "ROLE_DFM"),
@Authorization(value = "Admin", type = "ROLE_ADMIN")
} }
) )
@ApiResponses( @ApiResponses(

12
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/InvalidRevisionExceptionMapper.java
View File

@ -16,14 +16,16 @@
*/ */
package org.apache.nifi.web.api.config; package org.apache.nifi.web.api.config;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
import org.apache.nifi.util.StringUtils; import org.apache.nifi.util.StringUtils;
import org.apache.nifi.web.InvalidRevisionException; import org.apache.nifi.web.InvalidRevisionException;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
/** /**
* Maps invalid revision exceptions into client responses. * Maps invalid revision exceptions into client responses.
*/ */
@ -35,13 +37,13 @@ public class InvalidRevisionExceptionMapper implements ExceptionMapper<InvalidRe
@Override @Override
public Response toResponse(InvalidRevisionException exception) { public Response toResponse(InvalidRevisionException exception) {
// log the error // log the error
logger.info(String.format("%s. Returning %s response.", exception, Response.Status.CONFLICT)); logger.info(String.format("%s. Returning %s response.", exception, Status.BAD_REQUEST));
if (logger.isDebugEnabled()) { if (logger.isDebugEnabled()) {
logger.debug(StringUtils.EMPTY, exception); logger.debug(StringUtils.EMPTY, exception);
} }
return Response.status(Response.Status.CONFLICT).entity(exception.getMessage()).type("text/plain").build(); return Response.status(Status.BAD_REQUEST).entity(exception.getMessage()).type("text/plain").build();
} }
} }

72
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java
View File

@ -27,7 +27,6 @@ import org.apache.nifi.authorization.RequestAction;
import org.apache.nifi.authorization.Resource; import org.apache.nifi.authorization.Resource;
import org.apache.nifi.authorization.resource.Authorizable; import org.apache.nifi.authorization.resource.Authorizable;
import org.apache.nifi.authorization.resource.ResourceFactory; import org.apache.nifi.authorization.resource.ResourceFactory;
import org.apache.nifi.authorization.resource.ResourceType;
import org.apache.nifi.authorization.user.NiFiUser; import org.apache.nifi.authorization.user.NiFiUser;
import org.apache.nifi.authorization.user.NiFiUserUtils; import org.apache.nifi.authorization.user.NiFiUserUtils;
import org.apache.nifi.cluster.coordination.ClusterCoordinator; import org.apache.nifi.cluster.coordination.ClusterCoordinator;
@ -94,7 +93,6 @@ import org.apache.nifi.web.NiFiCoreException;
import org.apache.nifi.web.ResourceNotFoundException; import org.apache.nifi.web.ResourceNotFoundException;
import org.apache.nifi.web.api.dto.DocumentedTypeDTO; import org.apache.nifi.web.api.dto.DocumentedTypeDTO;
import org.apache.nifi.web.api.dto.DtoFactory; import org.apache.nifi.web.api.dto.DtoFactory;
import org.apache.nifi.web.api.dto.TemplateDTO;
import org.apache.nifi.web.api.dto.provenance.AttributeDTO; import org.apache.nifi.web.api.dto.provenance.AttributeDTO;
import org.apache.nifi.web.api.dto.provenance.ProvenanceDTO; import org.apache.nifi.web.api.dto.provenance.ProvenanceDTO;
import org.apache.nifi.web.api.dto.provenance.ProvenanceEventDTO; import org.apache.nifi.web.api.dto.provenance.ProvenanceEventDTO;
@ -131,6 +129,7 @@ import java.util.SortedSet;
import java.util.TimeZone; import java.util.TimeZone;
import java.util.TreeSet; import java.util.TreeSet;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import static org.apache.nifi.controller.FlowController.ROOT_GROUP_ID_ALIAS; import static org.apache.nifi.controller.FlowController.ROOT_GROUP_ID_ALIAS;
@ -754,68 +753,97 @@ public class ControllerFacade implements Authorizable {
public List<Resource> getResources() { public List<Resource> getResources() {
final List<Resource> resources = new ArrayList<>(); final List<Resource> resources = new ArrayList<>();
resources.add(ResourceFactory.getFlowResource());
resources.add(ResourceFactory.getSystemResource()); resources.add(ResourceFactory.getSystemResource());
resources.add(ResourceFactory.getControllerResource()); resources.add(ResourceFactory.getControllerResource());
resources.add(ResourceFactory.getFlowResource()); resources.add(ResourceFactory.getCountersResource());
resources.add(ResourceFactory.getProvenanceResource()); resources.add(ResourceFactory.getProvenanceResource());
resources.add(ResourceFactory.getPoliciesResource());
resources.add(ResourceFactory.getTenantResource());
resources.add(ResourceFactory.getProxyResource()); resources.add(ResourceFactory.getProxyResource());
resources.add(ResourceFactory.getResourceResource()); resources.add(ResourceFactory.getResourceResource());
resources.add(ResourceFactory.getSiteToSiteResource());
final ProcessGroup root = flowController.getGroup(flowController.getRootGroupId()); final ProcessGroup root = flowController.getGroup(flowController.getRootGroupId());
// add each processor // add each processor
for (final ProcessorNode processor : root.findAllProcessors()) { for (final ProcessorNode processor : root.findAllProcessors()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.Processor, processor.getIdentifier(), processor.getName())); final Resource processorResource = processor.getResource();
resources.add(ResourceFactory.getDataResource(processor.getResource())); resources.add(processorResource);
resources.add(ResourceFactory.getDataResource(processorResource));
resources.add(ResourceFactory.getPolicyResource(processorResource));
} }
// add each label // add each label
for (final Label label : root.findAllLabels()) { for (final Label label : root.findAllLabels()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.Label, label.getIdentifier(), label.getValue())); final Resource labelResource = label.getResource();
resources.add(labelResource);
resources.add(ResourceFactory.getPolicyResource(labelResource));
} }
// add each process group // add each process group
for (final ProcessGroup processGroup : root.findAllProcessGroups()) { for (final ProcessGroup processGroup : root.findAllProcessGroups()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.ProcessGroup, processGroup.getIdentifier(), processGroup.getName())); final Resource processGroupResource = processGroup.getResource();
resources.add(ResourceFactory.getDataResource(processGroup.getResource())); resources.add(processGroupResource);
resources.add(ResourceFactory.getDataResource(processGroupResource));
resources.add(ResourceFactory.getPolicyResource(processGroupResource));
} }
// add each remote process group // add each remote process group
for (final RemoteProcessGroup remoteProcessGroup : root.findAllRemoteProcessGroups()) { for (final RemoteProcessGroup remoteProcessGroup : root.findAllRemoteProcessGroups()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.RemoteProcessGroup, remoteProcessGroup.getIdentifier(), remoteProcessGroup.getName())); final Resource remoteProcessGroupResource = remoteProcessGroup.getResource();
resources.add(ResourceFactory.getDataResource(remoteProcessGroup.getResource())); resources.add(remoteProcessGroupResource);
resources.add(ResourceFactory.getDataResource(remoteProcessGroupResource));
resources.add(ResourceFactory.getPolicyResource(remoteProcessGroupResource));
} }
// add each input port // add each input port
for (final Port inputPort : root.findAllInputPorts()) { for (final Port inputPort : root.findAllInputPorts()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.InputPort, inputPort.getIdentifier(), inputPort.getName())); final Resource inputPortResource = inputPort.getResource();
resources.add(ResourceFactory.getDataResource(inputPort.getResource())); resources.add(inputPortResource);
resources.add(ResourceFactory.getDataResource(inputPortResource));
resources.add(ResourceFactory.getPolicyResource(inputPortResource));
if (inputPort instanceof RootGroupPort) {
resources.add(ResourceFactory.getDataTransferResource(inputPortResource));
}
} }
// add each output port // add each output port
for (final Port outputPort : root.findAllOutputPorts()) { for (final Port outputPort : root.findAllOutputPorts()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.OutputPort, outputPort.getIdentifier(), outputPort.getName())); final Resource outputPortResource = outputPort.getResource();
resources.add(ResourceFactory.getDataResource(outputPort.getResource())); resources.add(outputPortResource);
resources.add(ResourceFactory.getDataResource(outputPortResource));
resources.add(ResourceFactory.getPolicyResource(outputPortResource));
if (outputPort instanceof RootGroupPort) {
resources.add(ResourceFactory.getDataTransferResource(outputPortResource));
}
} }
// add each controller service // add each controller service
for (final ControllerServiceNode controllerService : flowController.getAllControllerServices()) { final Consumer<ControllerServiceNode> csConsumer = controllerService -> {
resources.add(ResourceFactory.getComponentResource(ResourceType.ControllerService, controllerService.getIdentifier(), controllerService.getName())); final Resource controllerServiceResource = controllerService.getResource();
} resources.add(controllerServiceResource);
resources.add(ResourceFactory.getPolicyResource(controllerServiceResource));
};
flowController.getAllControllerServices().forEach(csConsumer);
root.findAllControllerServices().forEach(csConsumer);
// add each reporting task // add each reporting task
for (final ReportingTaskNode reportingTask : flowController.getAllReportingTasks()) { for (final ReportingTaskNode reportingTask : flowController.getAllReportingTasks()) {
resources.add(ResourceFactory.getComponentResource(ResourceType.ReportingTask, reportingTask.getIdentifier(), reportingTask.getName())); final Resource reportingTaskResource = reportingTask.getResource();
resources.add(reportingTaskResource);
resources.add(ResourceFactory.getPolicyResource(reportingTaskResource));
} }
// add each template // add each template
for (final Template template : root.findAllTemplates()) { for (final Template template : root.findAllTemplates()) {
final TemplateDTO details = template.getDetails(); final Resource templateResource = template.getResource();
resources.add(ResourceFactory.getComponentResource(ResourceType.Template, details.getId(), details.getName())); resources.add(templateResource);
resources.add(ResourceFactory.getPolicyResource(templateResource));
} }
// TODO - need token resource?
// resources.add(ResourceFactory.getTokenResource());
return resources; return resources;
} }