You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by mc...@apache.org on 2015/04/28 16:05:10 UTC
[36/50] [abbrv] incubator-nifi git commit: NIFI-271
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java
index 573c407..f7b2009 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserGroupResource.java
@@ -54,7 +54,7 @@ public class UserGroupResource extends ApplicationResource {
/*
* Developer Note: Clustering assumes a centralized security provider. The
- * cluster manager will manage user accounts when in clustered mode and
+ * cluster manager will manage user accounts when in clustered mode and
* interface with the authorization provider. However, when nodes perform
* Site-to-Site, the authorization details of the remote NiFi will be cached
* locally. These details need to be invalidated when certain actions are
@@ -68,18 +68,14 @@ public class UserGroupResource extends ApplicationResource {
/**
* Updates a new user group.
*
- * @param httpServletRequest
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
- * @param userIds A collection of user ids to include in this group. If a
- * user already belongs to another group, they will be placed in this group
- * instead. Existing users in this group will remain in this group.
+ * @param httpServletRequest request
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
+ * @param userIds A collection of user ids to include in this group. If a user already belongs to another group, they will be placed in this group instead. Existing users in this group will remain
+ * in this group.
* @param group The name of the group.
- * @param rawAuthorities Array of authorities to assign to the specified
- * user.
+ * @param rawAuthorities Array of authorities to assign to the specified user.
* @param status The status of the specified users account.
- * @param formParams
+ * @param formParams form params
* @return A userGroupEntity.
*/
@PUT
@@ -132,7 +128,7 @@ public class UserGroupResource extends ApplicationResource {
/**
* Creates a new user group with the specified users.
*
- * @param httpServletRequest
+ * @param httpServletRequest request
* @param group The user group.
* @param userGroupEntity A userGroupEntity.
* @return A userGroupEntity.
@@ -177,7 +173,7 @@ public class UserGroupResource extends ApplicationResource {
// this user is being modified, replicate to the nodes to invalidate this account
// so that it will be re-authorized during the next attempted access - if this wasn't
// done the account would remain stale for up to the configured cache duration. this
- // is acceptable sometimes but when updating a users authorities or groups via the UI
+ // is acceptable sometimes but when updating a users authorities or groups via the UI
// they shouldn't have to wait for the changes to take effect`
if (properties.isClusterManager()) {
// change content type to JSON for serializing entity
@@ -233,15 +229,12 @@ public class UserGroupResource extends ApplicationResource {
}
/**
- * Deletes the user from the specified group. The user will not be removed,
- * just the fact that they were in this group.
+ * Deletes the user from the specified group. The user will not be removed, just the fact that they were in this group.
*
- * @param httpServletRequest
+ * @param httpServletRequest request
* @param group The user group.
* @param userId The user id to remove.
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
* @return A userGroupEntity.
*/
@DELETE
@@ -258,7 +251,7 @@ public class UserGroupResource extends ApplicationResource {
// this user is being modified, replicate to the nodes to invalidate this account
// so that it will be re-authorized during the next attempted access - if this wasn't
// done the account would remain stale for up to the configured cache duration. this
- // is acceptable sometimes but when removing a user via the UI they shouldn't have to
+ // is acceptable sometimes but when removing a user via the UI they shouldn't have to
// wait for the changes to take effect
if (properties.isClusterManager()) {
// identify yourself as the NCM attempting to invalidate the user
@@ -302,14 +295,11 @@ public class UserGroupResource extends ApplicationResource {
}
/**
- * Deletes the user group. The users will not be removed, just the fact that
- * they were grouped.
+ * Deletes the user group. The users will not be removed, just the fact that they were grouped.
*
- * @param httpServletRequest
+ * @param httpServletRequest request
* @param group The user group.
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
* @return A userGroupEntity.
*/
@DELETE
@@ -325,7 +315,7 @@ public class UserGroupResource extends ApplicationResource {
// this user is being modified, replicate to the nodes to invalidate this account
// so that it will be re-authorized during the next attempted access - if this wasn't
// done the account would remain stale for up to the configured cache duration. this
- // is acceptable sometimes but when removing a user via the UI they shouldn't have to
+ // is acceptable sometimes but when removing a user via the UI they shouldn't have to
// wait for the changes to take effect
if (properties.isClusterManager()) {
// identify yourself as the NCM attempting to invalidate the user
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java
index 09307c8..6dbb1a7 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/UserResource.java
@@ -66,7 +66,7 @@ public class UserResource extends ApplicationResource {
/*
* Developer Note: Clustering assumes a centralized security provider. The
- * cluster manager will manage user accounts when in clustered mode and
+ * cluster manager will manage user accounts when in clustered mode and
* interface with the authorization provider. However, when nodes perform
* Site-to-Site, the authorization details of the remote NiFi will be cached
* locally. These details need to be invalidated when certain actions are
@@ -80,9 +80,7 @@ public class UserResource extends ApplicationResource {
/**
* Gets all users that are registered within this Controller.
*
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
* @param grouped Whether to return the users in their groups.
* @return A usersEntity.
*/
@@ -114,9 +112,7 @@ public class UserResource extends ApplicationResource {
/**
* Gets the details for the specified user.
*
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
* @param id The user id.
* @return A userEntity.
*/
@@ -237,15 +233,12 @@ public class UserResource extends ApplicationResource {
/**
* Updates the specified user.
*
- * @param httpServletRequest
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
+ * @param httpServletRequest request
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
* @param id The id of the user to update.
- * @param rawAuthorities Array of authorities to assign to the specified
- * user.
+ * @param rawAuthorities Array of authorities to assign to the specified user.
* @param status The status of the specified users account.
- * @param formParams
+ * @param formParams form params
* @return A userEntity
*/
@PUT
@@ -296,7 +289,7 @@ public class UserResource extends ApplicationResource {
/**
* Updates the specified user.
*
- * @param httpServletRequest
+ * @param httpServletRequest request
* @param id The id of the user to update.
* @param userEntity A userEntity
* @return A userEntity
@@ -334,7 +327,7 @@ public class UserResource extends ApplicationResource {
// this user is being modified, replicate to the nodes to invalidate this account
// so that it will be re-authorized during the next attempted access - if this wasn't
// done the account would remain stale for up to the configured cache duration. this
- // is acceptable sometimes but when updating a users authorities or groups via the UI
+ // is acceptable sometimes but when updating a users authorities or groups via the UI
// they shouldn't have to wait for the changes to take effect`
if (properties.isClusterManager()) {
// change content type to JSON for serializing entity
@@ -391,11 +384,9 @@ public class UserResource extends ApplicationResource {
/**
* Deletes the specified user.
*
- * @param httpServletRequest
+ * @param httpServletRequest request
* @param id The user id
- * @param clientId Optional client id. If the client id is not specified, a
- * new one will be generated. This value (whether specified or generated) is
- * included in the response.
+ * @param clientId Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
* @return A userEntity.
*/
@DELETE
@@ -411,7 +402,7 @@ public class UserResource extends ApplicationResource {
// this user is being modified, replicate to the nodes to invalidate this account
// so that it will be re-authorized during the next attempted access - if this wasn't
// done the account would remain stale for up to the configured cache duration. this
- // is acceptable sometimes but when removing a user via the UI they shouldn't have to
+ // is acceptable sometimes but when removing a user via the UI they shouldn't have to
// wait for the changes to take effect
if (properties.isClusterManager()) {
// identify yourself as the NCM attempting to invalidate the user
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java
index d631d82..19b8e19 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AdministrationExceptionMapper.java
@@ -20,7 +20,6 @@ import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
import org.apache.nifi.admin.service.AdministrationException;
-import org.apache.nifi.util.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java
index 72a9c7b..bd35a98 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/AuthenticationCredentialsNotFoundExceptionMapper.java
@@ -25,8 +25,7 @@ import org.slf4j.LoggerFactory;
import org.springframework.security.authentication.AuthenticationCredentialsNotFoundException;
/**
- * Maps exceptions that occur because no valid credentials were found into the
- * corresponding response.
+ * Maps exceptions that occur because no valid credentials were found into the corresponding response.
*/
@Provider
public class AuthenticationCredentialsNotFoundExceptionMapper implements ExceptionMapper<AuthenticationCredentialsNotFoundException> {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java
index a3c9884..2a67cf8 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ClusterExceptionMapper.java
@@ -20,7 +20,6 @@ import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;
import org.apache.nifi.cluster.manager.exception.ClusterException;
-import org.apache.nifi.util.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java
index ce2059c..ceb7360 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/NoResponseFromNodesExceptionMapper.java
@@ -26,8 +26,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Maps the exceptional case when the cluster is unable to service a request
- * because no nodes returned a response.
+ * Maps the exceptional case when the cluster is unable to service a request because no nodes returned a response.
*/
@Provider
public class NoResponseFromNodesExceptionMapper implements ExceptionMapper<NoResponseFromNodesException> {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java
index 7277250..bdf1f00 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/config/ThrowableMapper.java
@@ -19,7 +19,6 @@ 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.slf4j.Logger;
import org.slf4j.LoggerFactory;
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java
index bf216c3..999a4a4 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/dto/DtoFactory.java
@@ -129,9 +129,6 @@ import org.apache.nifi.controller.service.ControllerServiceReference;
import org.apache.nifi.reporting.ReportingTask;
import org.apache.nifi.web.FlowModification;
-/**
- *
- */
public final class DtoFactory {
@SuppressWarnings("rawtypes")
@@ -149,8 +146,8 @@ public final class DtoFactory {
/**
* Creates an ActionDTO for the specified Action.
*
- * @param action
- * @return
+ * @param action action
+ * @return dto
*/
public ActionDTO createActionDto(final Action action) {
final ActionDTO actionDto = new ActionDTO();
@@ -171,8 +168,8 @@ public final class DtoFactory {
/**
* Creates an ActionDetailsDTO for the specified ActionDetails.
*
- * @param actionDetails
- * @return
+ * @param actionDetails details
+ * @return dto
*/
private ActionDetailsDTO createActionDetailsDto(final ActionDetails actionDetails) {
if (actionDetails == null) {
@@ -214,8 +211,8 @@ public final class DtoFactory {
/**
* Creates a ComponentDetailsDTO for the specified ComponentDetails.
*
- * @param componentDetails
- * @return
+ * @param componentDetails details
+ * @return dto
*/
private ComponentDetailsDTO createComponentDetailsDto(final ComponentDetails componentDetails) {
if (componentDetails == null) {
@@ -238,8 +235,8 @@ public final class DtoFactory {
/**
* Creates a HistoryDTO from the specified History.
*
- * @param history
- * @return
+ * @param history history
+ * @return dto
*/
public HistoryDTO createHistoryDto(final History history) {
final HistoryDTO historyDto = new HistoryDTO();
@@ -260,8 +257,8 @@ public final class DtoFactory {
/**
* Creates CounterDTOs for each Counter specified.
*
- * @param counterDtos
- * @return
+ * @param counterDtos dtos
+ * @return dto
*/
public CountersDTO createCountersDto(final Collection<CounterDTO> counterDtos) {
final CountersDTO dto = new CountersDTO();
@@ -273,8 +270,8 @@ public final class DtoFactory {
/**
* Creates a CounterDTO from the specified Counter.
*
- * @param counter
- * @return
+ * @param counter counter
+ * @return dto
*/
public CounterDTO createCounterDto(final Counter counter) {
final CounterDTO dto = new CounterDTO();
@@ -289,8 +286,8 @@ public final class DtoFactory {
/**
* Creates a PositionDTO from the specified position
*
- * @param position
- * @return
+ * @param position position
+ * @return dto
*/
public PositionDTO createPositionDto(final Position position) {
return new PositionDTO(position.getX(), position.getY());
@@ -299,8 +296,8 @@ public final class DtoFactory {
/**
* Creates a ConnectionDTO from the specified Connection.
*
- * @param connection
- * @return
+ * @param connection connection
+ * @return dto
*/
public ConnectionDTO createConnectionDto(final Connection connection) {
if (connection == null) {
@@ -358,8 +355,8 @@ public final class DtoFactory {
/**
* Creates a ConnectableDTO from the specified Connectable.
*
- * @param connectable
- * @return
+ * @param connectable connectable
+ * @return dto
*/
public ConnectableDTO createConnectableDto(final Connectable connectable) {
if (connectable == null) {
@@ -391,8 +388,8 @@ public final class DtoFactory {
/**
* Creates a LabelDTO from the specified Label.
*
- * @param label
- * @return
+ * @param label label
+ * @return dto
*/
public LabelDTO createLabelDto(final Label label) {
if (label == null) {
@@ -414,8 +411,8 @@ public final class DtoFactory {
/**
* Creates a FunnelDTO from the specified Funnel.
*
- * @param funnel
- * @return
+ * @param funnel funnel
+ * @return dto
*/
public FunnelDTO createFunnelDto(final Funnel funnel) {
if (funnel == null) {
@@ -433,8 +430,8 @@ public final class DtoFactory {
/**
* Creates a SnippetDTO from the specified Snippet.
*
- * @param snippet
- * @return
+ * @param snippet snippet
+ * @return dto
*/
public SnippetDTO createSnippetDto(final Snippet snippet) {
final SnippetDTO dto = new SnippetDTO();
@@ -458,8 +455,8 @@ public final class DtoFactory {
/**
* Creates a TemplateDTO from the specified template.
*
- * @param template
- * @return
+ * @param template template
+ * @return dto
*/
public TemplateDTO createTemplateDTO(final Template template) {
if (template == null) {
@@ -728,8 +725,8 @@ public final class DtoFactory {
/**
* Creates a PortStatusDTO for the specified PortStatus.
*
- * @param portStatus
- * @return
+ * @param portStatus status
+ * @return dto
*/
public PortStatusDTO createPortStatusDto(final PortStatus portStatus) {
final PortStatusDTO dto = new PortStatusDTO();
@@ -754,8 +751,8 @@ public final class DtoFactory {
/**
* Copies the specified snippet.
*
- * @param originalSnippet
- * @return
+ * @param originalSnippet snippet
+ * @return dto
*/
public FlowSnippetDTO copySnippetContents(FlowSnippetDTO originalSnippet) {
final FlowSnippetDTO copySnippet = new FlowSnippetDTO();
@@ -807,8 +804,8 @@ public final class DtoFactory {
/**
* Creates a PortDTO from the specified Port.
*
- * @param port
- * @return
+ * @param port port
+ * @return dto
*/
public PortDTO createPortDto(final Port port) {
if (port == null) {
@@ -1109,8 +1106,8 @@ public final class DtoFactory {
/**
* Creates a RemoteProcessGroupDTO from the specified RemoteProcessGroup.
*
- * @param group
- * @return
+ * @param group group
+ * @return dto
*/
public RemoteProcessGroupDTO createRemoteProcessGroupDto(final RemoteProcessGroup group) {
if (group == null) {
@@ -1191,8 +1188,8 @@ public final class DtoFactory {
/**
* Creates a ProcessGroupDTO from the specified parent ProcessGroup.
*
- * @param parentGroup
- * @return
+ * @param parentGroup group
+ * @return dto
*/
private ProcessGroupDTO createParentProcessGroupDto(final ProcessGroup parentGroup) {
if (parentGroup == null) {
@@ -1213,8 +1210,8 @@ public final class DtoFactory {
/**
* Creates a ProcessGroupDTO from the specified ProcessGroup.
*
- * @param group
- * @return
+ * @param group group
+ * @return dto
*/
public ProcessGroupDTO createProcessGroupDto(final ProcessGroup group) {
return createProcessGroupDto(group, false);
@@ -1223,9 +1220,9 @@ public final class DtoFactory {
/**
* Creates a ProcessGroupDTO from the specified ProcessGroup.
*
- * @param group
- * @param recurse
- * @return
+ * @param group group
+ * @param recurse recurse
+ * @return dto
*/
public ProcessGroupDTO createProcessGroupDto(final ProcessGroup group, final boolean recurse) {
final ProcessGroupDTO dto = createConciseProcessGroupDto(group);
@@ -1236,9 +1233,8 @@ public final class DtoFactory {
/**
* Creates a ProcessGroupDTO from the specified ProcessGroup.
*
- * @param group
- * @param recurse
- * @return
+ * @param group group
+ * @return dto
*/
private ProcessGroupDTO createConciseProcessGroupDto(final ProcessGroup group) {
if (group == null) {
@@ -1273,9 +1269,9 @@ public final class DtoFactory {
/**
* Creates a ProcessGroupContentDTO from the specified ProcessGroup.
*
- * @param group
- * @param recurse
- * @return
+ * @param group group
+ * @param recurse recurse
+ * @return dto
*/
private FlowSnippetDTO createProcessGroupContentsDto(final ProcessGroup group, final boolean recurse) {
if (group == null) {
@@ -1325,9 +1321,6 @@ public final class DtoFactory {
/**
* Gets the capability description from the specified class.
- *
- * @param cls
- * @return
*/
@SuppressWarnings("deprecation")
private String getCapabilityDescription(final Class<?> cls) {
@@ -1344,9 +1337,6 @@ public final class DtoFactory {
/**
* Gets the tags from the specified class.
- *
- * @param cls
- * @return
*/
@SuppressWarnings("deprecation")
private Set<String> getTags(final Class<?> cls) {
@@ -1371,8 +1361,8 @@ public final class DtoFactory {
/**
* Gets the DocumentedTypeDTOs from the specified classes.
*
- * @param classes
- * @return
+ * @param classes classes
+ * @return dtos
*/
@SuppressWarnings("rawtypes")
public Set<DocumentedTypeDTO> fromDocumentedTypes(final Set<Class> classes) {
@@ -1394,8 +1384,8 @@ public final class DtoFactory {
/**
* Creates a ProcessorDTO from the specified ProcessorNode.
*
- * @param node
- * @return
+ * @param node node
+ * @return dto
*/
public ProcessorDTO createProcessorDto(final ProcessorNode node) {
if (node == null) {
@@ -1454,8 +1444,8 @@ public final class DtoFactory {
/**
* Creates a BulletinBoardDTO for the specified bulletins.
*
- * @param bulletins
- * @return
+ * @param bulletins bulletins
+ * @return dto
*/
public BulletinBoardDTO createBulletinBoardDto(final List<BulletinDTO> bulletins) {
// sort the bulletins
@@ -1494,8 +1484,8 @@ public final class DtoFactory {
/**
* Creates a BulletinDTO for the specified Bulletin.
*
- * @param bulletin
- * @return
+ * @param bulletin bulletin
+ * @return dto
*/
public BulletinDTO createBulletinDto(final Bulletin bulletin) {
final BulletinDTO dto = new BulletinDTO();
@@ -1514,8 +1504,8 @@ public final class DtoFactory {
/**
* Creates a ProvenanceEventNodeDTO for the specified ProvenanceEventLineageNode.
*
- * @param node
- * @return
+ * @param node node
+ * @return dto
*/
public ProvenanceNodeDTO createProvenanceEventNodeDTO(final ProvenanceEventLineageNode node) {
final ProvenanceNodeDTO dto = new ProvenanceNodeDTO();
@@ -1534,8 +1524,8 @@ public final class DtoFactory {
/**
* Creates a FlowFileNodeDTO for the specified LineageNode.
*
- * @param node
- * @return
+ * @param node node
+ * @return dto
*/
public ProvenanceNodeDTO createFlowFileNodeDTO(final LineageNode node) {
final ProvenanceNodeDTO dto = new ProvenanceNodeDTO();
@@ -1551,8 +1541,8 @@ public final class DtoFactory {
/**
* Creates a ProvenanceLinkDTO for the specified LineageEdge.
*
- * @param edge
- * @return
+ * @param edge edge
+ * @return dto
*/
public ProvenanceLinkDTO createProvenanceLinkDTO(final LineageEdge edge) {
final LineageNode source = edge.getSource();
@@ -1570,8 +1560,8 @@ public final class DtoFactory {
/**
* Creates a LineageDTO for the specified Lineage.
*
- * @param computeLineageSubmission
- * @return
+ * @param computeLineageSubmission submission
+ * @return dto
*/
public LineageDTO createLineageDto(final ComputeLineageSubmission computeLineageSubmission) {
// build the lineage dto
@@ -1651,8 +1641,8 @@ public final class DtoFactory {
/**
* Creates a SystemDiagnosticsDTO for the specified SystemDiagnostics.
*
- * @param sysDiagnostics
- * @return
+ * @param sysDiagnostics diags
+ * @return dto
*/
public SystemDiagnosticsDTO createSystemDiagnosticsDto(final SystemDiagnostics sysDiagnostics) {
@@ -1705,9 +1695,9 @@ public final class DtoFactory {
/**
* Creates a StorageUsageDTO from the specified StorageUsage.
*
- * @param identifier
- * @param storageUsage
- * @return
+ * @param identifier id
+ * @param storageUsage usage
+ * @return dto
*/
public SystemDiagnosticsDTO.StorageUsageDTO createStorageUsageDTO(final String identifier, final StorageUsage storageUsage) {
final SystemDiagnosticsDTO.StorageUsageDTO dto = new SystemDiagnosticsDTO.StorageUsageDTO();
@@ -1725,9 +1715,9 @@ public final class DtoFactory {
/**
* Creates a GarbageCollectionDTO from the specified GarbageCollection.
*
- * @param name
- * @param garbageCollection
- * @return
+ * @param name name
+ * @param garbageCollection gc
+ * @return dto
*/
public SystemDiagnosticsDTO.GarbageCollectionDTO createGarbageCollectionDTO(final String name, final GarbageCollection garbageCollection) {
final SystemDiagnosticsDTO.GarbageCollectionDTO dto = new SystemDiagnosticsDTO.GarbageCollectionDTO();
@@ -1740,8 +1730,8 @@ public final class DtoFactory {
/**
* Creates a ProcessorConfigDTO from the specified ProcessorNode.
*
- * @param procNode
- * @return
+ * @param procNode node
+ * @return dto
*/
public ProcessorConfigDTO createProcessorConfigDto(final ProcessorNode procNode) {
if (procNode == null) {
@@ -1818,8 +1808,8 @@ public final class DtoFactory {
/**
* Creates a PropertyDesriptorDTO from the specified PropertyDesriptor.
*
- * @param propertyDescriptor
- * @return
+ * @param propertyDescriptor descriptor
+ * @return dto
*/
public PropertyDescriptorDTO createPropertyDescriptorDto(final PropertyDescriptor propertyDescriptor) {
if (propertyDescriptor == null) {
@@ -1873,9 +1863,7 @@ public final class DtoFactory {
return dto;
}
- //
// Copy methods
- //
public LabelDTO copy(final LabelDTO original) {
final LabelDTO copy = new LabelDTO();
copy.setId(original.getId());
@@ -2164,11 +2152,11 @@ public final class DtoFactory {
/**
*
- * @param original
+ * @param original orig
* @param deep if <code>true</code>, all Connections, ProcessGroups, Ports, Processors, etc. will be copied. If <code>false</code>, the copy will have links to the same objects referenced by
* <code>original</code>.
*
- * @return
+ * @return dto
*/
private FlowSnippetDTO copy(final FlowSnippetDTO original, final boolean deep) {
final FlowSnippetDTO copy = new FlowSnippetDTO();
@@ -2294,8 +2282,8 @@ public final class DtoFactory {
/**
* Factory method for creating a new RevisionDTO based on this controller.
*
- * @param lastMod
- * @return
+ * @param lastMod mod
+ * @return dto
*/
public RevisionDTO createRevisionDTO(FlowModification lastMod) {
final Revision revision = lastMod.getRevision();
@@ -2312,8 +2300,8 @@ public final class DtoFactory {
/**
* Factory method for creating a new user transfer object.
*
- * @param user
- * @return
+ * @param user user
+ * @return dto
*/
public UserDTO createUserDTO(NiFiUser user) {
// convert the users authorities
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java
index b75d13d..0392ca4 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/package-info.java
@@ -16,41 +16,26 @@
*/
/**
* <p>
- * The NiFi REST API allows clients to obtain and update configuration and
- * status information pertaining to an instance of NiFi. The links below detail
- * each resource. Follow the link to get more information about the resource
- * including the supported HTTP methods and the expected parameters.</p>
+ * The NiFi REST API allows clients to obtain and update configuration and status information pertaining to an instance of NiFi. The links below detail each resource. Follow the link to get more
+ * information about the resource including the supported HTTP methods and the expected parameters.</p>
*
* <p>
- * Additionally, the documentation for each resource will describe what type of
- * data should be returned from a successful invocation. However, if the request
- * is not successful one of the follow status codes should be returned:</p>
+ * Additionally, the documentation for each resource will describe what type of data should be returned from a successful invocation. However, if the request is not successful one of the follow status
+ * codes should be returned:</p>
*
* <ul>
- * <li>400 (Bad Request) - A 400 status code will be returned when NiFi is
- * unable to complete the request because it was invalid. The request should not
- * be retried without modification.</li>
- * <li>401 (Unathorized) - A 401 status code indicates that the user is not
- * known to this NiFi instance. The user may submit an account request.</li>
- * <li>403 (Forbidden) - A 403 status code indicates that the user is known to
- * this NiFi instance and they do not have authority to perform the requested
- * action.</li>
- * <li>404 (Not Found) - A 404 status code will be returned when the desired
- * resource does not exist.</li>
- * <li>409 (Conflict) - NiFi employs an optimistic locking strategy where the
- * client must include a revision in their request when performing an update. If
- * the specified revision does not match the current base revision a 409 status
- * code is returned. Additionally, a 409 is used when the state of the system
- * does not allow for the request at that time. This same request may be
- * successful later if the system is in a different state (e.g. cannot delete a
- * processor because it is currently running).</li>
- * <li>500 (Internal Server Error) - A 500 status code indicates that an
- * unexpected error has occurred.</li>
+ * <li>400 (Bad Request) - A 400 status code will be returned when NiFi is unable to complete the request because it was invalid. The request should not be retried without modification.</li>
+ * <li>401 (Unathorized) - A 401 status code indicates that the user is not known to this NiFi instance. The user may submit an account request.</li>
+ * <li>403 (Forbidden) - A 403 status code indicates that the user is known to this NiFi instance and they do not have authority to perform the requested action.</li>
+ * <li>404 (Not Found) - A 404 status code will be returned when the desired resource does not exist.</li>
+ * <li>409 (Conflict) - NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. If the specified revision does not match the
+ * current base revision a 409 status code is returned. Additionally, a 409 is used when the state of the system does not allow for the request at that time. This same request may be successful later
+ * if the system is in a different state (e.g. cannot delete a processor because it is currently running).</li>
+ * <li>500 (Internal Server Error) - A 500 status code indicates that an unexpected error has occurred.</li>
* </ul>
*
* <p>
- * Most unsuccessful requests will include a description of the problem in the
- * entity body of the response.</p>
+ * Most unsuccessful requests will include a description of the problem in the entity body of the response.</p>
*
* <p>
* The context path for the REST API is /nifi-api</p>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java
index 98bfbeb..c34ec59 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/BulletinBoardPatternParameter.java
@@ -20,8 +20,7 @@ import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
/**
- * Parameter class that auto [ap|pre]pends '.*' to the specified pattern to make
- * user input more user friendly.
+ * Parameter class that auto [ap|pre]pends '.*' to the specified pattern to make user input more user friendly.
*/
public class BulletinBoardPatternParameter {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java
index c0a39c2..85a0a29 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/ClientIdParameter.java
@@ -20,8 +20,7 @@ import java.util.UUID;
import org.apache.commons.lang3.StringUtils;
/**
- * Class for parsing handling client ids. If the client id is not specified, one
- * will be generated.
+ * Class for parsing handling client ids. If the client id is not specified, one will be generated.
*/
public class ClientIdParameter {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java
index 726f031..3480cd0 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DateTimeParameter.java
@@ -22,8 +22,7 @@ import java.util.Date;
import java.util.Locale;
/**
- * Class for parsing integer parameters and providing a user friendly error
- * message.
+ * Class for parsing integer parameters and providing a user friendly error message.
*/
public class DateTimeParameter {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java
index eba046b..8ea7e38 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/DoubleParameter.java
@@ -17,8 +17,7 @@
package org.apache.nifi.web.api.request;
/**
- * Class for parsing double parameters and providing a user friendly error
- * message.
+ * Class for parsing double parameters and providing a user friendly error message.
*/
public class DoubleParameter {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java
index cfbdbd8..76e8087 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/IntegerParameter.java
@@ -17,8 +17,7 @@
package org.apache.nifi.web.api.request;
/**
- * Class for parsing integer parameters and providing a user friendly error
- * message.
+ * Class for parsing integer parameters and providing a user friendly error message.
*/
public class IntegerParameter {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java
index eef28fe..ba2def9 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/api/request/LongParameter.java
@@ -17,8 +17,7 @@
package org.apache.nifi.web.api.request;
/**
- * Class for parsing long parameters and providing a user friendly error
- * message.
+ * Class for parsing long parameters and providing a user friendly error message.
*/
public class LongParameter {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java
index de54dd2..a853aca 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/contextlistener/ApplicationStartupContextListener.java
@@ -32,12 +32,8 @@ import org.springframework.context.ApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;
/**
- * Application context listener for starting the application. If the application
- * is configured for a standalone environment or the application is a node in a
- * clustered environment then a flow controller is created and managed.
- * Otherwise, we assume the application is running as the cluster manager in a
- * clustered environment. In this case, the cluster manager is created and
- * managed.
+ * Application context listener for starting the application. If the application is configured for a standalone environment or the application is a node in a clustered environment then a flow
+ * controller is created and managed. Otherwise, we assume the application is running as the cluster manager in a clustered environment. In this case, the cluster manager is created and managed.
*
*/
public class ApplicationStartupContextListener implements ServletContextListener {
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java
index 0f384e3..b614f0a 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/controller/ControllerFacade.java
@@ -118,9 +118,6 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.security.access.AccessDeniedException;
-/**
- *
- */
public class ControllerFacade {
private static final Logger logger = LoggerFactory.getLogger(ControllerFacade.class);
@@ -144,8 +141,8 @@ public class ControllerFacade {
/**
* Returns the group id that contains the specified processor.
*
- * @param processorId
- * @return
+ * @param processorId processor id
+ * @return group id
*/
public String findProcessGroupIdForProcessor(String processorId) {
final ProcessGroup rootGroup = flowController.getGroup(flowController.getRootGroupId());
@@ -160,7 +157,7 @@ public class ControllerFacade {
/**
* Sets the name of this controller.
*
- * @param name
+ * @param name name
*/
public void setName(String name) {
flowController.setName(name);
@@ -169,7 +166,7 @@ public class ControllerFacade {
/**
* Sets the comments of this controller.
*
- * @param comments
+ * @param comments comments
*/
public void setComments(String comments) {
flowController.setComments(comments);
@@ -178,7 +175,7 @@ public class ControllerFacade {
/**
* Sets the max timer driven thread count of this controller.
*
- * @param maxTimerDrivenThreadCount
+ * @param maxTimerDrivenThreadCount count
*/
public void setMaxTimerDrivenThreadCount(int maxTimerDrivenThreadCount) {
flowController.setMaxTimerDrivenThreadCount(maxTimerDrivenThreadCount);
@@ -187,7 +184,7 @@ public class ControllerFacade {
/**
* Sets the max event driven thread count of this controller.
*
- * @param maxEventDrivenThreadCount
+ * @param maxEventDrivenThreadCount count
*/
public void setMaxEventDrivenThreadCount(int maxEventDrivenThreadCount) {
flowController.setMaxEventDrivenThreadCount(maxEventDrivenThreadCount);
@@ -196,7 +193,7 @@ public class ControllerFacade {
/**
* Gets the root group id.
*
- * @return
+ * @return group id
*/
public String getRootGroupId() {
return flowController.getRootGroupId();
@@ -205,7 +202,7 @@ public class ControllerFacade {
/**
* Gets the input ports on the root group.
*
- * @return
+ * @return input ports
*/
public Set<RootGroupPort> getInputPorts() {
final Set<RootGroupPort> inputPorts = new HashSet<>();
@@ -221,7 +218,7 @@ public class ControllerFacade {
/**
* Gets the output ports on the root group.
*
- * @return
+ * @return output ports
*/
public Set<RootGroupPort> getOutputPorts() {
final Set<RootGroupPort> outputPorts = new HashSet<>();
@@ -237,9 +234,9 @@ public class ControllerFacade {
/**
* Returns the status history for the specified processor.
*
- * @param groupId
- * @param processorId
- * @return
+ * @param groupId group id
+ * @param processorId processor id
+ * @return status history
*/
public StatusHistoryDTO getProcessorStatusHistory(final String groupId, final String processorId) {
return flowController.getProcessorStatusHistory(processorId);
@@ -248,9 +245,9 @@ public class ControllerFacade {
/**
* Returns the status history for the specified connection.
*
- * @param groupId
- * @param connectionId
- * @return
+ * @param groupId group id
+ * @param connectionId connection id
+ * @return status history
*/
public StatusHistoryDTO getConnectionStatusHistory(final String groupId, final String connectionId) {
return flowController.getConnectionStatusHistory(connectionId);
@@ -259,8 +256,8 @@ public class ControllerFacade {
/**
* Returns the status history for the specified process group.
*
- * @param groupId
- * @return
+ * @param groupId group id
+ * @return status history
*/
public StatusHistoryDTO getProcessGroupStatusHistory(final String groupId) {
return flowController.getProcessGroupStatusHistory(groupId);
@@ -269,9 +266,9 @@ public class ControllerFacade {
/**
* Returns the status history for the specified remote process group.
*
- * @param groupId
- * @param remoteProcessGroupId
- * @return
+ * @param groupId group id
+ * @param remoteProcessGroupId remote process group id
+ * @return status history
*/
public StatusHistoryDTO getRemoteProcessGroupStatusHistory(final String groupId, final String remoteProcessGroupId) {
return flowController.getRemoteProcessGroupStatusHistory(remoteProcessGroupId);
@@ -280,12 +277,15 @@ public class ControllerFacade {
/**
* Get the node id of this controller.
*
- * @return
+ * @return node identifier
*/
public NodeIdentifier getNodeId() {
return flowController.getNodeId();
}
+ /**
+ * @return true if is clustered
+ */
public boolean isClustered() {
return flowController.isClustered();
}
@@ -293,7 +293,7 @@ public class ControllerFacade {
/**
* Gets the name of this controller.
*
- * @return
+ * @return name
*/
public String getName() {
return flowController.getName();
@@ -306,7 +306,7 @@ public class ControllerFacade {
/**
* Gets the comments of this controller.
*
- * @return
+ * @return comments
*/
public String getComments() {
return flowController.getComments();
@@ -315,7 +315,7 @@ public class ControllerFacade {
/**
* Gets the max timer driven thread count of this controller.
*
- * @return
+ * @return count
*/
public int getMaxTimerDrivenThreadCount() {
return flowController.getMaxTimerDrivenThreadCount();
@@ -324,7 +324,7 @@ public class ControllerFacade {
/**
* Gets the max event driven thread count of this controller.
*
- * @return
+ * @return count
*/
public int getMaxEventDrivenThreadCount() {
return flowController.getMaxEventDrivenThreadCount();
@@ -333,7 +333,7 @@ public class ControllerFacade {
/**
* Gets the FlowFileProcessor types that this controller supports.
*
- * @return
+ * @return types
*/
public Set<DocumentedTypeDTO> getFlowFileProcessorTypes() {
return dtoFactory.fromDocumentedTypes(ExtensionManager.getExtensions(Processor.class));
@@ -342,7 +342,7 @@ public class ControllerFacade {
/**
* Gets the FlowFileComparator types that this controller supports.
*
- * @return
+ * @return the FlowFileComparator types that this controller supports
*/
public Set<DocumentedTypeDTO> getFlowFileComparatorTypes() {
return dtoFactory.fromDocumentedTypes(ExtensionManager.getExtensions(FlowFilePrioritizer.class));
@@ -351,9 +351,9 @@ public class ControllerFacade {
/**
* Returns whether the specified type implements the specified serviceType.
*
- * @param baseType
- * @param type
- * @return
+ * @param serviceType type
+ * @param type type
+ * @return whether the specified type implements the specified serviceType
*/
private boolean implementsServiceType(final String serviceType, final Class type) {
final List<Class<?>> interfaces = ClassUtils.getAllInterfaces(type);
@@ -369,8 +369,8 @@ public class ControllerFacade {
/**
* Gets the ControllerService types that this controller supports.
*
- * @param serviceType
- * @return
+ * @param serviceType type
+ * @return the ControllerService types that this controller supports
*/
public Set<DocumentedTypeDTO> getControllerServiceTypes(final String serviceType) {
final Set<Class> serviceImplementations = ExtensionManager.getExtensions(ControllerService.class);
@@ -396,7 +396,7 @@ public class ControllerFacade {
/**
* Gets the ReportingTask types that this controller supports.
*
- * @return
+ * @return the ReportingTask types that this controller supports
*/
public Set<DocumentedTypeDTO> getReportingTaskTypes() {
return dtoFactory.fromDocumentedTypes(ExtensionManager.getExtensions(ReportingTask.class));
@@ -405,7 +405,7 @@ public class ControllerFacade {
/**
* Gets the counters for this controller.
*
- * @return
+ * @return the counters for this controller
*/
public List<Counter> getCounters() {
return flowController.getCounters();
@@ -414,8 +414,8 @@ public class ControllerFacade {
/**
* Resets the counter with the specified id.
*
- * @param id
- * @return
+ * @param id id
+ * @return the counter with the specified id
*/
public Counter resetCounter(final String id) {
final Counter counter = flowController.resetCounter(id);
@@ -430,7 +430,7 @@ public class ControllerFacade {
/**
* Gets the status of this controller.
*
- * @return
+ * @return the status of this controller
*/
public ControllerStatusDTO getControllerStatus() {
final ProcessGroup rootGroup = flowController.getGroup(flowController.getRootGroupId());
@@ -462,8 +462,8 @@ public class ControllerFacade {
/**
* Gets the status for the specified process group.
*
- * @param groupId
- * @return
+ * @param groupId group id
+ * @return the status for the specified process group
*/
public ProcessGroupStatusDTO getProcessGroupStatus(final String groupId) {
final ProcessGroupStatus processGroupStatus = flowController.getGroupStatus(groupId);
@@ -476,7 +476,7 @@ public class ControllerFacade {
/**
* Gets the BulletinRepository.
*
- * @return
+ * @return the BulletinRepository
*/
public BulletinRepository getBulletinRepository() {
return flowController.getBulletinRepository();
@@ -485,7 +485,7 @@ public class ControllerFacade {
/**
* Saves the state of the flow controller.
*
- * @throws NiFiCoreException
+ * @throws NiFiCoreException ex
*/
public void save() throws NiFiCoreException {
// save the flow controller
@@ -494,40 +494,36 @@ public class ControllerFacade {
}
/**
- * Returns the socket port that the Cluster Manager is listening on for
- * Site-to-Site communications
+ * Returns the socket port that the Cluster Manager is listening on for Site-to-Site communications
*
- * @return
+ * @return the socket port that the Cluster Manager is listening on for Site-to-Site communications
*/
public Integer getClusterManagerRemoteSiteListeningPort() {
return flowController.getClusterManagerRemoteSiteListeningPort();
}
/**
- * Indicates whether or not Site-to-Site communications with the Cluster
- * Manager are secure
+ * Indicates whether or not Site-to-Site communications with the Cluster Manager are secure
*
- * @return
+ * @return whether or not Site-to-Site communications with the Cluster Manager are secure
*/
public Boolean isClusterManagerRemoteSiteCommsSecure() {
return flowController.isClusterManagerRemoteSiteCommsSecure();
}
/**
- * Returns the socket port that the local instance is listening on for
- * Site-to-Site communications
+ * Returns the socket port that the local instance is listening on for Site-to-Site communications
*
- * @return
+ * @return the socket port that the local instance is listening on for Site-to-Site communications
*/
public Integer getRemoteSiteListeningPort() {
return flowController.getRemoteSiteListeningPort();
}
/**
- * Indicates whether or not Site-to-Site communications with the local
- * instance are secure
+ * Indicates whether or not Site-to-Site communications with the local instance are secure
*
- * @return
+ * @return whether or not Site-to-Site communications with the local instance are secure
*/
public Boolean isRemoteSiteCommsSecure() {
return flowController.isRemoteSiteCommsSecure();
@@ -536,7 +532,7 @@ public class ControllerFacade {
/**
* Returns a SystemDiagnostics that describes the current state of the node
*
- * @return
+ * @return a SystemDiagnostics that describes the current state of the node
*/
public SystemDiagnostics getSystemDiagnostics() {
return flowController.getSystemDiagnostics();
@@ -545,7 +541,7 @@ public class ControllerFacade {
/**
* Gets the available options for searching provenance.
*
- * @return
+ * @return the available options for searching provenance
*/
public ProvenanceOptionsDTO getProvenanceSearchOptions() {
final ProvenanceEventRepository provenanceRepository = flowController.getProvenanceRepository();
@@ -578,8 +574,8 @@ public class ControllerFacade {
/**
* Submits a provenance query.
*
- * @param provenanceDto
- * @return
+ * @param provenanceDto dto
+ * @return provenance info
*/
public ProvenanceDTO submitProvenance(ProvenanceDTO provenanceDto) {
final ProvenanceRequestDTO requestDto = provenanceDto.getRequest();
@@ -632,8 +628,8 @@ public class ControllerFacade {
/**
* Retrieves the results of a provenance query.
*
- * @param provenanceId
- * @return
+ * @param provenanceId id
+ * @return the results of a provenance query
*/
public ProvenanceDTO getProvenanceQuery(String provenanceId) {
try {
@@ -717,8 +713,8 @@ public class ControllerFacade {
/**
* Submits the specified lineage request.
*
- * @param lineageDto
- * @return
+ * @param lineageDto dto
+ * @return updated lineage
*/
public LineageDTO submitLineage(LineageDTO lineageDto) {
final LineageRequestDTO requestDto = lineageDto.getRequest();
@@ -746,8 +742,8 @@ public class ControllerFacade {
/**
* Gets the lineage with the specified id.
*
- * @param lineageId
- * @return
+ * @param lineageId id
+ * @return the lineage with the specified id
*/
public LineageDTO getLineage(final String lineageId) {
// get the query to the provenance repository
@@ -765,7 +761,7 @@ public class ControllerFacade {
/**
* Deletes the query with the specified id.
*
- * @param provenanceId
+ * @param provenanceId id
*/
public void deleteProvenanceQuery(final String provenanceId) {
// get the query to the provenance repository
@@ -779,7 +775,7 @@ public class ControllerFacade {
/**
* Deletes the lineage with the specified id.
*
- * @param lineageId
+ * @param lineageId id
*/
public void deleteLineage(final String lineageId) {
// get the query to the provenance repository
@@ -793,10 +789,10 @@ public class ControllerFacade {
/**
* Gets the content for the specified claim.
*
- * @param eventId
- * @param uri
- * @param contentDirection
- * @return
+ * @param eventId event id
+ * @param uri uri
+ * @param contentDirection direction
+ * @return the content for the specified claim
*/
public DownloadableContent getContent(final Long eventId, final String uri, final ContentDirection contentDirection) {
try {
@@ -856,8 +852,8 @@ public class ControllerFacade {
/**
* Submits a replay request for the specified event id.
*
- * @param eventId
- * @return
+ * @param eventId event id
+ * @return provenance event
*/
public ProvenanceEventDTO submitReplay(final Long eventId) {
try {
@@ -885,8 +881,8 @@ public class ControllerFacade {
/**
* Get the provenance event with the specified event id.
*
- * @param eventId
- * @return
+ * @param eventId event id
+ * @return the provenance event with the specified event id
*/
public ProvenanceEventDTO getProvenanceEvent(final Long eventId) {
try {
@@ -905,8 +901,8 @@ public class ControllerFacade {
/**
* Creates a ProvenanceEventDTO for the specified ProvenanceEventRecord.
*
- * @param event
- * @return
+ * @param event event
+ * @return event
*/
private ProvenanceEventDTO createProvenanceEventDto(final ProvenanceEventRecord event) {
// convert the attributes
@@ -1018,12 +1014,6 @@ public class ControllerFacade {
return dto;
}
- /**
- * Gets the name for the component with the specified id.
- *
- * @param dto
- * @return
- */
private void setComponentDetails(final ProvenanceEventDTO dto) {
final ProcessGroup root = flowController.getGroup(flowController.getRootGroupId());
@@ -1037,8 +1027,8 @@ public class ControllerFacade {
/**
* Searches this controller for the specified term.
*
- * @param search
- * @return
+ * @param search search
+ * @return result
*/
public SearchResultsDTO search(final String search) {
final ProcessGroup rootGroup = flowController.getGroup(flowController.getRootGroupId());
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java
index 52cba66..bb18b1b 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ControllerServiceDAO.java
@@ -81,8 +81,7 @@ public interface ControllerServiceDAO {
void verifyUpdate(ControllerServiceDTO controllerServiceDTO);
/**
- * Determines whether the referencing component of the specified controller
- * service can be updated.
+ * Determines whether the referencing component of the specified controller service can be updated.
*
* @param controllerServiceId service id
* @param scheduledState scheduled state
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java
index 33ae2bd..1df13e5 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/PortDAO.java
@@ -25,7 +25,7 @@ public interface PortDAO {
/**
* @param groupId group id
- * @param portId port id
+ * @param portId port id
* @return Determines if the specified port exists in the specified group
*/
boolean hasPort(String groupId, String portId);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java
index 2cd8506..3655083 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessGroupDAO.java
@@ -20,16 +20,13 @@ import java.util.Set;
import org.apache.nifi.groups.ProcessGroup;
import org.apache.nifi.web.api.dto.ProcessGroupDTO;
-/**
- *
- */
public interface ProcessGroupDAO {
/**
* Determines if the specified remote process group exists.
*
- * @param groupId
- * @return
+ * @param groupId id
+ * @return true if group exists
*/
boolean hasProcessGroup(String groupId);
@@ -61,7 +58,7 @@ public interface ProcessGroupDAO {
/**
* Verifies the specified process group can be modified.
*
- * @param processGroupDTO
+ * @param processGroupDTO dto
*/
void verifyUpdate(ProcessGroupDTO processGroupDTO);
@@ -76,7 +73,7 @@ public interface ProcessGroupDAO {
/**
* Verifies the specified process group can be removed.
*
- * @param groupId
+ * @param groupId id
*/
void verifyDelete(String groupId);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java
index 8f2416a..30cce5d 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ProcessorDAO.java
@@ -64,8 +64,7 @@ public interface ProcessorDAO {
void verifyUpdate(String groupId, ProcessorDTO processorDTO);
/**
- * Updates the configuration for the processor using the specified
- * processorDTO.
+ * Updates the configuration for the processor using the specified processorDTO.
*
* @param groupId group id
* @param processorDTO processor
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java
index cf1ac30..d9eafb0 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/RemoteProcessGroupDAO.java
@@ -100,7 +100,7 @@ public interface RemoteProcessGroupDAO {
* @param groupId id
* @param remoteProcessGroupId id
* @param remoteProcessGroupPort port
- * @return
+ * @return updated group port
*/
RemoteGroupPort updateRemoteProcessGroupInputPort(String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort);
@@ -110,7 +110,7 @@ public interface RemoteProcessGroupDAO {
* @param groupId group id
* @param remoteProcessGroupId group id
* @param remoteProcessGroupPort port
- * @return
+ * @return group port
*/
RemoteGroupPort updateRemoteProcessGroupOutputPort(String groupId, String remoteProcessGroupId, RemoteProcessGroupPortDTO remoteProcessGroupPort);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java
index cbdd4a1..43852c2 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/ReportingTaskDAO.java
@@ -21,16 +21,13 @@ import org.apache.nifi.controller.ReportingTaskNode;
import org.apache.nifi.web.api.dto.ReportingTaskDTO;
-/**
- *
- */
public interface ReportingTaskDAO {
/**
* Determines if the specified reporting task exists.
*
- * @param reportingTaskId
- * @return
+ * @param reportingTaskId id
+ * @return true if reporting task exists
*/
boolean hasReportingTask(String reportingTaskId);
@@ -68,14 +65,14 @@ public interface ReportingTaskDAO {
/**
* Determines whether this reporting task can be updated.
*
- * @param reportingTaskDTO
+ * @param reportingTaskDTO dto
*/
void verifyUpdate(ReportingTaskDTO reportingTaskDTO);
/**
* Determines whether this reporting task can be removed.
*
- * @param reportingTaskId
+ * @param reportingTaskId id
*/
void verifyDelete(String reportingTaskId);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java
index 9ea60cb..a3cbed4 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/SnippetDAO.java
@@ -23,8 +23,7 @@ import org.apache.nifi.web.api.dto.SnippetDTO;
public interface SnippetDAO {
/**
- * Copies the specified snippet and added the copy to the flow in the
- * specified group.
+ * Copies the specified snippet and added the copy to the flow in the specified group.
*
* @param groupId group id
* @param snippetId snippet id
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java
index 5264119..014a607 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/TemplateDAO.java
@@ -21,9 +21,6 @@ import org.apache.nifi.controller.Template;
import org.apache.nifi.web.api.dto.FlowSnippetDTO;
import org.apache.nifi.web.api.dto.TemplateDTO;
-/**
- *
- */
public interface TemplateDAO {
/**
@@ -37,19 +34,19 @@ public interface TemplateDAO {
/**
* Import the specified template.
*
- * @param templateDTO
- * @return
+ * @param templateDTO dto
+ * @return template
*/
Template importTemplate(TemplateDTO templateDTO);
/**
* Instantiate the corresponding template.
*
- * @param groupId
- * @param originX
- * @param originY
- * @param templateId
- * @return
+ * @param groupId group id
+ * @param originX x
+ * @param originY y
+ * @param templateId template id
+ * @return flow snippet
*/
FlowSnippetDTO instantiateTemplate(String groupId, Double originX, Double originY, String templateId);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java
index a2c9567..165e7a5 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/ComponentDAO.java
@@ -20,17 +20,14 @@ import org.apache.nifi.controller.FlowController;
import org.apache.nifi.groups.ProcessGroup;
import org.apache.nifi.web.ResourceNotFoundException;
-/**
- *
- */
public abstract class ComponentDAO {
/**
* Returns whether the specified object is not null.
*
- * @param <T>
- * @param object
- * @return
+ * @param <T> type
+ * @param object object
+ * @return true if the specified object is not null
*/
protected <T> boolean isNotNull(T object) {
return object != null;
@@ -39,9 +36,9 @@ public abstract class ComponentDAO {
/**
* Returns whether any of the specified objects are not null.
*
- * @param <T>
- * @param objects
- * @return
+ * @param <T> type
+ * @param objects objects
+ * @return true if any of the specified objects are not null
*/
protected <T> boolean isAnyNotNull(T... objects) {
for (final T object : objects) {
@@ -56,9 +53,9 @@ public abstract class ComponentDAO {
/**
* Locates the specified ProcessGroup.
*
- * @param flowController
- * @param groupId
- * @return
+ * @param flowController controller
+ * @param groupId id
+ * @return group
*/
protected ProcessGroup locateProcessGroup(FlowController flowController, String groupId) {
ProcessGroup group = flowController.getGroup(groupId);
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e1160f59/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java
----------------------------------------------------------------------
diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java
index a984867..5fbc393 100644
--- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java
+++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-api/src/main/java/org/apache/nifi/web/dao/impl/StandardConnectionDAO.java
@@ -63,23 +63,11 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
return connection;
}
- /**
- * Gets the specified connection.
- *
- * @return The connections
- */
@Override
public Connection getConnection(final String groupId, final String id) {
return locateConnection(groupId, id);
}
- /**
- * Gets the connections for the specified source processor.
- *
- * @param groupId
- * @param processorId
- * @return
- */
@Override
public Set<Connection> getConnectionsForSource(final String groupId, final String processorId) {
final Set<Connection> connections = new HashSet<>(getConnections(groupId));
@@ -93,13 +81,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
return connections;
}
- /**
- * Determines if the specified connection exists. Returns false when either
- * the group or connection do not exist.
- *
- * @param id
- * @return
- */
@Override
public boolean hasConnection(final String groupId, final String id) {
final ProcessGroup group = flowController.getGroup(groupId);
@@ -111,11 +92,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
return group.getConnection(id) != null;
}
- /**
- * Gets all of the connections.
- *
- * @return The connections
- */
@Override
public Set<Connection> getConnections(final String groupId) {
final ProcessGroup group = locateProcessGroup(flowController, groupId);
@@ -124,9 +100,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
/**
* Configures the specified connection using the specified dto.
- *
- * @param connection
- * @param connectionDTO
*/
private void configureConnection(Connection connection, ConnectionDTO connectionDTO) {
// validate flow file comparators/prioritizers
@@ -181,10 +154,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
/**
* Validates the proposed processor configuration.
- *
- * @param processorNode
- * @param config
- * @return
*/
private List<String> validateProposedConfiguration(final String groupId, final ConnectionDTO connectionDTO) {
List<String> validationErrors = new ArrayList<>();
@@ -233,12 +202,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
return validationErrors;
}
- /**
- * Creates a new Connection.
- *
- * @param connectionDTO The connection DTO
- * @return The connection
- */
@Override
public Connection createConnection(final String groupId, final ConnectionDTO connectionDTO) {
final ProcessGroup group = locateProcessGroup(flowController, groupId);
@@ -371,12 +334,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
}
}
- /**
- * Updates the specified Connection.
- *
- * @param connectionDTO The connection DTO
- * @return The connection
- */
@Override
public Connection updateConnection(final String groupId, final ConnectionDTO connectionDTO) {
final ProcessGroup group = locateProcessGroup(flowController, groupId);
@@ -500,11 +457,6 @@ public class StandardConnectionDAO extends ComponentDAO implements ConnectionDAO
connection.verifyCanDelete();
}
- /**
- * Deletes the specified Connection.
- *
- * @param id The id of the connection
- */
@Override
public void deleteConnection(final String groupId, final String id) {
final ProcessGroup group = locateProcessGroup(flowController, groupId);