directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From plusplusjia...@apache.org
Subject [22/46] directory-kerby git commit: Fix javadoc issues in kerb-identity module.
Date Wed, 09 Sep 2015 01:36:43 GMT
Fix javadoc issues in kerb-identity module.


Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/4f822df7
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/4f822df7
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/4f822df7

Branch: refs/heads/pkinit-support
Commit: 4f822df73065a10b52504eea40eb39f83fe13879
Parents: 9013961
Author: plusplusjiajia <jiajia.li@intel.com>
Authored: Mon Aug 24 14:06:02 2015 +0800
Committer: plusplusjiajia <jiajia.li@intel.com>
Committed: Mon Aug 24 14:06:02 2015 +0800

----------------------------------------------------------------------
 .../kerberos/kerb/identity/IdentityService.java   | 14 +++++++++-----
 .../identity/backend/AbstractIdentityBackend.java | 18 ++++++++++++++----
 .../kerb/identity/backend/IdentityBackend.java    |  2 ++
 3 files changed, 25 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4f822df7/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
index a18b316..3d2e7dd 100644
--- a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
+++ b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/IdentityService.java
@@ -30,34 +30,38 @@ public interface IdentityService {
      * Get all of the identity principal names.
      * Note it's ordered by principal name.
      * @return principal names
+     * @throws KrbException e
      */
     Iterable<String> getIdentities() throws KrbException;
 
     /**
      * Get the identity account specified by name.
-     * @param principalName
+     * @param principalName The principal name
      * @return identity
+     * @throws KrbException e
      */
     KrbIdentity getIdentity(String principalName) throws KrbException;
 
     /**
      * Add an identity, and return the newly created result.
-     * @param identity
+     * @param identity The identity
      * @return identity
+     * @throws KrbException e
      */
     KrbIdentity addIdentity(KrbIdentity identity) throws KrbException;
 
     /**
      * Update an identity, and return the updated result.
-     * @param identity
+     * @param identity The identity
      * @return identity
+     * @throws KrbException e
      */
     KrbIdentity updateIdentity(KrbIdentity identity) throws KrbException;
 
     /**
      * Delete the identity specified by principal name
-     * @param principalName
-     *
+     * @param principalName The principal name
+     * @throws KrbException e
      */
     void deleteIdentity(String principalName) throws KrbException;
 }

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4f822df7/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
index 2ed1848..5f967cc 100644
--- a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
+++ b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/AbstractIdentityBackend.java
@@ -40,6 +40,7 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Get the Backend Config.
+     * @return The backend config
      */
     protected BackendConfig getBackendConfig() {
         return (BackendConfig) getConfig();
@@ -56,6 +57,7 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Perform the real initialization work for the backend.
+     * @throws KrbException e
      */
     protected void doInitialize() throws KrbException { }
 
@@ -84,6 +86,7 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Perform the real stop work for the backend.
+     * @throws KrbException e
      */
     protected void doStop() throws KrbException { }
 
@@ -112,6 +115,8 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Perform the real work to get identities.
+     * @return The identities
+     * @throws KrbException e
      */
     protected abstract Iterable<String> doGetIdentities() throws KrbException;
 
@@ -135,7 +140,8 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Add an identity, invoked by addIdentity.
-     * @param principalName
+     * @param principalName The principal name
+     * @throws  KrbException e
      */
     protected abstract KrbIdentity doGetIdentity(String principalName) throws KrbException;
 
@@ -161,7 +167,8 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Add an identity, invoked by addIdentity, and return added identity.
-     * @param identity
+     * @param identity The identity to be added
+     * @throws KrbException e
      */
     protected abstract KrbIdentity doAddIdentity(KrbIdentity identity) throws KrbException;
 
@@ -189,7 +196,9 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Update an identity, invoked by updateIdentity, and return updated identity.
-     * @param identity
+     * @param identity The origin identity
+     * @return The updated identity
+     * @throws KrbException e
      */
     protected abstract KrbIdentity doUpdateIdentity(KrbIdentity identity) throws KrbException;
 
@@ -215,7 +224,8 @@ public abstract class AbstractIdentityBackend
 
     /**
      * Delete an identity, invoked by deleteIndentity.
-     * @param principalName
+     * @param principalName The principal name
+     * @throws KrbException e
      */
     protected abstract void doDeleteIdentity(String principalName) throws KrbException;
 }

http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/4f822df7/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/IdentityBackend.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/IdentityBackend.java
b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/IdentityBackend.java
index 3a8126c..2e62e03 100644
--- a/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/IdentityBackend.java
+++ b/kerby-kerb/kerb-identity/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/IdentityBackend.java
@@ -30,6 +30,7 @@ public interface IdentityBackend extends IdentityService, Configurable {
 
     /**
      * Init work for the backend can be done here.
+     * @throws KrbException e
      */
     void initialize() throws KrbException;
 
@@ -45,6 +46,7 @@ public interface IdentityBackend extends IdentityService, Configurable {
      * Stop the backend.
      *
      * Will be called during KDC stop.
+     * @throws KrbException e
      */
     void stop() throws KrbException;
 


Mime
View raw message