NIFI-271 checkpoint
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/888254b2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/888254b2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/888254b2 Branch: refs/heads/develop Commit: 888254b2a18174af29d1bd70bf2ce420f41739ba Parents: b612b6b Author: joewitt <[email protected]> Authored: Wed Apr 22 11:46:26 2015 -0400 Committer: joewitt <[email protected]> Committed: Wed Apr 22 11:46:26 2015 -0400 ---------------------------------------------------------------------- .../nifi-framework/nifi-administration/pom.xml | 8 + .../org/apache/nifi/admin/RepositoryUtils.java | 7 +- .../nifi/admin/UserDataSourceFactoryBean.java | 12 - .../org/apache/nifi/admin/dao/ActionDAO.java | 28 +- .../org/apache/nifi/admin/dao/AuthorityDAO.java | 19 +- .../java/org/apache/nifi/admin/dao/UserDAO.java | 52 +- .../nifi/admin/dao/impl/StandardActionDAO.java | 93 +--- .../apache/nifi/admin/service/AuditService.java | 28 +- .../apache/nifi/admin/service/UserService.java | 70 ++- .../service/action/AbstractUserAction.java | 18 +- .../service/action/AdministrationAction.java | 8 +- .../service/action/AuthorizeUserAction.java | 6 +- .../admin/service/action/DeleteUserAction.java | 2 +- .../service/action/FindUserByIdAction.java | 5 +- .../service/action/SeedUserAccountsAction.java | 4 +- .../service/impl/StandardAuditService.java | 11 - .../admin/service/impl/StandardUserService.java | 29 +- .../admin/service/transaction/Transaction.java | 6 +- .../AuthorityProviderFactoryBean.java | 47 +- .../org/apache/nifi/user/AccountStatus.java | 4 +- .../java/org/apache/nifi/user/NiFiUser.java | 2 +- .../service/action/AuthorizeUserActionTest.java | 22 +- .../service/action/CreateUserActionTest.java | 14 +- .../service/action/DisableUserActionTest.java | 11 +- .../action/InvalidateUserAccountActionTest.java | 9 +- .../action/RequestUserAccountActionTest.java | 6 +- .../action/SeedUserAccountsActionTest.java | 3 +- .../action/SetUserAuthoritiesActionTest.java | 6 +- .../protocol/ClusterManagerProtocolSender.java | 22 +- .../cluster/protocol/ConnectionRequest.java | 6 +- .../cluster/protocol/ConnectionResponse.java | 54 +- .../apache/nifi/cluster/protocol/Heartbeat.java | 19 +- .../nifi/cluster/protocol/NodeBulletins.java | 2 +- .../nifi/cluster/protocol/NodeIdentifier.java | 102 ++-- .../cluster/protocol/NodeProtocolSender.java | 43 +- .../nifi/cluster/protocol/ProtocolContext.java | 12 +- .../cluster/protocol/ProtocolException.java | 9 +- .../nifi/cluster/protocol/ProtocolHandler.java | 17 +- .../nifi/cluster/protocol/ProtocolListener.java | 31 +- .../protocol/ProtocolMessageMarshaller.java | 7 +- .../protocol/ProtocolMessageUnmarshaller.java | 13 +- .../nifi/cluster/protocol/StandardDataFlow.java | 34 +- .../UnknownServiceAddressException.java | 9 +- .../impl/ClusterManagerProtocolSenderImpl.java | 101 ++-- .../ClusterManagerProtocolSenderListener.java | 28 +- .../protocol/impl/ClusterServiceDiscovery.java | 5 +- .../protocol/impl/ClusterServiceLocator.java | 124 ++--- .../impl/ClusterServicesBroadcaster.java | 86 ++-- .../protocol/impl/CopyingInputStream.java | 25 +- .../impl/MulticastProtocolListener.java | 66 +-- .../protocol/impl/NodeProtocolSenderImpl.java | 61 ++- .../impl/NodeProtocolSenderListener.java | 16 +- .../protocol/impl/SocketProtocolListener.java | 52 +- .../protocol/jaxb/JaxbProtocolContext.java | 21 +- .../jaxb/message/AdaptedConnectionRequest.java | 7 +- .../jaxb/message/AdaptedConnectionResponse.java | 19 +- .../protocol/jaxb/message/AdaptedCounter.java | 11 +- .../protocol/jaxb/message/AdaptedDataFlow.java | 9 +- .../protocol/jaxb/message/AdaptedHeartbeat.java | 13 +- .../jaxb/message/AdaptedNodeBulletins.java | 11 +- .../jaxb/message/AdaptedNodeIdentifier.java | 13 +- .../jaxb/message/ConnectionRequestAdapter.java | 4 +- .../jaxb/message/ConnectionResponseAdapter.java | 12 +- .../protocol/jaxb/message/DataFlowAdapter.java | 10 +- .../protocol/jaxb/message/HeartbeatAdapter.java | 14 +- .../jaxb/message/JaxbProtocolUtils.java | 6 +- .../jaxb/message/NodeBulletinsAdapter.java | 10 +- .../jaxb/message/NodeIdentifierAdapter.java | 6 +- .../protocol/jaxb/message/ObjectFactory.java | 35 +- .../message/ConnectionRequestMessage.java | 11 +- .../message/ConnectionResponseMessage.java | 27 +- .../ControllerStartupFailureMessage.java | 7 +- .../protocol/message/DisconnectMessage.java | 8 +- .../protocol/message/ExceptionMessage.java | 9 +- .../protocol/message/FlowRequestMessage.java | 6 +- .../protocol/message/FlowResponseMessage.java | 4 +- .../protocol/message/HeartbeatMessage.java | 4 +- .../message/MulticastProtocolMessage.java | 17 +- .../protocol/message/NodeBulletinsMessage.java | 4 +- .../cluster/protocol/message/PingMessage.java | 13 +- .../message/PrimaryRoleAssignmentMessage.java | 4 +- .../protocol/message/ProtocolMessage.java | 22 +- .../message/ReconnectionFailureMessage.java | 8 +- .../message/ReconnectionRequestMessage.java | 19 +- .../message/ReconnectionResponseMessage.java | 2 +- .../message/ServiceBroadcastMessage.java | 9 +- .../MulticastConfigurationFactoryBean.java | 12 +- .../ServerSocketConfigurationFactoryBean.java | 13 +- .../spring/SocketConfigurationFactoryBean.java | 16 +- .../ClusterManagerProtocolSenderImplTest.java | 58 +-- .../impl/ClusterServiceDiscoveryTest.java | 56 +-- .../impl/ClusterServiceLocatorTest.java | 64 +-- .../impl/ClusterServicesBroadcasterTest.java | 63 ++- .../impl/MulticastProtocolListenerTest.java | 59 ++- .../impl/NodeProtocolSenderImplTest.java | 83 ++- .../testutils/ReflexiveProtocolHandler.java | 6 +- .../nifi-framework-core-api/pom.xml | 4 +- .../apache/nifi/connectable/Connectable.java | 75 ++- .../controller/AbstractConfiguredComponent.java | 13 +- .../apache/nifi/controller/AbstractPort.java | 32 +- .../nifi/controller/ConfiguredComponent.java | 4 +- .../nifi/controller/ContentAvailability.java | 24 +- .../nifi/controller/ProcessScheduler.java | 58 +-- .../apache/nifi/controller/ProcessorNode.java | 18 +- .../nifi/controller/ReportingTaskNode.java | 48 +- .../nifi/controller/StandardFlowFileQueue.java | 6 +- .../apache/nifi/controller/StandardFunnel.java | 7 +- .../controller/ValidationContextFactory.java | 4 +- ...ControllerServiceAlreadyExistsException.java | 4 - ...ControllerServiceInstantiationException.java | 13 - .../reporting/ReportingTaskProvider.java | 90 ++-- .../repository/FlowFileEventRepository.java | 15 +- .../service/ControllerServiceNode.java | 47 +- .../service/ControllerServiceProvider.java | 168 ++++--- .../service/ControllerServiceReference.java | 17 +- .../service/ControllerServiceState.java | 16 +- .../org/apache/nifi/groups/ProcessGroup.java | 221 ++++---- .../apache/nifi/groups/RemoteProcessGroup.java | 56 +-- .../RemoteProcessGroupPortDescriptor.java | 42 +- .../org/apache/nifi/logging/LogRepository.java | 18 +- .../nifi/nar/NarThreadContextClassLoader.java | 5 +- .../org/apache/nifi/remote/RemoteGroupPort.java | 8 +- .../org/apache/nifi/remote/RootGroupPort.java | 28 +- .../nifi/remote/protocol/ServerProtocol.java | 62 ++- .../nifi/connectable/StandardConnection.java | 15 +- .../nifi/controller/FileSystemSwapManager.java | 49 +- .../apache/nifi/controller/FlowController.java | 373 +++++++------- .../nifi/controller/FlowFromDOMFactory.java | 56 +-- .../nifi/controller/FlowUnmarshaller.java | 12 +- .../nifi/controller/StandardFlowSerializer.java | 65 ++- .../nifi/controller/StandardFlowService.java | 23 +- .../controller/StandardFlowSynchronizer.java | 210 ++++---- .../nifi/controller/StandardProcessorNode.java | 110 ++-- .../apache/nifi/controller/StandardSnippet.java | 75 +-- .../org/apache/nifi/controller/Template.java | 2 +- .../apache/nifi/controller/TemplateManager.java | 48 +- .../reporting/AbstractReportingTaskNode.java | 84 ++-- .../reporting/StandardReportingContext.java | 12 +- .../StandardReportingInitializationContext.java | 12 +- .../repository/FileSystemRepository.java | 35 +- .../controller/repository/ProcessContext.java | 21 +- .../repository/ProvenanceEventEnricher.java | 6 +- .../repository/RepositoryPurgeException.java | 14 - .../repository/RingBufferEventRepository.java | 2 +- .../repository/StandardFlowFileRecord.java | 4 +- .../repository/StandardProcessSession.java | 147 +++--- .../repository/StandardProvenanceReporter.java | 15 +- .../repository/StandardRepositoryRecord.java | 28 +- .../repository/VolatileContentRepository.java | 6 +- .../repository/VolatileFlowFileRepository.java | 2 +- .../WriteAheadFlowFileRepository.java | 22 +- .../repository/claim/StandardContentClaim.java | 11 +- .../claim/StandardContentClaimManager.java | 10 - .../repository/io/ByteCountingOutputStream.java | 4 +- .../io/FlowFileAccessInputStream.java | 6 +- .../scheduling/ConnectableProcessContext.java | 8 +- .../scheduling/EventDrivenSchedulingAgent.java | 38 +- .../scheduling/QuartzSchedulingAgent.java | 2 +- .../controller/scheduling/ScheduleState.java | 6 +- .../scheduling/StandardProcessScheduler.java | 115 ++--- .../scheduling/TimerDrivenSchedulingAgent.java | 52 +- .../service/ControllerServiceLoader.java | 53 +- ...dControllerServiceInitializationContext.java | 6 +- .../service/StandardControllerServiceNode.java | 87 ++-- .../StandardControllerServiceProvider.java | 304 ++++++----- .../StandardControllerServiceReference.java | 4 +- .../history/StandardMetricDescriptor.java | 23 +- .../VolatileComponentStatusRepository.java | 441 ++++++++-------- .../tasks/ContinuallyRunConnectableTask.java | 11 +- .../tasks/ContinuallyRunProcessorTask.java | 16 +- .../controller/tasks/ReportingTaskWrapper.java | 6 +- .../apache/nifi/encrypt/StringEncryptor.java | 2 +- .../java/org/apache/nifi/engine/FlowEngine.java | 26 +- .../nifi/events/VolatileBulletinRepository.java | 2 +- .../nifi/fingerprint/FingerprintFactory.java | 88 ++-- .../nifi/groups/StandardProcessGroup.java | 46 +- .../nifi/persistence/FlowConfigurationDAO.java | 6 +- .../nifi/processor/SimpleProcessLogger.java | 5 - .../nifi/processor/StandardProcessContext.java | 6 +- .../nifi/processor/StandardPropertyValue.java | 6 +- .../processor/StandardSchedulingContext.java | 2 +- .../processor/StandardValidationContext.java | 18 +- .../org/apache/nifi/remote/RemoteNiFiUtils.java | 120 +++-- .../nifi/remote/StandardRemoteProcessGroup.java | 48 +- .../org/apache/nifi/services/FlowService.java | 11 +- .../nifi/spring/FlowControllerFactoryBean.java | 2 +- .../spring/StandardFlowServiceFactoryBean.java | 2 +- .../java/org/apache/nifi/util/DomUtils.java | 6 +- .../org/apache/nifi/util/ReflectionUtils.java | 156 +++--- .../java/org/apache/nifi/util/SnippetUtils.java | 32 +- .../src/main/resources/FlowConfiguration.xsd | 38 +- .../nifi/cluster/HeartbeatPayloadTest.java | 4 +- .../repository/TestStandardProcessSession.java | 220 ++++---- .../StandardControllerServiceProviderTest.java | 46 +- .../TestStandardControllerServiceProvider.java | 104 ++-- .../controller/service/mock/DummyProcessor.java | 13 +- .../nifi/controller/service/mock/ServiceA.java | 21 +- .../service/util/TestControllerService.java | 58 +-- .../processor/TestStandardPropertyValue.java | 4 +- .../nifi-framework/nifi-runtime/pom.xml | 2 +- .../java/org/apache/nifi/BootstrapListener.java | 501 +++++++++---------- .../src/main/java/org/apache/nifi/NiFi.java | 70 +-- 202 files changed, 3663 insertions(+), 4035 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/pom.xml ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/pom.xml b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/pom.xml index ebf2ceb..f474aab 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/pom.xml +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/pom.xml @@ -46,6 +46,14 @@ </execution> </executions> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-checkstyle-plugin</artifactId> + <configuration> + <excludes>**/authorization/generated/*.java,</excludes> + </configuration> + </plugin> + </plugins> </build> <dependencies> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/RepositoryUtils.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/RepositoryUtils.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/RepositoryUtils.java index b95388b..f678d5d 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/RepositoryUtils.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/RepositoryUtils.java @@ -25,7 +25,6 @@ import org.slf4j.Logger; /** * A utility class for useful methods dealing with the repository * - * @author unattributed */ public class RepositoryUtils { @@ -45,7 +44,7 @@ public class RepositoryUtils { /** * Closes the given statement quietly - no logging, no exceptions * - * @param statement + * @param statement to close */ public static void closeQuietly(final Statement statement) { @@ -61,7 +60,7 @@ public class RepositoryUtils { /** * Closes the given result set quietly - no logging, no exceptions * - * @param resultSet + * @param resultSet to close */ public static void closeQuietly(final ResultSet resultSet) { if (null != resultSet) { @@ -76,7 +75,7 @@ public class RepositoryUtils { /** * Closes the given connection quietly - no logging, no exceptions * - * @param conn + * @param conn to close */ public static void closeQuietly(final Connection conn) { if (null != conn) { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/UserDataSourceFactoryBean.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/UserDataSourceFactoryBean.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/UserDataSourceFactoryBean.java index 1f64f6e..ebcf574 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/UserDataSourceFactoryBean.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/UserDataSourceFactoryBean.java @@ -30,9 +30,6 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.FactoryBean; -/** - * - */ public class UserDataSourceFactoryBean implements FactoryBean { private static final Logger logger = LoggerFactory.getLogger(UserDataSourceFactoryBean.class); @@ -196,12 +193,6 @@ public class UserDataSourceFactoryBean implements FactoryBean { return connectionPool; } - /** - * Get the database url for the specified database file. - * - * @param databaseFile - * @return - */ private String getDatabaseUrl(File databaseFile) { String databaseUrl = "jdbc:h2:" + databaseFile + ";AUTOCOMMIT=OFF;DB_CLOSE_ON_EXIT=FALSE;LOCK_MODE=3"; String databaseUrlAppend = properties.getProperty(NiFiProperties.H2_URL_APPEND); @@ -225,9 +216,6 @@ public class UserDataSourceFactoryBean implements FactoryBean { this.properties = properties; } - /** - * Disposes resources. - */ public void shutdown() { // shutdown the connection pool http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/ActionDAO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/ActionDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/ActionDAO.java index 5d5d498..925dc80 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/ActionDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/ActionDAO.java @@ -32,43 +32,41 @@ public interface ActionDAO { /** * Persists the specified action. * - * @param action - * @throws DataAccessException + * @param action to persist + * @throws DataAccessException if unable to persist */ void createAction(Action action) throws DataAccessException; /** * Finds all actions that meet the specified criteria. * - * @param actionQuery - * @return - * @throws DataAccessException + * @param actionQuery query for actions + * @return History of actions + * @throws DataAccessException dae */ History findActions(HistoryQuery actionQuery) throws DataAccessException; /** - * Finds the previous values for the specified property in the specified - * component. Returns empty list if there are none. - * - * @param componentId - * @return + * @param componentId to get previous values of + * @return Finds the previous values for the specified property in the + * specified component. Returns empty list if there are none */ Map<String, List<PreviousValue>> getPreviousValues(String componentId); /** * Finds the specified action. * - * @param actionId - * @return - * @throws DataAccessException + * @param actionId action identifier + * @return Action specified + * @throws DataAccessException dae */ Action getAction(Integer actionId) throws DataAccessException; /** * Deletes all actions up to the specified end date. * - * @param endDate - * @throws DataAccessException + * @param endDate date to stop deleting at + * @throws DataAccessException dae */ void deleteActions(Date endDate) throws DataAccessException; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/AuthorityDAO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/AuthorityDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/AuthorityDAO.java index 2992884..b80b78e 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/AuthorityDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/AuthorityDAO.java @@ -27,32 +27,33 @@ public interface AuthorityDAO { /** * Finds all Authority for the specified user. * - * @param userId - * @return + * @param userId identifier of user + * @return authorities */ Set<Authority> findAuthoritiesByUserId(String userId) throws DataAccessException; /** - * Creates a new Authorities for the specified user. + * Creates new Authorities for the specified user in addition to authorities + * they already have. * - * @param authorities - * @param userId + * @param authorities to add to the given user + * @param userId identifier of user */ void createAuthorities(Set<Authority> authorities, String userId) throws DataAccessException; /** * Removes all Authorities for the specified user. * - * @param userId - * @throws DataAccessException + * @param userId user identifier + * @throws DataAccessException if unable to access authorities */ void deleteAuthorities(String userId) throws DataAccessException; /** * Removes the specified Authority. * - * @param authorities - * @param userId + * @param authorities to remove + * @param userId user id */ void deleteAuthorities(Set<Authority> authorities, String userId) throws DataAccessException; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/UserDAO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/UserDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/UserDAO.java index 9ffab5d..6339e5a 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/UserDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/UserDAO.java @@ -29,98 +29,98 @@ public interface UserDAO { /** * Determines whether there are any PENDING user accounts. * - * @return - * @throws DataAccessException + * @return true if pending + * @throws DataAccessException dae */ Boolean hasPendingUserAccounts() throws DataAccessException; /** * Returns all users. * - * @return - * @throws DataAccessException + * @return all users + * @throws DataAccessException dae */ Set<NiFiUser> findUsers() throws DataAccessException; /** * Returns all user groups. * - * @return - * @throws DataAccessException + * @return all group names + * @throws DataAccessException dae */ Set<String> findUserGroups() throws DataAccessException; /** * Returns all users for the specified group. * - * @param group - * @return - * @throws DataAccessException + * @param group group + * @return users in group + * @throws DataAccessException dae */ Set<NiFiUser> findUsersForGroup(String group) throws DataAccessException; /** * Returns the user with the specified id. * - * @param id - * @return - * @throws DataAccessException + * @param id user id + * @return user for the given id + * @throws DataAccessException dae */ NiFiUser findUserById(String id) throws DataAccessException; /** * Returns the user with the specified DN. * - * @param dn - * @return + * @param dn user dn + * @return user */ NiFiUser findUserByDn(String dn) throws DataAccessException; /** * Creates a new user based off the specified NiFiUser. * - * @param user + * @param user to create */ void createUser(NiFiUser user) throws DataAccessException; /** * Updates the specified NiFiUser. * - * @param user + * @param user to update */ void updateUser(NiFiUser user) throws DataAccessException; /** * Deletes the specified user. * - * @param id - * @throws DataAccessException + * @param id user identifier + * @throws DataAccessException dae */ void deleteUser(String id) throws DataAccessException; /** * Sets the status of the specified group. * - * @param group - * @param status - * @throws DataAccessException + * @param group group + * @param status status + * @throws DataAccessException dae */ void updateGroupStatus(String group, AccountStatus status) throws DataAccessException; /** * Sets the last verified time for all users in the specified group. * - * @param group - * @param lastVerified - * @throws DataAccessException S + * @param group group + * @param lastVerified date last verified + * @throws DataAccessException dae */ void updateGroupVerification(String group, Date lastVerified) throws DataAccessException; /** * Ungroups the specified group. * - * @param group - * @throws DataAccessException + * @param group to ungroup + * @throws DataAccessException dae */ void ungroup(String group) throws DataAccessException; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/impl/StandardActionDAO.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/impl/StandardActionDAO.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/impl/StandardActionDAO.java index 34623f4..bb655eb 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/impl/StandardActionDAO.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/dao/impl/StandardActionDAO.java @@ -259,13 +259,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Persists the extension details. - * - * @param actionId - * @param extensionDetails - * @throws DataAccessException - */ private void createExtensionDetails(int actionId, ExtensionDetails extensionDetails) throws DataAccessException { PreparedStatement statement = null; try { @@ -288,13 +281,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Persists the remote process group details. - * - * @param actionId - * @param remoteProcessGroupDetails - * @throws DataAccessException - */ private void createRemoteProcessGroupDetails(int actionId, RemoteProcessGroupDetails remoteProcessGroupDetails) throws DataAccessException { PreparedStatement statement = null; try { @@ -317,13 +303,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Persists the connection details. - * - * @param actionId - * @param connectionDetails - * @throws DataAccessException - */ private void createConnectDetails(int actionId, ConnectDetails connectionDetails) throws DataAccessException { PreparedStatement statement = null; try { @@ -352,13 +331,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Persists the move details. - * - * @param actionId - * @param moveDetails - * @throws DataAccessException - */ private void createMoveDetails(int actionId, MoveDetails moveDetails) throws DataAccessException { PreparedStatement statement = null; try { @@ -384,13 +356,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Persists the configuration details. - * - * @param actionId - * @param configurationDetails - * @throws DataAccessException - */ private void createConfigureDetails(int actionId, ConfigureDetails configurationDetails) throws DataAccessException { PreparedStatement statement = null; try { @@ -415,13 +380,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Persists the purge details. - * - * @param actionId - * @param purgeDetails - * @throws DataAccessException - */ private void createPurgeDetails(int actionId, PurgeDetails purgeDetails) throws DataAccessException { PreparedStatement statement = null; try { @@ -444,13 +402,6 @@ public class StandardActionDAO implements ActionDAO { } } - /** - * Finds actions that meet the criteria in the specified query. - * - * @param historyQuery - * @return - * @throws DataAccessException - */ @Override public History findActions(HistoryQuery historyQuery) throws DataAccessException { @@ -601,7 +552,7 @@ public class StandardActionDAO implements ActionDAO { // get the component details if appropriate ComponentDetails componentDetails = null; - if (Component.Processor.equals(component) || Component.ControllerService.equals(component) || Component.ReportingTask.equals(component)) { + if (Component.Processor.equals(component) || Component.ControllerService.equals(component) || Component.ReportingTask.equals(component)) { componentDetails = getExtensionDetails(actionId); } else if (Component.RemoteProcessGroup.equals(component)) { componentDetails = getRemoteProcessGroupDetails(actionId); @@ -712,13 +663,6 @@ public class StandardActionDAO implements ActionDAO { return action; } - /** - * Loads the specified extension details. - * - * @param actionId - * @return - * @throws DataAccessException - */ private ExtensionDetails getExtensionDetails(Integer actionId) throws DataAccessException { ExtensionDetails extensionDetails = null; PreparedStatement statement = null; @@ -746,13 +690,6 @@ public class StandardActionDAO implements ActionDAO { return extensionDetails; } - /** - * Loads the specified remote process group details. - * - * @param actionId - * @return - * @throws DataAccessException - */ private RemoteProcessGroupDetails getRemoteProcessGroupDetails(Integer actionId) throws DataAccessException { RemoteProcessGroupDetails remoteProcessGroupDetails = null; PreparedStatement statement = null; @@ -780,13 +717,6 @@ public class StandardActionDAO implements ActionDAO { return remoteProcessGroupDetails; } - /** - * Loads the specified move details. - * - * @param actionId - * @return - * @throws DataAccessException - */ private MoveDetails getMoveDetails(Integer actionId) throws DataAccessException { MoveDetails moveDetails = null; PreparedStatement statement = null; @@ -817,13 +747,6 @@ public class StandardActionDAO implements ActionDAO { return moveDetails; } - /** - * Loads the specified relationship details. - * - * @param actionId - * @return - * @throws DataAccessException - */ private ConnectDetails getConnectDetails(Integer actionId) throws DataAccessException { ConnectDetails connectionDetails = null; PreparedStatement statement = null; @@ -860,13 +783,6 @@ public class StandardActionDAO implements ActionDAO { return connectionDetails; } - /** - * Loads the specified configuration details. - * - * @param actionId - * @return - * @throws DataAccessException - */ private ConfigureDetails getConfigureDetails(Integer actionId) throws DataAccessException { ConfigureDetails configurationDetails = null; PreparedStatement statement = null; @@ -896,13 +812,6 @@ public class StandardActionDAO implements ActionDAO { return configurationDetails; } - /** - * Loads the specified purge details. - * - * @param actionId - * @return - * @throws DataAccessException - */ private PurgeDetails getPurgeDetails(Integer actionId) throws DataAccessException { PurgeDetails purgeDetails = null; PreparedStatement statement = null; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/AuditService.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/AuditService.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/AuditService.java index 7ca4e06..680173f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/AuditService.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/AuditService.java @@ -33,26 +33,24 @@ public interface AuditService { /** * Adds the specified actions. * - * @param actions - * @throws AdministrationException + * @param actions to add + * @throws AdministrationException if failed to add */ void addActions(Collection<Action> actions); /** - * Finds the previous values for the specified property in the specified - * component. Returns null if there are none. - * - * @param componentId - * @return + * @param componentId identifier of the component + * @return Finds the previous values for the specified property in the + * specified component. Returns null if there are none */ Map<String, List<PreviousValue>> getPreviousValues(String componentId); /** * Get the actions within the given date range. * - * @param actionQuery - * @return - * @throws AdministrationException + * @param actionQuery query + * @return history of actions + * @throws AdministrationException ae */ History getActions(HistoryQuery actionQuery); @@ -60,17 +58,17 @@ public interface AuditService { * Get the details for the specified action id. If the action cannot be * found, null is returned. * - * @param actionId - * @return + * @param actionId identifier of action + * @return the action */ Action getAction(Integer actionId); /** * Purges all action's that occurred before the specified end date. * - * @param end - * @param purgeAction - * @throws AdministrationException + * @param end the stopper for event purging + * @param purgeAction the action + * @throws AdministrationException ae */ void purgeActions(Date end, Action purgeAction); } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/UserService.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/UserService.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/UserService.java index 86256fd..b02f192 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/UserService.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/UserService.java @@ -33,129 +33,125 @@ public interface UserService { /** * Creates a new user account using the specified dn and justification. * - * @param dn - * @param justification - * @return + * @param dn user dn + * @param justification why the account is necessary + * @return the created NiFiUser */ NiFiUser createPendingUserAccount(String dn, String justification); /** - * Determines if there are any PENDING user accounts present. - * - * @return + * @return Determines if there are any PENDING user accounts present */ Boolean hasPendingUserAccount(); /** - * Determines if the users in the dnChain are authorized to download content - * with the specified attributes. - * - * @param dnChain - * @param attributes - * @return + * @param dnChain user dn chain + * @param attributes attributes for authorization request + * @return Determines if the users in the dnChain are authorized to download + * content with the specified attributes */ DownloadAuthorization authorizeDownload(List<String> dnChain, Map<String, String> attributes); - + /** * Updates a user group using the specified group comprised of the specified * users. Returns all the users that are currently in the specified group. * - * @param group - * @param userIds - * @param authorities - * @return + * @param group group + * @param userIds users + * @param authorities auths + * @return a user group */ NiFiUserGroup updateGroup(String group, Set<String> userIds, Set<Authority> authorities); /** * Authorizes the user specified. * - * @param dn - * @return + * @param dn user dn + * @return the user for the given dn if found */ NiFiUser checkAuthorization(String dn); /** * Deletes the user with the specified id. * - * @param id + * @param id user identifier */ void deleteUser(String id); /** * Disables the specified users account. * - * @param id - * @return + * @param id user identifier + * @return user for the given identifier */ NiFiUser disable(String id); /** * Disables the specified user group. * - * @param group - * @return + * @param group to disable + * @return user group */ NiFiUserGroup disableGroup(String group); /** * Updates the specified user with the specified authorities. * - * @param id - * @param authorities - * @return + * @param id identifier of user + * @param authorities auths to set + * @return the updated user */ NiFiUser update(String id, Set<Authority> authorities); /** * Invalidates the specified user account. * - * @param id + * @param id identifier of user account to invalidate */ void invalidateUserAccount(String id); /** * Invalidates the user accounts associated with the specified user group. * - * @param group + * @param group to invalidate user accounts on */ void invalidateUserGroupAccount(String group); /** * Ungroups the specified group. * - * @param group + * @param group to split up */ void ungroup(String group); /** * Ungroups the specified user. * - * @param id + * @param id user to ungroup */ void ungroupUser(String id); /** * Returns a collection of all NiFiUsers. * - * @return + * @return Collection of users */ Collection<NiFiUser> getUsers(); /** * Finds the specified user by id. * - * @param id - * @return + * @param id of the user + * @return the user object */ NiFiUser getUserById(String id); /** * Finds the specified user by dn. * - * @param dn - * @return - * @throws AdministrationException + * @param dn the user dn + * @return the newly created user + * @throws AdministrationException ae */ NiFiUser getUserByDn(String dn); } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AbstractUserAction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AbstractUserAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AbstractUserAction.java index 41c97fe..b970dc1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AbstractUserAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AbstractUserAction.java @@ -26,16 +26,16 @@ import org.apache.nifi.user.NiFiUser; /** * - * @param <T> + * @param <T> type of user action */ public abstract class AbstractUserAction<T> implements AdministrationAction<T> { /** * Determines the authorities that need to be added to the specified user. * - * @param user - * @param authorities - * @return + * @param user user + * @param authorities auths + * @return authorities to add */ protected Set<Authority> determineAuthoritiesToAdd(NiFiUser user, Set<Authority> authorities) { // not using copyOf since authorities may be empty and copyOf can throw an IllegalArgumentException when empty @@ -53,9 +53,9 @@ public abstract class AbstractUserAction<T> implements AdministrationAction<T> { * Determines the authorities that need to be removed from the specified * user. * - * @param user - * @param authorities - * @return + * @param user user + * @param authorities auths + * @return auths to remove */ protected Set<Authority> determineAuthoritiesToRemove(NiFiUser user, Set<Authority> authorities) { Set<Authority> authoritiesToRemove = EnumSet.copyOf(user.getAuthorities()); @@ -71,8 +71,8 @@ public abstract class AbstractUserAction<T> implements AdministrationAction<T> { * Verifies the specified users account. Includes obtaining the authorities * and group according to the specified authority provider. * - * @param authorityProvider - * @param user + * @param authorityProvider provider + * @param user user to verify */ protected void verifyAccount(AuthorityProvider authorityProvider, NiFiUser user) { // load the roles for the user http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AdministrationAction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AdministrationAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AdministrationAction.java index 5818ebe..f1795a9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AdministrationAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AdministrationAction.java @@ -23,16 +23,16 @@ import org.apache.nifi.authorization.AuthorityProvider; * Defines the administration action. Actions are provided a DAO factory and * authority provider to perform a require action. * - * @param <T> + * @param <T> type */ public interface AdministrationAction<T> { /** * Performs an action using the specified DAOFactory and AuthorityProvider. * - * @param daoFactory - * @param authorityProvider - * @return + * @param daoFactory factory + * @param authorityProvider provider + * @return action result */ T execute(DAOFactory daoFactory, AuthorityProvider authorityProvider); } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AuthorizeUserAction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AuthorizeUserAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AuthorizeUserAction.java index ea6973d..fe32772 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AuthorizeUserAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/AuthorizeUserAction.java @@ -142,9 +142,7 @@ public class AuthorizeUserAction extends AbstractUserAction<NiFiUser> { } /** - * Determines if account verification is required. - * - * @return + * @return Determines if account verification is required */ private boolean isAccountVerificationRequired(NiFiUser user) { // accounts that have never been verified obviously needs to be re-verified @@ -163,7 +161,7 @@ public class AuthorizeUserAction extends AbstractUserAction<NiFiUser> { /** * Checks the account status of the specified user. * - * @param user + * @param user to check */ private void checkAccountStatus(NiFiUser user) { if (AccountStatus.DISABLED.equals(user.getStatus())) { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/DeleteUserAction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/DeleteUserAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/DeleteUserAction.java index f93e97e..0d59b43 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/DeleteUserAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/DeleteUserAction.java @@ -35,7 +35,7 @@ public class DeleteUserAction implements AdministrationAction<Void> { /** * Creates a new transactions for deleting the specified user. * - * @param userId + * @param userId user identifier */ public DeleteUserAction(String userId) { this.userId = userId; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/FindUserByIdAction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/FindUserByIdAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/FindUserByIdAction.java index 3062a2e..0a10841 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/FindUserByIdAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/FindUserByIdAction.java @@ -22,9 +22,6 @@ import org.apache.nifi.admin.dao.UserDAO; import org.apache.nifi.authorization.AuthorityProvider; import org.apache.nifi.user.NiFiUser; -/** - * - */ public class FindUserByIdAction implements AdministrationAction<NiFiUser> { private final String id; @@ -32,7 +29,7 @@ public class FindUserByIdAction implements AdministrationAction<NiFiUser> { /** * Creates a new transactions for getting a user with the specified id. * - * @param id + * @param id of user */ public FindUserByIdAction(String id) { this.id = id; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/SeedUserAccountsAction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/SeedUserAccountsAction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/SeedUserAccountsAction.java index 72d68db..6665ac0 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/SeedUserAccountsAction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/action/SeedUserAccountsAction.java @@ -102,7 +102,7 @@ public class SeedUserAccountsAction extends AbstractUserAction<Void> { CreateUserAction createUser = new CreateUserAction(user); createUser.execute(daoFactory, authorityProvider); } else { - // this is not a new user and we have just verified their + // this is not a new user and we have just verified their // account, do not revoke... accountsToRevoke.remove(user); @@ -144,7 +144,7 @@ public class SeedUserAccountsAction extends AbstractUserAction<Void> { try { logger.info(String.format("User not authorized with configured provider: %s. Disabling account...", user.getDn())); - // disable the account and reset its last verified timestamp since it was not found + // disable the account and reset its last verified timestamp since it was not found // in the current configured authority provider user.setStatus(AccountStatus.DISABLED); user.setLastVerified(null); http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardAuditService.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardAuditService.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardAuditService.java index 721e6b2..e588841 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardAuditService.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardAuditService.java @@ -197,22 +197,12 @@ public class StandardAuditService implements AuditService { } } - /** - * Rolls back the specified transaction. - * - * @param transaction - */ private void rollback(Transaction transaction) { if (transaction != null) { transaction.rollback(); } } - /** - * Closes the specified transaction. - * - * @param transaction - */ private void closeQuietly(final Transaction transaction) { if (transaction != null) { try { @@ -222,7 +212,6 @@ public class StandardAuditService implements AuditService { } } - /* setters */ public void setTransactionBuilder(TransactionBuilder transactionBuilder) { this.transactionBuilder = transactionBuilder; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardUserService.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardUserService.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardUserService.java index 5c9af4b..424816f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardUserService.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/impl/StandardUserService.java @@ -77,7 +77,7 @@ public class StandardUserService implements UserService { * Seed any users from the authority provider that are not already present. */ public void seedUserAccounts() { - // do not seed node's user cache. when/if the node disconnects its + // do not seed node's user cache. when/if the node disconnects its // cache will be populated lazily (as needed) if (properties.isNode()) { return; @@ -143,7 +143,7 @@ public class StandardUserService implements UserService { writeLock.lock(); try { - // if user ids have been specified, invalidate the user accounts before performing + // if user ids have been specified, invalidate the user accounts before performing // the desired updates. if case of an error, this will ensure that these users are // authorized the next time the access the application if (userIds != null) { @@ -409,7 +409,7 @@ public class StandardUserService implements UserService { * modifying a user account. This method should only be invoked from within * a write lock. * - * @param id + * @param id user account identifier */ @Override public void invalidateUserAccount(String id) { @@ -438,14 +438,6 @@ public class StandardUserService implements UserService { } } - /** - * Invalidates the user with the specified id. This is done to ensure a user - * account will need to be re-validated in case an error occurs while - * modifying a user account. This method should only be invoked from within - * a write lock. - * - * @param group - */ @Override public void invalidateUserGroupAccount(String group) { Transaction transaction = null; @@ -533,7 +525,7 @@ public class StandardUserService implements UserService { readLock.unlock(); } } - + @Override public Collection<NiFiUser> getUsers() { Transaction transaction = null; @@ -624,22 +616,12 @@ public class StandardUserService implements UserService { } } - /** - * Rolls back the specified transaction. - * - * @param transaction - */ private void rollback(final Transaction transaction) { if (transaction != null) { transaction.rollback(); } } - /** - * Closes the specified transaction. - * - * @param transaction - */ private void closeQuietly(final Transaction transaction) { if (transaction != null) { try { @@ -649,9 +631,6 @@ public class StandardUserService implements UserService { } } - /* - * setters - */ public void setTransactionBuilder(TransactionBuilder transactionBuilder) { this.transactionBuilder = transactionBuilder; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/transaction/Transaction.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/transaction/Transaction.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/transaction/Transaction.java index edd214b..4792581 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/transaction/Transaction.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/admin/service/transaction/Transaction.java @@ -27,9 +27,9 @@ public interface Transaction extends Closeable { /** * Executes the specified action within the current transaction. * - * @param <T> - * @param action - * @return + * @param <T> type of action to execute + * @param action action to execute + * @return executed action * @throws IllegalStateException - if there is no current transaction */ <T> T execute(AdministrationAction<T> action); http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/authorization/AuthorityProviderFactoryBean.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/authorization/AuthorityProviderFactoryBean.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/authorization/AuthorityProviderFactoryBean.java index 31a01be..b3e9547 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/authorization/AuthorityProviderFactoryBean.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/authorization/AuthorityProviderFactoryBean.java @@ -130,12 +130,6 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon return authorityProvider; } - /** - * Loads the authority providers configuration. - * - * @return - * @throws Exception - */ private AuthorityProviders loadAuthorityProvidersConfiguration() throws Exception { final File authorityProvidersConfigurationFile = properties.getAuthorityProviderConfiguraitonFile(); @@ -159,14 +153,6 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon } } - /** - * Creates the AuthorityProvider instance for the identifier specified. - * - * @param identifier - * @param authorityProviderClassName - * @return - * @throws Exception - */ private AuthorityProvider createAuthorityProvider(final String identifier, final String authorityProviderClassName) throws Exception { // get the classloader for the specified authority provider final ClassLoader authorityProviderClassLoader = ExtensionManager.getClassLoader(authorityProviderClassName); @@ -207,12 +193,6 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon return withNarLoader(instance); } - /** - * Loads the AuthorityProvider configuration. - * - * @param provider - * @return - */ private AuthorityProviderConfigurationContext loadAuthorityProviderConfiguration(final Provider provider) { final Map<String, String> providerProperties = new HashMap<>(); @@ -223,15 +203,6 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon return new StandardAuthorityProviderConfigurationContext(provider.getIdentifier(), providerProperties); } - /** - * Performs method injection. - * - * @param instance - * @param authorityProviderClass - * @throws IllegalAccessException - * @throws IllegalArgumentException - * @throws InvocationTargetException - */ private void performMethodInjection(final AuthorityProvider instance, final Class authorityProviderClass) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException { for (final Method method : authorityProviderClass.getMethods()) { if (method.isAnnotationPresent(AuthorityProviderContext.class)) { @@ -267,14 +238,6 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon } } - /** - * Performs field injection. - * - * @param instance - * @param authorityProviderClass - * @throws IllegalArgumentException - * @throws IllegalAccessException - */ private void performFieldInjection(final AuthorityProvider instance, final Class authorityProviderClass) throws IllegalArgumentException, IllegalAccessException { for (final Field field : authorityProviderClass.getDeclaredFields()) { if (field.isAnnotationPresent(AuthorityProviderContext.class)) { @@ -311,10 +274,8 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon } /** - * Creates a default provider to use when running unsecurely with no - * provider configured. - * - * @return + * @return a default provider to use when running unsecurely with no + * provider configured */ private AuthorityProvider createDefaultProvider() { return new AuthorityProvider() { @@ -389,8 +350,8 @@ public class AuthorityProviderFactoryBean implements FactoryBean, ApplicationCon * Decorates the base provider to ensure the nar context classloader is used * when invoking the underlying methods. * - * @param baseProvider - * @return + * @param baseProvider base provider + * @return provider */ public AuthorityProvider withNarLoader(final AuthorityProvider baseProvider) { return new AuthorityProvider() { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/AccountStatus.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/AccountStatus.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/AccountStatus.java index 195f6bf..d7becf1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/AccountStatus.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/AccountStatus.java @@ -29,8 +29,8 @@ public enum AccountStatus { * Returns the matching status or null if the specified status does not * match any statuses. * - * @param rawStatus - * @return + * @param rawStatus string form of status + * @return account status object */ public static AccountStatus valueOfStatus(String rawStatus) { AccountStatus desiredStatus = null; http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/NiFiUser.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/NiFiUser.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/NiFiUser.java index 415160a..a47bde9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/NiFiUser.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/main/java/org/apache/nifi/user/NiFiUser.java @@ -43,7 +43,7 @@ public class NiFiUser implements Serializable { private AccountStatus status; private EnumSet<Authority> authorities; - + private NiFiUser chain; /* getters / setters */ http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/AuthorizeUserActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/AuthorizeUserActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/AuthorizeUserActionTest.java index 5797705..28ea4a9 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/AuthorizeUserActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/AuthorizeUserActionTest.java @@ -268,7 +268,7 @@ public class AuthorizeUserActionTest { /** * Tests AuthorityAccessException in doesDnExist. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AdministrationException.class) public void testAuthorityAccessExceptionInDoesDnExist() throws Exception { @@ -279,7 +279,7 @@ public class AuthorizeUserActionTest { /** * Test unknown user in the authority provider. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AccountNotFoundException.class) public void testUnknownUser() throws Exception { @@ -290,7 +290,7 @@ public class AuthorizeUserActionTest { /** * Test a user thats been removed after checking their existence. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AccountNotFoundException.class) public void testUserRemovedAfterCheckingExistence() throws Exception { @@ -301,7 +301,7 @@ public class AuthorizeUserActionTest { /** * Testing AuthorityAccessException when getting authorities. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AdministrationException.class) public void testAuthorityAccessException() throws Exception { @@ -312,7 +312,7 @@ public class AuthorizeUserActionTest { /** * Testing DataAccessException while creating user accounts. * - * @throws Exception + * @throws Exception ex */ @Test(expected = DataAccessException.class) public void testErrorCreatingUserAccount() throws Exception { @@ -323,7 +323,7 @@ public class AuthorizeUserActionTest { /** * Tests the general case when a user account is created. * - * @throws Exception + * @throws Exception ex */ @Test public void testAccountCreation() throws Exception { @@ -343,7 +343,7 @@ public class AuthorizeUserActionTest { * Tests the general case when there is an existing user account that * requires verification. * - * @throws Exception + * @throws Exception ex */ @Test public void testExistingUserRequiresVerification() throws Exception { @@ -364,7 +364,7 @@ public class AuthorizeUserActionTest { * Tests the general case when there is an existing user account that does * not require verification. * - * @throws Exception + * @throws Exception ex */ @Test public void testExistingUserNoVerification() throws Exception { @@ -386,7 +386,7 @@ public class AuthorizeUserActionTest { /** * Tests existing users whose accounts are in a pending status. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AccountPendingException.class) public void testExistingPendingUser() throws Exception { @@ -398,7 +398,7 @@ public class AuthorizeUserActionTest { /** * Tests existing users whose accounts are in a disabled status. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AccountDisabledException.class) public void testExistingDisabledUser() throws Exception { @@ -411,7 +411,7 @@ public class AuthorizeUserActionTest { * Tests the general case where there is an active user that has been * removed from the authority provider. * - * @throws Exception + * @throws Exception ex */ @Test public void testExistingActiveUserNotFoundInProvider() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/CreateUserActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/CreateUserActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/CreateUserActionTest.java index 3d2081b..6486d32 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/CreateUserActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/CreateUserActionTest.java @@ -37,11 +37,11 @@ import org.mockito.stubbing.Answer; */ public class CreateUserActionTest { - private String USER_ID_2 = "2"; - private String USER_ID_3 = "3"; + private final String USER_ID_2 = "2"; + private final String USER_ID_3 = "3"; - private String USER_DN_1 = "data access exception when creating user"; - private String USER_DN_3 = "general create user case"; + private final String USER_DN_1 = "data access exception when creating user"; + private final String USER_DN_3 = "general create user case"; private DAOFactory daoFactory; private UserDAO userDao; @@ -95,7 +95,7 @@ public class CreateUserActionTest { /** * Tests DataAccessExceptions that occur while creating user accounts. * - * @throws Exception + * @throws Exception ex */ @Test(expected = DataAccessException.class) public void testExceptionCreatingUser() throws Exception { @@ -109,7 +109,7 @@ public class CreateUserActionTest { /** * Tests DataAccessExceptions that occur while create user authorities. * - * @throws Exception + * @throws Exception ex */ @Test(expected = DataAccessException.class) public void testExceptionCreatingAuthoroties() throws Exception { @@ -123,7 +123,7 @@ public class CreateUserActionTest { /** * General case for creating a user. * - * @throws Exception + * @throws Exception ex */ @Test public void testCreateUserAccount() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/DisableUserActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/DisableUserActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/DisableUserActionTest.java index de85298..b0e1ac1 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/DisableUserActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/DisableUserActionTest.java @@ -33,9 +33,6 @@ import org.mockito.Mockito; import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; -/** - * - */ public class DisableUserActionTest { private static final String USER_ID_1 = "1"; @@ -119,7 +116,7 @@ public class DisableUserActionTest { /** * Tests the case when the user account is unknown. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AccountNotFoundException.class) public void testUnknownUserAccount() throws Exception { @@ -130,7 +127,7 @@ public class DisableUserActionTest { /** * Tests the case when a DataAccessException is thrown by the userDao. * - * @throws Exception + * @throws Exception ex */ @Test(expected = DataAccessException.class) public void testDataAccessExceptionInUserDao() throws Exception { @@ -141,7 +138,7 @@ public class DisableUserActionTest { /** * Tests the case when a AuthorityAccessException is thrown by the provider. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AdministrationException.class) public void testAuthorityAccessExceptionInProvider() throws Exception { @@ -152,7 +149,7 @@ public class DisableUserActionTest { /** * Tests the general case when the user is disabled. * - * @throws Exception + * @throws Exception ex */ @Test public void testDisableUser() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/InvalidateUserAccountActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/InvalidateUserAccountActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/InvalidateUserAccountActionTest.java index 93dbe61..cffd280 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/InvalidateUserAccountActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/InvalidateUserAccountActionTest.java @@ -87,11 +87,6 @@ public class InvalidateUserAccountActionTest { Mockito.when(daoFactory.getUserDAO()).thenReturn(userDao); } - /** - * Tests when the user account cannot be found. - * - * @throws Exception - */ @Test(expected = AccountNotFoundException.class) public void testAccountNotFoundException() throws Exception { InvalidateUserAccountAction invalidateUserAccount = new InvalidateUserAccountAction(USER_ID_1); @@ -101,7 +96,7 @@ public class InvalidateUserAccountActionTest { /** * Tests when a data access exception occurs when updating the user record. * - * @throws Exception + * @throws Exception ex */ @Test(expected = DataAccessException.class) public void testDataAccessException() throws Exception { @@ -112,7 +107,7 @@ public class InvalidateUserAccountActionTest { /** * Tests the general case of invalidating a user. * - * @throws Exception + * @throws Exception ex */ @Test public void testInvalidateUser() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/RequestUserAccountActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/RequestUserAccountActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/RequestUserAccountActionTest.java index 6e77d46..7707b2c 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/RequestUserAccountActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/RequestUserAccountActionTest.java @@ -86,7 +86,7 @@ public class RequestUserAccountActionTest { /** * Tests when a user account already exists. * - * @throws Exception + * @throws Exception ex */ @Test(expected = IllegalArgumentException.class) public void testExistingAccount() throws Exception { @@ -98,7 +98,7 @@ public class RequestUserAccountActionTest { * Tests when a DataAccessException occurs while saving the new account * request. * - * @throws Exception + * @throws Exception ex */ @Test(expected = DataAccessException.class) public void testDataAccessException() throws Exception { @@ -109,7 +109,7 @@ public class RequestUserAccountActionTest { /** * Tests the general case for requesting a new user account. * - * @throws Exception + * @throws Exception ex */ @Test public void testRequestUserAccountAction() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SeedUserAccountsActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SeedUserAccountsActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SeedUserAccountsActionTest.java index f37fc84..652d992 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SeedUserAccountsActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SeedUserAccountsActionTest.java @@ -16,7 +16,6 @@ */ package org.apache.nifi.admin.service.action; -import org.apache.nifi.admin.service.action.SeedUserAccountsAction; import java.util.EnumSet; import java.util.HashSet; import java.util.Set; @@ -187,7 +186,7 @@ public class SeedUserAccountsActionTest { /** * Tests seeding the user accounts. * - * @throws Exception + * @throws Exception ex */ @Test public void testSeedUsers() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SetUserAuthoritiesActionTest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SetUserAuthoritiesActionTest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SetUserAuthoritiesActionTest.java index dd3695c..22504f7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SetUserAuthoritiesActionTest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-administration/src/test/java/org/apache/nifi/admin/service/action/SetUserAuthoritiesActionTest.java @@ -176,7 +176,7 @@ public class SetUserAuthoritiesActionTest { * Test activating an unknown user account. User accounts are unknown then * there is no pending account for the user. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AccountNotFoundException.class) public void testUnknownUser() throws Exception { @@ -188,7 +188,7 @@ public class SetUserAuthoritiesActionTest { * Testing case then an AuthorityAccessException occurs while setting a * users authorities. * - * @throws Exception + * @throws Exception ex */ @Test(expected = AdministrationException.class) public void testAuthorityAccessException() throws Exception { @@ -199,7 +199,7 @@ public class SetUserAuthoritiesActionTest { /** * Tests general case of setting user authorities. * - * @throws Exception + * @throws Exception ex */ @Test public void testSetAuthorities() throws Exception { http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ClusterManagerProtocolSender.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ClusterManagerProtocolSender.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ClusterManagerProtocolSender.java index fa1547f..10653ff 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ClusterManagerProtocolSender.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ClusterManagerProtocolSender.java @@ -26,44 +26,48 @@ import org.apache.nifi.reporting.BulletinRepository; /** * An interface for sending protocol messages from the cluster manager to nodes. - * - * @author unattributed + * */ public interface ClusterManagerProtocolSender { - + /** * Sends a "flow request" message to a node. + * * @param msg a message * @return the response - * @throws ProtocolException if communication failed + * @throws ProtocolException if communication failed */ FlowResponseMessage requestFlow(FlowRequestMessage msg) throws ProtocolException; /** * Sends a "reconnection request" message to a node. + * * @param msg a message - * @return + * @return the response * @throws ProtocolException if communication failed */ ReconnectionResponseMessage requestReconnection(ReconnectionRequestMessage msg) throws ProtocolException; - + /** * Sends a "disconnection request" message to a node. + * * @param msg a message * @throws ProtocolException if communication failed */ void disconnect(DisconnectMessage msg) throws ProtocolException; - + /** * Sends an "assign primary role" message to a node. + * * @param msg a message - * @throws ProtocolException if communication failed + * @throws ProtocolException if communication failed */ void assignPrimaryRole(PrimaryRoleAssignmentMessage msg) throws ProtocolException; /** * Sets the {@link BulletinRepository} that can be used to report bulletins - * @param bulletinRepository + * + * @param bulletinRepository repo */ void setBulletinRepository(final BulletinRepository bulletinRepository); } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/888254b2/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ConnectionRequest.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ConnectionRequest.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ConnectionRequest.java index 1b5d007..63d1aa7 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ConnectionRequest.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-cluster-protocol/src/main/java/org/apache/nifi/cluster/protocol/ConnectionRequest.java @@ -20,9 +20,9 @@ import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; import org.apache.nifi.cluster.protocol.jaxb.message.ConnectionRequestAdapter; /** - * A node's request to connect to the cluster. The request contains a proposed + * A node's request to connect to the cluster. The request contains a proposed * identifier. - * + * * @author unattributed */ @XmlJavaTypeAdapter(ConnectionRequestAdapter.class) @@ -31,7 +31,7 @@ public class ConnectionRequest { private final NodeIdentifier proposedNodeIdentifier; public ConnectionRequest(final NodeIdentifier proposedNodeIdentifier) { - if(proposedNodeIdentifier == null) { + if (proposedNodeIdentifier == null) { throw new IllegalArgumentException("Proposed node identifier may not be null."); } this.proposedNodeIdentifier = proposedNodeIdentifier;
