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:52 UTC
[31/46] directory-kerby git commit: Fix javadoc issues in kerb-core
module.
Fix javadoc issues in kerb-core 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/fd7f6862
Tree: http://git-wip-us.apache.org/repos/asf/directory-kerby/tree/fd7f6862
Diff: http://git-wip-us.apache.org/repos/asf/directory-kerby/diff/fd7f6862
Branch: refs/heads/pkinit-support
Commit: fd7f6862e92125f5580db97bf72fad167ea501b2
Parents: 205295a
Author: plusplusjiajia <ji...@intel.com>
Authored: Mon Aug 24 15:54:48 2015 +0800
Committer: plusplusjiajia <ji...@intel.com>
Committed: Mon Aug 24 15:54:48 2015 +0800
----------------------------------------------------------------------
.../org/apache/kerby/asn1/Asn1InputBuffer.java | 2 +-
.../kerby/kerberos/kerb/client/KrbClient.java | 3 +-
.../kerby/kerberos/kerb/client/KrbConfig.java | 31 +++++++++++++++++---
.../kerby/kerberos/kerb/client/KrbContext.java | 6 ++++
.../kerb/client/impl/InternalKrbClient.java | 9 +++---
.../kerb/client/preauth/PreauthHandler.java | 2 ++
.../kerberos/kerb/transport/KrbTransport.java | 1 +
.../apache/kerby/kerberos/kerb/KrbRuntime.java | 2 ++
.../kerby/kerberos/kerb/provider/PkiLoader.java | 24 +++++++--------
.../kerberos/kerb/provider/TokenDecoder.java | 6 ++--
.../kerberos/kerb/provider/TokenEncoder.java | 6 ++--
.../kerby/kerberos/kerb/spec/KerberosTime.java | 15 ++++++++--
.../kerberos/kerb/spec/base/AuthToken.java | 16 +++++-----
.../kerby/kerberos/kerb/spec/base/KrbToken.java | 6 ++++
.../kerb/identity/backend/BackendTestBase.java | 1 +
.../backend/AbstractIdentityBackend.java | 2 ++
.../main/java/org/apache/kerby/util/IOUtil.java | 6 ++--
17 files changed, 98 insertions(+), 40 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
----------------------------------------------------------------------
diff --git a/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java b/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
index 2441749..aeb5864 100644
--- a/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
+++ b/kerby-asn1/src/main/java/org/apache/kerby/asn1/Asn1InputBuffer.java
@@ -62,7 +62,7 @@ public class Asn1InputBuffer {
* Parse and read ASN1 object from the stream. If it's already
* exhausted then null will be returned to indicate the end.
* @return an ASN1 object if available otherwise null
- * @throws IOException
+ * @throws IOException e
*/
public Asn1Type read() throws IOException {
if (!limitedBuffer.available()) {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbClient.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbClient.java b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbClient.java
index 2067a6e..db318fb 100644
--- a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbClient.java
+++ b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbClient.java
@@ -48,6 +48,7 @@ public class KrbClient {
/**
* Default constructor.
+ * @throws KrbException e
*/
public KrbClient() throws KrbException {
this.krbConfig = ClientUtil.getDefaultConfig();
@@ -165,7 +166,7 @@ public class KrbClient {
* Request a TGT with user plain credential
* @param principal The principal
* @param password The password
- * @return
+ * @return The tgt ticket
* @throws KrbException e
*/
public TgtTicket requestTgtWithPassword(String principal,
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbConfig.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbConfig.java b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbConfig.java
index a5886fd..2f88a91 100644
--- a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbConfig.java
+++ b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbConfig.java
@@ -37,7 +37,7 @@ public class KrbConfig extends Conf {
/**
* Get KDC host name
*
- * @return
+ * @return The kdc host
*/
public String getKdcHost() {
return getString(KrbConfigKey.KDC_HOST);
@@ -46,7 +46,7 @@ public class KrbConfig extends Conf {
/**
* Get KDC port, as both TCP and UDP ports
*
- * @return
+ * @return The kdc host
*/
public int getKdcPort() {
Integer kdcPort = KrbConfHelper.getIntUnderSection(this,
@@ -60,7 +60,7 @@ public class KrbConfig extends Conf {
/**
* Get KDC TCP port
*
- * @return
+ * @return The kdc tcp port
*/
public int getKdcTcpPort() {
Integer kdcPort = KrbConfHelper.getIntUnderSection(this,
@@ -94,7 +94,7 @@ public class KrbConfig extends Conf {
/**
* Get KDC UDP port
*
- * @return
+ * @return The kdc udp port
*/
public int getKdcUdpPort() {
Integer kdcPort = KrbConfHelper.getIntUnderSection(this,
@@ -107,6 +107,7 @@ public class KrbConfig extends Conf {
/**
* Get KDC realm.
+ * @return The kdc realm
*/
public String getKdcRealm() {
return KrbConfHelper.getStringUnderSection(this, KrbConfigKey.KDC_REALM);
@@ -114,6 +115,7 @@ public class KrbConfig extends Conf {
/**
* Get whether preatuh is required.
+ * @return true if preauth required
*/
public boolean isPreauthRequired() {
return getBoolean(KrbConfigKey.PREAUTH_REQUIRED);
@@ -121,6 +123,7 @@ public class KrbConfig extends Conf {
/**
* Get tgs principal.
+ * @return The tgs principal
*/
public String getTgsPrincipal() {
return getString(KrbConfigKey.TGS_PRINCIPAL);
@@ -128,6 +131,7 @@ public class KrbConfig extends Conf {
/**
* Get allowable clock skew.
+ * @return The allowable clock skew
*/
public long getAllowableClockSkew() {
return KrbConfHelper.getLongUnderSection(this, KrbConfigKey.CLOCKSKEW);
@@ -135,6 +139,7 @@ public class KrbConfig extends Conf {
/**
* Get whether empty addresses allowed.
+ * @return true if empty address is allowed
*/
public boolean isEmptyAddressesAllowed() {
return getBoolean(KrbConfigKey.EMPTY_ADDRESSES_ALLOWED);
@@ -142,6 +147,7 @@ public class KrbConfig extends Conf {
/**
* Get whether forward is allowed.
+ * @return true if forward is allowed
*/
public boolean isForwardableAllowed() {
return KrbConfHelper.getBooleanUnderSection(this, KrbConfigKey.FORWARDABLE);
@@ -149,6 +155,7 @@ public class KrbConfig extends Conf {
/**
* Get whether post dated is allowed.
+ * @return true if post dated is allowed
*/
public boolean isPostdatedAllowed() {
return getBoolean(KrbConfigKey.POSTDATED_ALLOWED);
@@ -156,6 +163,7 @@ public class KrbConfig extends Conf {
/**
* Get whether proxy is allowed.
+ * @return true if proxy is allowed
*/
public boolean isProxiableAllowed() {
return KrbConfHelper.getBooleanUnderSection(this, KrbConfigKey.PROXIABLE);
@@ -163,6 +171,7 @@ public class KrbConfig extends Conf {
/**
* Get whether renew is allowed.
+ * @return true if renew is allowed
*/
public boolean isRenewableAllowed() {
return getBoolean(KrbConfigKey.RENEWABLE_ALLOWED);
@@ -170,6 +179,7 @@ public class KrbConfig extends Conf {
/**
* Get maximum renewable life time.
+ * @return The maximum renewable life time
*/
public long getMaximumRenewableLifetime() {
return getLong(KrbConfigKey.MAXIMUM_RENEWABLE_LIFETIME);
@@ -177,6 +187,7 @@ public class KrbConfig extends Conf {
/**
* Get maximum ticket life time.
+ * @return The maximum ticket life time
*/
public long getMaximumTicketLifetime() {
return getLong(KrbConfigKey.MAXIMUM_TICKET_LIFETIME);
@@ -184,6 +195,7 @@ public class KrbConfig extends Conf {
/**
* Get minimum ticket life time.
+ * @return The minimum ticket life time
*/
public long getMinimumTicketLifetime() {
return getLong(KrbConfigKey.MINIMUM_TICKET_LIFETIME);
@@ -191,6 +203,7 @@ public class KrbConfig extends Conf {
/**
* Get encryption types.
+ * @return encryption type list
*/
public List<EncryptionType> getEncryptionTypes() {
return KrbConfHelper.getEncTypesUnderSection(this, KrbConfigKey.PERMITTED_ENCTYPES);
@@ -198,6 +211,7 @@ public class KrbConfig extends Conf {
/**
* Get whether pa encrypt timestamp required.
+ * @return true if pa encrypt time required
*/
public boolean isPaEncTimestampRequired() {
return getBoolean(KrbConfigKey.PA_ENC_TIMESTAMP_REQUIRED);
@@ -205,6 +219,7 @@ public class KrbConfig extends Conf {
/**
* Get whether body checksum verified.
+ * @return true if body checksum verified
*/
public boolean isBodyChecksumVerified() {
return getBoolean(KrbConfigKey.VERIFY_BODY_CHECKSUM);
@@ -212,6 +227,7 @@ public class KrbConfig extends Conf {
/**
* Get default realm.
+ * @return The default realm
*/
public String getDefaultRealm() {
return KrbConfHelper.getStringUnderSection(this, KrbConfigKey.DEFAULT_REALM);
@@ -219,6 +235,7 @@ public class KrbConfig extends Conf {
/**
* Get whether dns look up kdc.
+ * @return true if dnc look up kdc
*/
public boolean getDnsLookUpKdc() {
return KrbConfHelper.getBooleanUnderSection(this, KrbConfigKey.DNS_LOOKUP_KDC);
@@ -226,6 +243,7 @@ public class KrbConfig extends Conf {
/**
* Get whether dns look up realm.
+ * @return true if dns look up realm
*/
public boolean getDnsLookUpRealm() {
return KrbConfHelper.getBooleanUnderSection(this, KrbConfigKey.DNS_LOOKUP_REALM);
@@ -233,6 +251,7 @@ public class KrbConfig extends Conf {
/**
* Get whether allow weak crypto.
+ * @return true if allow weak crypto
*/
public boolean getAllowWeakCrypto() {
return KrbConfHelper.getBooleanUnderSection(this, KrbConfigKey.ALLOW_WEAK_CRYPTO);
@@ -240,6 +259,7 @@ public class KrbConfig extends Conf {
/**
* Get ticket life time.
+ * @return The ticket life time
*/
public long getTicketLifetime() {
return KrbConfHelper.getLongUnderSection(this, KrbConfigKey.TICKET_LIFETIME);
@@ -247,6 +267,7 @@ public class KrbConfig extends Conf {
/**
* Get renew life time.
+ * @return The renew life time
*/
public long getRenewLifetime() {
return KrbConfHelper.getLongUnderSection(this, KrbConfigKey.RENEW_LIFETIME);
@@ -254,6 +275,7 @@ public class KrbConfig extends Conf {
/**
* Get default tgs encryption types.
+ * @return The tgs encryption type list
*/
public List<EncryptionType> getDefaultTgsEnctypes() {
return KrbConfHelper.getEncTypesUnderSection(this, KrbConfigKey.DEFAULT_TGS_ENCTYPES);
@@ -261,6 +283,7 @@ public class KrbConfig extends Conf {
/**
* Get default ticket encryption types.
+ * @return The encryption type list
*/
public List<EncryptionType> getDefaultTktEnctypes() {
return KrbConfHelper.getEncTypesUnderSection(this, KrbConfigKey.DEFAULT_TKT_ENCTYPES);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbContext.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbContext.java b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbContext.java
index a69a607..b74b4fc 100644
--- a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbContext.java
+++ b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/KrbContext.java
@@ -29,6 +29,7 @@ public class KrbContext {
/**
* Init with krbsetting.
+ * @param krbSetting The krb setting
*/
public void init(KrbSetting krbSetting) {
this.krbSetting = krbSetting;
@@ -38,6 +39,7 @@ public class KrbContext {
/**
* Get krbsetting.
+ * @return The krb setting
*/
public KrbSetting getKrbSetting() {
return krbSetting;
@@ -45,6 +47,7 @@ public class KrbContext {
/**
* Get krbconfig.
+ * @return The krb config
*/
public KrbConfig getConfig() {
return krbSetting.getKrbConfig();
@@ -52,6 +55,7 @@ public class KrbContext {
/**
* Generate nonce.
+ * @return nonce
*/
public int generateNonce() {
return Nonce.value();
@@ -59,6 +63,7 @@ public class KrbContext {
/**
* Get ticket valid time.
+ * @return The ticket valid time
*/
public long getTicketValidTime() {
return 8 * 60 * 60 * 1000;
@@ -66,6 +71,7 @@ public class KrbContext {
/**
* Get preauth handler.
+ * @return The preauth handler
*/
public PreauthHandler getPreauthHandler() {
return preauthHandler;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/impl/InternalKrbClient.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/impl/InternalKrbClient.java b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/impl/InternalKrbClient.java
index 6ee378c..c30c1fa 100644
--- a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/impl/InternalKrbClient.java
+++ b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/impl/InternalKrbClient.java
@@ -32,6 +32,7 @@ public interface InternalKrbClient {
/**
* Init with all the necessary options.
+ * @throws KrbException e
*/
void init() throws KrbException;
@@ -43,17 +44,17 @@ public interface InternalKrbClient {
/**
* Request a Ticket Granting Ticket.
- * @param requestOptions
+ * @param requestOptions The request options
* @return a TGT
- * @throws KrbException
+ * @throws KrbException e
*/
TgtTicket requestTgtTicket(KOptions requestOptions) throws KrbException;
/**
* Request a service ticket.
- * @param requestOptions
+ * @param requestOptions The request options
* @return service ticket
- * @throws KrbException
+ * @throws KrbException e
*/
ServiceTicket requestServiceTicket(KOptions requestOptions) throws KrbException;
}
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/preauth/PreauthHandler.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/preauth/PreauthHandler.java b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/preauth/PreauthHandler.java
index fec4b6e..7494a5c 100644
--- a/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/preauth/PreauthHandler.java
+++ b/kerby-kerb/kerb-client/src/main/java/org/apache/kerby/kerberos/kerb/client/preauth/PreauthHandler.java
@@ -77,6 +77,8 @@ public class PreauthHandler {
/**
* Process preauth inputs and options, prepare and generate pdata to be out
+ * @param kdcRequest The kdc request
+ * @throws KrbException e
*/
public void preauth(KdcRequest kdcRequest) throws KrbException {
PreauthContext preauthContext = kdcRequest.getPreauthContext();
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
index 3ee54a6..29cbd95 100644
--- a/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
+++ b/kerby-kerb/kerb-common/src/main/java/org/apache/kerby/kerberos/kerb/transport/KrbTransport.java
@@ -31,6 +31,7 @@ public interface KrbTransport {
/**
* Send out a Kerberos message to remote peer.
* @param message The message to be sent
+ * @throws IOException e
*/
void sendMessage(ByteBuffer message) throws IOException;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/KrbRuntime.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/KrbRuntime.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/KrbRuntime.java
index 7b35332..d864627 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/KrbRuntime.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/KrbRuntime.java
@@ -46,6 +46,7 @@ public class KrbRuntime {
/**
* Set token provider.
+ * @param tokenProvider The token provider
*/
public static synchronized void setTokenProvider(TokenProvider tokenProvider) {
KrbRuntime.tokenProvider = tokenProvider;
@@ -64,6 +65,7 @@ public class KrbRuntime {
/**
* Setup pkiProvider.
+ * @param pkiProvider The pki provider
*/
public static synchronized void setPkiProvider(PkiProvider pkiProvider) {
KrbRuntime.pkiProvider = pkiProvider;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/PkiLoader.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/PkiLoader.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/PkiLoader.java
index 42e232f..4739e1a 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/PkiLoader.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/PkiLoader.java
@@ -33,36 +33,36 @@ public interface PkiLoader {
/**
* Load certificates from a cert file.
- * @param certFile
- * @return
- * @throws KrbException
+ * @param certFile The cert file
+ * @return The certificates
+ * @throws KrbException e
*/
List<Certificate> loadCerts(String certFile) throws KrbException;
/**
* Load certificates from an input stream.
- * @param inputStream
- * @return
- * @throws KrbException
+ * @param inputStream The input stream
+ * @return The certificates
+ * @throws KrbException e
*/
List<Certificate> loadCerts(InputStream inputStream) throws KrbException;
/**
* Load private key from a key file with a password.
- * @param keyFile
- * @param password
+ * @param keyFile The key file
+ * @param password The password
* @return private key
- * @throws KrbException
+ * @throws KrbException e
*/
PrivateKey loadPrivateKey(String keyFile,
String password) throws KrbException;
/**
* Load a private key from input stream with a password.
- * @param inputStream
- * @param password
+ * @param inputStream The input stream
+ * @param password The password
* @return private key
- * @throws KrbException
+ * @throws KrbException e
*/
PrivateKey loadPrivateKey(InputStream inputStream,
String password) throws KrbException;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenDecoder.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenDecoder.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenDecoder.java
index 90e9260..e52a9b3 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenDecoder.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenDecoder.java
@@ -30,15 +30,17 @@ public interface TokenDecoder {
/**
* Decode a token from a bytes array.
- * @param content
+ * @param content The content
* @return token
+ * @throws IOException e
*/
AuthToken decodeFromBytes(byte[] content) throws IOException;
/**
* Decode a token from a string.
- * @param content
+ * @param content The content
* @return token
+ * @throws IOException e
*/
AuthToken decodeFromString(String content) throws IOException;
}
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenEncoder.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenEncoder.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenEncoder.java
index 15d1483..90d06be 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenEncoder.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/provider/TokenEncoder.java
@@ -29,15 +29,17 @@ public interface TokenEncoder {
/**
* Encode a token resulting in a bytes array.
- * @param token
+ * @param token The auth token
* @return bytes array
+ * @throws KrbException e
*/
byte[] encodeAsBytes(AuthToken token) throws KrbException;
/**
* Encode a token resulting in a string.
- * @param token
+ * @param token The auth token
* @return string representation
+ * @throws KrbException e
*/
String encodeAsString(AuthToken token) throws KrbException;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/KerberosTime.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/KerberosTime.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/KerberosTime.java
index ed1b5a3..1474006 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/KerberosTime.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/KerberosTime.java
@@ -53,14 +53,14 @@ public class KerberosTime extends Asn1GeneralizedTime {
}
/**
- * time in milliseconds
+ * @param time in milliseconds
*/
public KerberosTime(long time) {
super(time);
}
/**
- * Return time in milliseconds
+ * @return time in milliseconds
*/
public long getTime() {
return getValue().getTime();
@@ -75,6 +75,7 @@ public class KerberosTime extends Asn1GeneralizedTime {
/**
* get the time in seconds
+ * @return The time
*/
public long getTimeInSeconds() {
return getTime() / 1000;
@@ -86,6 +87,7 @@ public class KerberosTime extends Asn1GeneralizedTime {
/**
* @param time in milliseconds
+ * @return true if less
*/
public boolean lessThan(long time) {
return getValue().getTime() < time;
@@ -93,6 +95,7 @@ public class KerberosTime extends Asn1GeneralizedTime {
/**
* @param ktime compare with milliseconds
+ * @return true if greater
*/
public boolean greaterThan(KerberosTime ktime) {
return getValue().compareTo(ktime.getValue()) > 0;
@@ -100,6 +103,8 @@ public class KerberosTime extends Asn1GeneralizedTime {
/**
* time in milliseconds
+ * @param clockSkew The clock skew
+ * @return true if in clock skew
*/
public boolean isInClockSkew(long clockSkew) {
long delta = Math.abs(getTime() - System.currentTimeMillis());
@@ -113,7 +118,9 @@ public class KerberosTime extends Asn1GeneralizedTime {
}
/**
- * time in milliseconds
+ * time in milliseconds.
+ * @param duration The duration
+ * @return The kerberos time
*/
public KerberosTime extend(long duration) {
long result = getTime() + duration;
@@ -122,6 +129,8 @@ public class KerberosTime extends Asn1GeneralizedTime {
/**
* Return diff time in milliseconds
+ * @param other The kerberos time
+ * @return The diff time
*/
public long diff(KerberosTime other) {
return getTime() - other.getTime();
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/AuthToken.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/AuthToken.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/AuthToken.java
index 1ac9429..e13fe6c 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/AuthToken.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/AuthToken.java
@@ -36,7 +36,7 @@ public interface AuthToken {
/**
* Set token subject
- * @param sub
+ * @param sub The token subject
*/
void setSubject(String sub);
@@ -48,7 +48,7 @@ public interface AuthToken {
/**
* Set token issuer
- * @param issuer
+ * @param issuer The token issuer
*/
void setIssuer(String issuer);
@@ -60,7 +60,7 @@ public interface AuthToken {
/**
* Set token audiences
- * @param audiences
+ * @param audiences The token audiences
*/
void setAudiences(List<String> audiences);
@@ -100,7 +100,7 @@ public interface AuthToken {
/**
* Set token expired time
- * @param exp
+ * @param exp The token expired time
*/
void setExpirationTime(Date exp);
@@ -112,7 +112,7 @@ public interface AuthToken {
/**
* Set token not before time.
- * @param nbt
+ * @param nbt The time
*/
void setNotBeforeTime(Date nbt);
@@ -124,7 +124,7 @@ public interface AuthToken {
/**
* Set token issued at time.
- * @param iat
+ * @param iat Time time when token issued
*/
void setIssueTime(Date iat);
@@ -136,8 +136,8 @@ public interface AuthToken {
/**
* Add a token attribute.
- * @param name
- * @param value
+ * @param name The attribute name
+ * @param value The attribute value
*/
void addAttribute(String name, Object value);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/KrbToken.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/KrbToken.java b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/KrbToken.java
index ba5d1ac..5e3ce13 100644
--- a/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/KrbToken.java
+++ b/kerby-kerb/kerb-core/src/main/java/org/apache/kerby/kerberos/kerb/spec/base/KrbToken.java
@@ -115,6 +115,7 @@ public class KrbToken extends KrbSequenceType implements AuthToken {
/**
* Get token encoder.
+ * @return The token encoder
*/
private static TokenEncoder getTokenEncoder() {
if (tokenEncoder == null) {
@@ -125,6 +126,7 @@ public class KrbToken extends KrbSequenceType implements AuthToken {
/**
* Get token decoder.
+ * @return The token decoder
*/
private static TokenDecoder getTokenDecoder() {
if (tokenDecoder == null) {
@@ -135,6 +137,7 @@ public class KrbToken extends KrbSequenceType implements AuthToken {
/**
* Get token format.
+ * @return The token format
*/
public TokenFormat getTokenFormat() {
Integer value = getFieldAsInteger(TOKEN_FORMAT);
@@ -143,6 +146,7 @@ public class KrbToken extends KrbSequenceType implements AuthToken {
/**
* Set token format.
+ * @param tokenFormat The token format
*/
public void setTokenFormat(TokenFormat tokenFormat) {
setFieldAsInt(TOKEN_FORMAT, tokenFormat.getValue());
@@ -150,6 +154,7 @@ public class KrbToken extends KrbSequenceType implements AuthToken {
/**
* Get token value.
+ * @return The token value
*/
public byte[] getTokenValue() {
return getFieldAsOctets(TOKEN_VALUE);
@@ -157,6 +162,7 @@ public class KrbToken extends KrbSequenceType implements AuthToken {
/**
* Set token value.
+ * @param tokenValue The token value
*/
public void setTokenValue(byte[] tokenValue) {
setFieldAsOctets(TOKEN_VALUE, tokenValue);
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-kerb/kerb-identity-test/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/BackendTestBase.java
----------------------------------------------------------------------
diff --git a/kerby-kerb/kerb-identity-test/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/BackendTestBase.java b/kerby-kerb/kerb-identity-test/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/BackendTestBase.java
index bb542a0..2efbcf2 100644
--- a/kerby-kerb/kerb-identity-test/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/BackendTestBase.java
+++ b/kerby-kerb/kerb-identity-test/src/main/java/org/apache/kerby/kerberos/kerb/identity/backend/BackendTestBase.java
@@ -32,6 +32,7 @@ public abstract class BackendTestBase extends BackendTest {
/**
* Create and prepare an identity backend for the tests. Must override.
+ * @throws Exception e
*/
@BeforeClass
public static void setup() throws Exception {
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/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 5f967cc..774ee6d 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
@@ -141,6 +141,7 @@ public abstract class AbstractIdentityBackend
/**
* Add an identity, invoked by addIdentity.
* @param principalName The principal name
+ * @return The added identity
* @throws KrbException e
*/
protected abstract KrbIdentity doGetIdentity(String principalName) throws KrbException;
@@ -168,6 +169,7 @@ public abstract class AbstractIdentityBackend
/**
* Add an identity, invoked by addIdentity, and return added identity.
* @param identity The identity to be added
+ * @return The added identity
* @throws KrbException e
*/
protected abstract KrbIdentity doAddIdentity(KrbIdentity identity) throws KrbException;
http://git-wip-us.apache.org/repos/asf/directory-kerby/blob/fd7f6862/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
----------------------------------------------------------------------
diff --git a/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java b/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
index bb07a8e..30bf3ed 100644
--- a/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
+++ b/kerby-util/src/main/java/org/apache/kerby/util/IOUtil.java
@@ -62,7 +62,7 @@ public final class IOUtil {
* Read an input stream and return the content as string assuming UTF8.
* @param in The input stream
* @return The content
- * @throws IOException
+ * @throws IOException e
*/
public static String readInput(InputStream in) throws IOException {
byte[] content = readInputStream(in);
@@ -73,7 +73,7 @@ public final class IOUtil {
* Read a file and return the content as string assuming UTF8.
* @param file The file to read
* @return The content
- * @throws IOException
+ * @throws IOException e
*/
public static String readFile(File file) throws IOException {
long len = 0;
@@ -94,7 +94,7 @@ public final class IOUtil {
* Write a file with the content assuming UTF8.
* @param content The content
* @param file The file to write
- * @throws IOException
+ * @throws IOException e
*/
public static void writeFile(String content, File file) throws IOException {
FileOutputStream outputStream = new FileOutputStream(file);