You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pl...@apache.org on 2015/09/09 03:36:54 UTC
[33/46] directory-kerby git commit: Fix some warnings of javadoc.
Fix some warnings of javadoc.
Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/61e0f0f5
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/61e0f0f5
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/61e0f0f5
Branch: refs/heads/pkinit-support
Commit: 61e0f0f50622e5f30055651a55e4e12a066ab5ab
Parents: 844f82b
Author: plusplusjiajia <ji...@intel.com>
Authored: Mon Aug 24 16:34:46 2015 +0800
Committer: plusplusjiajia <ji...@intel.com>
Committed: Mon Aug 24 16:34:46 2015 +0800
----------------------------------------------------------------------
.../identitybackend/LdapIdentityGetHelper.java | 20 ++++++++--------
.../java/org/apache/kerby/MavibotBackend.java | 2 +-
.../identitybackend/IdentityZNodeHelper.java | 2 +-
.../kerberos/kdc/identitybackend/ZKUtil.java | 24 +++++++++++++-------
.../integration/test/jaas/TokenJaasKrbUtil.java | 4 ++--
.../kerberos/kerb/server/SimpleKdcServer.java | 13 ++++++-----
.../provider/token/JwtTokenDecoder.java | 4 ++--
7 files changed, 39 insertions(+), 30 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-backend/ldap-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/LdapIdentityGetHelper.java
----------------------------------------------------------------------
diff --git a/kerby-backend/ldap-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/LdapIdentityGetHelper.java b/kerby-backend/ldap-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/LdapIdentityGetHelper.java
index 3ea17ae..ba19ae0 100644
--- a/kerby-backend/ldap-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/LdapIdentityGetHelper.java
+++ b/kerby-backend/ldap-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/LdapIdentityGetHelper.java
@@ -42,7 +42,7 @@ public class LdapIdentityGetHelper {
/**
* Get principal name.
- * @throws LdapInvalidAttributeValueException
+ * @throws LdapInvalidAttributeValueException e
* @return principal name
*/
public PrincipalName getPrincipalName() throws LdapInvalidAttributeValueException {
@@ -53,7 +53,7 @@ public class LdapIdentityGetHelper {
/**
* Get key version.
- * @throws LdapInvalidAttributeValueException
+ * @throws LdapInvalidAttributeValueException e
* @return key version
*/
public int getKeyVersion() throws LdapInvalidAttributeValueException {
@@ -64,7 +64,7 @@ public class LdapIdentityGetHelper {
/**
* Get keys.
- * @throws IOException
+ * @throws IOException e
* @return keys
*/
public List<EncryptionKey> getKeys() throws IOException {
@@ -82,8 +82,8 @@ public class LdapIdentityGetHelper {
/**
* Get created time.
- * @throws LdapInvalidAttributeValueException
- * @throws ParseException
+ * @throws LdapInvalidAttributeValueException e
+ * @throws ParseException e
* @return created time
*/
public KerberosTime getCreatedTime() throws LdapInvalidAttributeValueException,
@@ -94,8 +94,8 @@ public class LdapIdentityGetHelper {
/**
* Get expire time.
- * @throws LdapInvalidAttributeValueException
- * @throws ParseException
+ * @throws LdapInvalidAttributeValueException e
+ * @throws ParseException e
* @return the expire time
*/
public KerberosTime getExpireTime() throws LdapInvalidAttributeValueException,
@@ -106,7 +106,7 @@ public class LdapIdentityGetHelper {
/**
* Get whether disabled.
- * @throws LdapInvalidAttributeValueException
+ * @throws LdapInvalidAttributeValueException e
* @return whether this krb5 account is disabled
*/
public boolean getDisabled() throws LdapInvalidAttributeValueException {
@@ -116,7 +116,7 @@ public class LdapIdentityGetHelper {
/**
* Get kdc flags.
- * @throws LdapInvalidAttributeValueException
+ * @throws LdapInvalidAttributeValueException e
* @return kdc flags
*/
public int getKdcFlags() throws LdapInvalidAttributeValueException {
@@ -126,7 +126,7 @@ public class LdapIdentityGetHelper {
/**
* Get whether locked.
- * @throws LdapInvalidAttributeValueException
+ * @throws LdapInvalidAttributeValueException e
* @return whether the krb5 account is locked
*/
public boolean getLocked() throws LdapInvalidAttributeValueException {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-backend/mavibot-backend/src/main/java/org/apache/kerby/MavibotBackend.java
----------------------------------------------------------------------
diff --git a/kerby-backend/mavibot-backend/src/main/java/org/apache/kerby/MavibotBackend.java b/kerby-backend/mavibot-backend/src/main/java/org/apache/kerby/MavibotBackend.java
index f0abc7e..7c31617 100644
--- a/kerby-backend/mavibot-backend/src/main/java/org/apache/kerby/MavibotBackend.java
+++ b/kerby-backend/mavibot-backend/src/main/java/org/apache/kerby/MavibotBackend.java
@@ -61,7 +61,7 @@ public class MavibotBackend extends AbstractIdentityBackend {
* @param location
* the File handle pointing to the database file or the directory
* where it is present
- * @throws Exception
+ * @throws Exception e
*/
public MavibotBackend(File location) throws Exception {
String dbPath = location.getAbsolutePath();
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/IdentityZNodeHelper.java
----------------------------------------------------------------------
diff --git a/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/IdentityZNodeHelper.java b/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/IdentityZNodeHelper.java
index 565e781..a59ede8 100644
--- a/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/IdentityZNodeHelper.java
+++ b/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/IdentityZNodeHelper.java
@@ -180,7 +180,7 @@ public class IdentityZNodeHelper {
/**
* Get identity names.
*
- * @throws org.apache.zookeeper.KeeperException
+ * @throws org.apache.zookeeper.KeeperException e
* @param zk The zookeeper
* @return The list of principal names.
*/
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/ZKUtil.java
----------------------------------------------------------------------
diff --git a/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/ZKUtil.java b/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/ZKUtil.java
index 128c59f..8ebe100 100644
--- a/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/ZKUtil.java
+++ b/kerby-backend/zookeeper-backend/src/main/java/org/apache/kerby/kerberos/kdc/identitybackend/ZKUtil.java
@@ -44,7 +44,7 @@ public class ZKUtil {
/**
* Check if the specified node exists. Sets no watches.
- * @throws org.apache.zookeeper.KeeperException
+ * @throws org.apache.zookeeper.KeeperException e
* @param zk Zookeeper.
* @param node Node.
* @return The version.
@@ -64,7 +64,7 @@ public class ZKUtil {
/**
* Sets the data of the existing znode to be the specified data.
- * @throws org.apache.zookeeper.KeeperException
+ * @throws org.apache.zookeeper.KeeperException e
* @param zk Zookeeper
* @param node Node
* @param data Data
@@ -86,6 +86,7 @@ public class ZKUtil {
* @param zk Zookeeper.
* @param node Node.
* @param data Data.
+ * @throws KeeperException e
*/
public static void createSetData(final ZooKeeper zk, final String node,
final byte[] data)
@@ -99,7 +100,9 @@ public class ZKUtil {
/**
* Creates the specified node and all parent nodes required for it to exist.
- * @throws org.apache.zookeeper.KeeperException
+ * @param zk The zookeeper
+ * @param node The znode
+ * @throws org.apache.zookeeper.KeeperException e
*/
public static void createWithParents(ZooKeeper zk, String node)
throws KeeperException {
@@ -110,7 +113,7 @@ public class ZKUtil {
* Creates the specified node and all parent nodes required for it to exist. The creation of
* parent znodes is not atomic with the leafe znode creation but the data is written atomically
* when the leaf node is created.
- * @throws org.apache.zookeeper.KeeperException
+ * @throws org.apache.zookeeper.KeeperException e
* @param zk zookeeper.
* @param node node
* @param data data
@@ -146,6 +149,7 @@ public class ZKUtil {
/**
* Returns the full path of the immediate parent of the specified node.
* null if passed the root node or an invalid node
+ * @param node The znode
* @return index
*/
public static String getParent(String node) {
@@ -155,8 +159,10 @@ public class ZKUtil {
/**
* Get znode data. Does not set a watcher.
- * @throws org.apache.zookeeper.KeeperException
- * @throws java.lang.InterruptedException
+ * @param zk The zookeeper
+ * @param node The znode
+ * @throws org.apache.zookeeper.KeeperException e
+ * @throws java.lang.InterruptedException e
* @return Data of the node
*/
public static byte[] getData(ZooKeeper zk, String node)
@@ -176,7 +182,9 @@ public class ZKUtil {
/**
* Lists the children of the specified node without setting any watches.
* null if parent does not exist
- * @throws org.apache.zookeeper.KeeperException
+ * @param zk The zookeeper.
+ * @param node The znode
+ * @throws org.apache.zookeeper.KeeperException e
* @return children
*/
public static List<String> listChildrenNoWatch(ZooKeeper zk, String node)
@@ -198,7 +206,7 @@ public class ZKUtil {
* If the node does not exist, just returns.
* Sets no watches. Throws all exceptions besides dealing with deletion of
* children.
- * @throws KeeperException
+ * @throws KeeperException e
* @param zk The zookeeper.
* @param node The node to be deleted.
*/
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-kerb/integration-test/src/main/java/org/apache/kerby/kerberos/kerb/integration/test/jaas/TokenJaasKrbUtil.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/integration-test/src/main/java/org/apache/kerby/kerberos/kerb/integration/test/jaas/TokenJaasKrbUtil.java b/kerby-kerb/integration-test/src/main/java/org/apache/kerby/kerberos/kerb/integration/test/jaas/TokenJaasKrbUtil.java
index 42a203d..d7a91ab 100644
--- a/kerby-kerb/integration-test/src/main/java/org/apache/kerby/kerberos/kerb/integration/test/jaas/TokenJaasKrbUtil.java
+++ b/kerby-kerb/integration-test/src/main/java/org/apache/kerby/kerberos/kerb/integration/test/jaas/TokenJaasKrbUtil.java
@@ -40,12 +40,12 @@ public class TokenJaasKrbUtil {
/**
* Login using token cache.
*
- * @throws javax.security.auth.login.LoginException
* @param principal The client principal name
* @param tokenCache the token cache for login
* @param armorCache the armor cache for fast preauth
* @param ccache The file to store the tgt ticket
* @return the authenticated Subject
+ * @throws LoginException e
*/
public static Subject loginUsingToken(
String principal, File tokenCache, File armorCache, File ccache)
@@ -65,12 +65,12 @@ public class TokenJaasKrbUtil {
/**
* Login using token string.
*
- * @throws javax.security.auth.login.LoginException
* @param principal The client principal name
* @param tokenStr the token string for login
* @param armorCache the armor cache for fast preauth
* @param ccache The file to store the tgt ticket
* @return the authenticated Subject
+ * @throws LoginException e
*/
public static Subject loginUsingToken(
String principal, String tokenStr, File armorCache, File ccache)
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-kerb/kerb-simplekdc/src/main/java/org/apache/kerby/kerberos/kerb/server/SimpleKdcServer.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-simplekdc/src/main/java/org/apache/kerby/kerberos/kerb/server/SimpleKdcServer.java b/kerby-kerb/kerb-simplekdc/src/main/java/org/apache/kerby/kerberos/kerb/server/SimpleKdcServer.java
index 882cd01..0a7ad1d 100644
--- a/kerby-kerb/kerb-simplekdc/src/main/java/org/apache/kerby/kerberos/kerb/server/SimpleKdcServer.java
+++ b/kerby-kerb/kerb-simplekdc/src/main/java/org/apache/kerby/kerberos/kerb/server/SimpleKdcServer.java
@@ -166,7 +166,7 @@ public class SimpleKdcServer extends KdcServer {
/**
* Create principal with principal name.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param principal The principal name
*/
public void createPrincipal(String principal) throws KrbException {
@@ -176,7 +176,7 @@ public class SimpleKdcServer extends KdcServer {
/**
* Create principal with principal name and password.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param principal The principal name
* @param password The password to create keys
*/
@@ -188,7 +188,7 @@ public class SimpleKdcServer extends KdcServer {
/**
* Create principals.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param principals The principal list
*/
public void createPrincipals(String ... principals) throws KrbException {
@@ -200,7 +200,7 @@ public class SimpleKdcServer extends KdcServer {
/**
* Creates principals and export their keys to the specified keytab file.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param keytabFile The keytab file to store principal keys
* @param principals The principals to be create
*/
@@ -213,7 +213,7 @@ public class SimpleKdcServer extends KdcServer {
/**
* Delete principals.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param principals The principals to be delete
*/
public void deletePrincipals(String ... principals) throws KrbException {
@@ -225,7 +225,7 @@ public class SimpleKdcServer extends KdcServer {
/**
* Delete principal.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param principal The principal to be delete
*/
public void deletePrincipal(String principal) throws KrbException {
@@ -236,6 +236,7 @@ public class SimpleKdcServer extends KdcServer {
* Export principals to keytab file.
*
* @param keytabFile The keytab file
+ * @throws KrbException e
*/
public void exportPrincipals(File keytabFile) throws KrbException {
kadmin.exportKeytab(keytabFile);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/61e0f0f5/kerby-provider/token-provider/src/main/java/org/apache/kerby/kerberos/provider/token/JwtTokenDecoder.java
----------------------------------------------------------------------
diff --git a/kerby-provider/token-provider/src/main/java/org/apache/kerby/kerberos/provider/token/JwtTokenDecoder.java b/kerby-provider/token-provider/src/main/java/org/apache/kerby/kerberos/provider/token/JwtTokenDecoder.java
index a99af62..ff9469d 100644
--- a/kerby-provider/token-provider/src/main/java/org/apache/kerby/kerberos/provider/token/JwtTokenDecoder.java
+++ b/kerby-provider/token-provider/src/main/java/org/apache/kerby/kerberos/provider/token/JwtTokenDecoder.java
@@ -129,7 +129,7 @@ public class JwtTokenDecoder implements TokenDecoder {
/**
* Decrypt the Encrypted JWT
*
- * @throws java.io.IOException
+ * @throws java.io.IOException e
* @param encryptedJWT an encrypted JWT
*/
public void decryptEncryptedJWT(EncryptedJWT encryptedJWT) throws IOException {
@@ -153,7 +153,7 @@ public class JwtTokenDecoder implements TokenDecoder {
/**
* verify the Signed JWT
*
- * @throws java.io.IOException
+ * @throws java.io.IOException e
* @param signedJWT a signed JWT
* @return whether verify success
*/