From e60e99185a18189ac5dab41a97b538c121812e11 Mon Sep 17 00:00:00 2001
From: Alinga Yeung <Alinga.Yeung@nrc-cnrc.gc.ca>
Date: Tue, 23 Aug 2016 11:33:44 -0700
Subject: [PATCH] Story 1965. Fixed some javadoc warnings.
---
.../src/main/java/ca/nrc/cadc/auth/ACIdentityManager.java | 2 +-
.../main/java/ca/nrc/cadc/ac/server/GroupPersistence.java | 1 -
.../main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupDAO.java | 5 ++---
.../ca/nrc/cadc/ac/server/ldap/LdapGroupPersistence.java | 2 +-
.../src/main/java/ca/nrc/cadc/ac/PosixDetails.java | 2 +-
cadc-access-control/src/main/java/ca/nrc/cadc/ac/User.java | 2 +-
.../src/main/java/ca/nrc/cadc/ac/client/GMSClient.java | 5 ++---
7 files changed, 8 insertions(+), 11 deletions(-)
diff --git a/cadc-access-control-identity/src/main/java/ca/nrc/cadc/auth/ACIdentityManager.java b/cadc-access-control-identity/src/main/java/ca/nrc/cadc/auth/ACIdentityManager.java
index cb0adaf1..6f83d5d1 100644
--- a/cadc-access-control-identity/src/main/java/ca/nrc/cadc/auth/ACIdentityManager.java
+++ b/cadc-access-control-identity/src/main/java/ca/nrc/cadc/auth/ACIdentityManager.java
@@ -227,7 +227,7 @@ public class ACIdentityManager implements IdentityManager
/**
* The returned CheckResource is the same as the one from AuthenticatorImpl.
*
- * @return
+ * @return the CheckResource
*/
public static CheckResource getAvailabilityCheck()
{
diff --git a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/GroupPersistence.java b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/GroupPersistence.java
index ce1839d2..c6c8a3ef 100755
--- a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/GroupPersistence.java
+++ b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/GroupPersistence.java
@@ -158,7 +158,6 @@ public interface GroupPersistence
/**
* Obtain a Collection of Groups that fit the given query.
*
- * @param userID The userID.
* @param role Role of the user, either owner, member, or read/write.
* @param groupID The Group ID.
*
diff --git a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupDAO.java b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupDAO.java
index 30897950..d615643e 100755
--- a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupDAO.java
+++ b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupDAO.java
@@ -161,7 +161,6 @@ public class LdapGroupDAO extends LdapDAO
* Persists a group.
*
* @param group The group to create
- * @return created group
* @throws GroupAlreadyExistsException If a group with the same ID already
* exists.
* @throws TransientException If an temporary, unexpected problem occurred.
@@ -791,7 +790,7 @@ public class LdapGroupDAO extends LdapDAO
/**
* @param groupID
- * @return
+ * @return the Distinguished Name of the group
*/
protected DN getGroupDN(final String groupID) throws TransientException
{
@@ -809,7 +808,7 @@ public class LdapGroupDAO extends LdapDAO
/**
* @param groupID
- * @return
+ * @return the Distinguished Name of the admin group
*/
protected DN getAdminGroupDN(final String groupID) throws TransientException
{
diff --git a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupPersistence.java b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupPersistence.java
index 8ce149e9..2871975b 100755
--- a/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupPersistence.java
+++ b/cadc-access-control-server/src/main/java/ca/nrc/cadc/ac/server/ldap/LdapGroupPersistence.java
@@ -254,7 +254,7 @@ public class LdapGroupPersistence extends LdapPersistence implements GroupPersis
*
* @param role
* @param groupID check membership in a specific group or null to get all groups
- * @return
+ * @return the groups
* @throws UserNotFoundException
* @throws GroupNotFoundException
* @throws TransientException
diff --git a/cadc-access-control/src/main/java/ca/nrc/cadc/ac/PosixDetails.java b/cadc-access-control/src/main/java/ca/nrc/cadc/ac/PosixDetails.java
index bc068919..0360dce7 100644
--- a/cadc-access-control/src/main/java/ca/nrc/cadc/ac/PosixDetails.java
+++ b/cadc-access-control/src/main/java/ca/nrc/cadc/ac/PosixDetails.java
@@ -84,7 +84,7 @@ public class PosixDetails
public String loginShell;
/**
- * @param userName user name
+ * @param username user name
* @param uid posix uid
* @param gid posix gid
* @param homeDirectory home directory
diff --git a/cadc-access-control/src/main/java/ca/nrc/cadc/ac/User.java b/cadc-access-control/src/main/java/ca/nrc/cadc/ac/User.java
index 607af355..4caab978 100644
--- a/cadc-access-control/src/main/java/ca/nrc/cadc/ac/User.java
+++ b/cadc-access-control/src/main/java/ca/nrc/cadc/ac/User.java
@@ -168,7 +168,7 @@ public class User
* of this Users set of identities.
*
* @param superset
- * @return
+ * @return true if the user is consistent, false otherwise
*/
public boolean isConsistent(final User superset)
{
diff --git a/cadc-access-control/src/main/java/ca/nrc/cadc/ac/client/GMSClient.java b/cadc-access-control/src/main/java/ca/nrc/cadc/ac/client/GMSClient.java
index f8c72e7b..dda5da8a 100755
--- a/cadc-access-control/src/main/java/ca/nrc/cadc/ac/client/GMSClient.java
+++ b/cadc-access-control/src/main/java/ca/nrc/cadc/ac/client/GMSClient.java
@@ -76,7 +76,6 @@ import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URI;
-import java.net.URISyntaxException;
import java.net.URL;
import java.security.AccessControlContext;
import java.security.AccessControlException;
@@ -999,7 +998,7 @@ public class GMSClient implements TransferListener
* Check group membership of the current Subject.
*
* @param groupName
- * @return
+ * @return true if the current Subject is a member of the group, false otherwise
* @throws UserNotFoundException
* @throws AccessControlException
* @throws IOException
@@ -1014,7 +1013,7 @@ public class GMSClient implements TransferListener
*
* @param groupName
* @param role
- * @return
+ * @return true if the current Subject is a member of the group with the specified role, false otherwise
* @throws UserNotFoundException
* @throws AccessControlException
* @throws IOException
--
GitLab