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:57 UTC
[36/46] directory-kerby git commit: Fix some javadoc issues.
Fix some javadoc issues.
Project: http://git-wip-us.apache.org/repos/asf/directory-kerby/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-kerby/commit/28e7a0c7
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/28e7a0c7
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/28e7a0c7
Branch: refs/heads/pkinit-support
Commit: 28e7a0c7c5780b61965a619fb33f4620ce52bcc5
Parents: a4825f0
Author: plusplusjiajia <ji...@intel.com>
Authored: Tue Aug 25 09:30:45 2015 +0800
Committer: plusplusjiajia <ji...@intel.com>
Committed: Tue Aug 25 09:30:45 2015 +0800
----------------------------------------------------------------------
.../kerby/kerberos/kerb/server/KdcServer.java | 28 ++++++++++----------
.../kerb/server/impl/InternalKdcServer.java | 3 +++
.../kerb/server/preauth/KdcPreauth.java | 5 ++++
.../kerb/server/preauth/PreauthHandler.java | 2 +-
.../kerb/server/request/KdcRequest.java | 5 +++-
5 files changed, 27 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/28e7a0c7/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/KdcServer.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/KdcServer.java b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/KdcServer.java
index 3d4f7b9..f90e1ee 100644
--- a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/KdcServer.java
+++ b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/KdcServer.java
@@ -41,9 +41,9 @@ public class KdcServer {
/**
* Constructor passing both kdcConfig and backendConfig.
- * @param kdcConfig
- * @param backendConfig
- * @throws KrbException
+ * @param kdcConfig The kdc config
+ * @param backendConfig The backend config
+ * @throws KrbException e
*/
public KdcServer(KdcConfig kdcConfig,
BackendConfig backendConfig) throws KrbException {
@@ -59,8 +59,8 @@ public class KdcServer {
* kdc.conf, that contains kdc server related items.
* backend.conf, that contains identity backend related items.
*
- * @param confDir
- * @throws KrbException
+ * @param confDir The conf dir
+ * @throws KrbException e
*/
public KdcServer(File confDir) throws KrbException {
KdcConfig tmpKdcConfig = KdcUtil.getKdcConfig(confDir);
@@ -92,7 +92,7 @@ public class KdcServer {
/**
* Set KDC realm for ticket request
- * @param realm
+ * @param realm The kdc realm
*/
public void setKdcRealm(String realm) {
startupOptions.add(KdcServerOption.KDC_REALM, realm);
@@ -100,7 +100,7 @@ public class KdcServer {
/**
* Set KDC host.
- * @param kdcHost
+ * @param kdcHost The kdc host
*/
public void setKdcHost(String kdcHost) {
startupOptions.add(KdcServerOption.KDC_HOST, kdcHost);
@@ -108,7 +108,7 @@ public class KdcServer {
/**
* Set KDC port.
- * @param kdcPort
+ * @param kdcPort The kdc port
*/
public void setKdcPort(int kdcPort) {
startupOptions.add(KdcServerOption.KDC_PORT, kdcPort);
@@ -116,7 +116,7 @@ public class KdcServer {
/**
* Set KDC tcp port.
- * @param kdcTcpPort
+ * @param kdcTcpPort The kdc tcp port
*/
public void setKdcTcpPort(int kdcTcpPort) {
startupOptions.add(KdcServerOption.KDC_TCP_PORT, kdcTcpPort);
@@ -124,7 +124,7 @@ public class KdcServer {
/**
* Set to allow UDP or not.
- * @param allowUdp
+ * @param allowUdp true if allow udp
*/
public void setAllowUdp(boolean allowUdp) {
startupOptions.add(KdcServerOption.ALLOW_UDP, allowUdp);
@@ -132,14 +132,14 @@ public class KdcServer {
/**
* Set to allow TCP or not.
- * @param allowTcp
+ * @param allowTcp true if allow tcp
*/
public void setAllowTcp(boolean allowTcp) {
startupOptions.add(KdcServerOption.ALLOW_TCP, allowTcp);
}
/**
* Set KDC udp port. Only makes sense when allowUdp is set.
- * @param kdcUdpPort
+ * @param kdcUdpPort The kdc udp port
*/
public void setKdcUdpPort(int kdcUdpPort) {
startupOptions.add(KdcServerOption.KDC_UDP_PORT, kdcUdpPort);
@@ -147,7 +147,7 @@ public class KdcServer {
/**
* Set runtime folder.
- * @param workDir
+ * @param workDir The work dir
*/
public void setWorkDir(File workDir) {
startupOptions.add(KdcServerOption.WORK_DIR, workDir);
@@ -163,7 +163,7 @@ public class KdcServer {
/**
* Allow to hook customized kdc implementation.
*
- * @param innerKdcImpl
+ * @param innerKdcImpl The inner kdc implementation
*/
public void setInnerKdcImpl(InternalKdcServer innerKdcImpl) {
startupOptions.add(KdcServerOption.INNER_KDC_IMPL, innerKdcImpl);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/28e7a0c7/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/impl/InternalKdcServer.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/impl/InternalKdcServer.java b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/impl/InternalKdcServer.java
index 7d2f022..0ed33dd 100644
--- a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/impl/InternalKdcServer.java
+++ b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/impl/InternalKdcServer.java
@@ -30,16 +30,19 @@ public interface InternalKdcServer {
/**
* Initialize.
+ * @throws KrbException e
*/
void init() throws KrbException;
/**
* Start the KDC server.
+ * @throws KrbException e
*/
void start() throws KrbException;
/**
* Stop the KDC server.
+ * @throws KrbException e
*/
void stop() throws KrbException;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/28e7a0c7/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/KdcPreauth.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/KdcPreauth.java b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/KdcPreauth.java
index de862b3..a18e5d0 100644
--- a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/KdcPreauth.java
+++ b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/KdcPreauth.java
@@ -43,6 +43,7 @@ public interface KdcPreauth extends PreauthPluginMeta {
/**
* Initializing request context
* @param kdcRequest kdc context
+ * @return request context
*/
PluginRequestContext initRequestContext(KdcRequest kdcRequest);
@@ -53,6 +54,7 @@ public interface KdcPreauth extends PreauthPluginMeta {
* @param kdcRequest kdc request
* @param requestContext request context
* @param outPaData out preauthentication data
+ * @throws KrbException e
*/
void provideEdata(KdcRequest kdcRequest, PluginRequestContext requestContext,
PaData outPaData) throws KrbException;
@@ -64,6 +66,8 @@ public interface KdcPreauth extends PreauthPluginMeta {
* @param kdcRequest kdc request
* @param requestContext request context
* @param paData preauthentication data
+ * @return true if verify success
+ * @throws KrbException e
*/
boolean verify(KdcRequest kdcRequest, PluginRequestContext requestContext,
PaDataEntry paData) throws KrbException;
@@ -84,6 +88,7 @@ public interface KdcPreauth extends PreauthPluginMeta {
* @param kdcRequest kdc request
* @param requestContext request context
* @param paType preauthentication type
+ * @return PaFlags
*/
PaFlags getFlags(KdcRequest kdcRequest, PluginRequestContext requestContext,
PaDataType paType);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/28e7a0c7/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/PreauthHandler.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/PreauthHandler.java b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/PreauthHandler.java
index ccd7a2e..cff6ba6 100644
--- a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/PreauthHandler.java
+++ b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/preauth/PreauthHandler.java
@@ -58,7 +58,7 @@ public class PreauthHandler {
/**
* Should be called per realm
- * @param context
+ * @param context The kdc context
*/
public void initWith(KdcContext context) {
for (KdcPreauth preauth : preauths) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/28e7a0c7/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/request/KdcRequest.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/request/KdcRequest.java b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/request/KdcRequest.java
index 191fdfa..47025aa 100644
--- a/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/request/KdcRequest.java
+++ b/kerby-kerb/kerb-server/src/main/java/org/apache/kerby/kerberos/kerb/server/request/KdcRequest.java
@@ -105,6 +105,7 @@ public abstract class KdcRequest {
/**
* Set session key.
+ * @param sessionKey The session key
*/
public void setSessionKey(EncryptionKey sessionKey) {
this.sessionKey = sessionKey;
@@ -445,6 +446,7 @@ public abstract class KdcRequest {
/**
* Get server key.
+ * @return The server key
*/
public EncryptionKey getServerKey() {
return serverKey;
@@ -694,7 +696,7 @@ public abstract class KdcRequest {
/**
* Get identity entry with principal name.
*
- * @throws org.apache.kerby.kerberos.kerb.KrbException
+ * @throws org.apache.kerby.kerberos.kerb.KrbException e
* @param principal Principal
* @return krb identity entry
*/
@@ -772,6 +774,7 @@ public abstract class KdcRequest {
/**
* Set auth token.
+ * @param authToken The auth token
*/
public void setToken(AuthToken authToken) {
this.token = authToken;