You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@knox.apache.org by kr...@apache.org on 2020/09/15 20:37:54 UTC
[knox] branch master updated: Fix javadoc errors
This is an automated email from the ASF dual-hosted git repository.
krisden pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/knox.git
The following commit(s) were added to refs/heads/master by this push:
new 2b1d085 Fix javadoc errors
2b1d085 is described below
commit 2b1d0853ae89c17654ca6fec901a48ffc8616db6
Author: Kevin Risden <kr...@apache.org>
AuthorDate: Tue Sep 15 16:37:10 2020 -0400
Fix javadoc errors
---
.../services/token/impl/DefaultTokenStateService.java | 4 ++--
.../gateway/services/token/state/TokenStateJournal.java | 16 ++++++++++++++++
.../security/impl/DefaultKeystoreServiceTest.java | 2 +-
.../services/security/impl/RemoteAliasServiceTest.java | 2 +-
.../token/impl/AliasBasedTokenStateServiceTest.java | 4 ++--
.../token/impl/JournalBasedTokenStateServiceTest.java | 2 +-
.../services/topology/DefaultTopologyServiceTest.java | 2 +-
.../service/knoxtoken/TokenServiceResourceTest.java | 2 +-
.../org/apache/knox/gateway/config/GatewayConfig.java | 3 +++
.../services/security/token/TokenStateService.java | 1 +
10 files changed, 29 insertions(+), 9 deletions(-)
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenStateService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenStateService.java
index f58a7f1..042e167 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenStateService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenStateService.java
@@ -254,7 +254,7 @@ public class DefaultTokenStateService implements TokenStateService {
}
/**
- * @param token
+ * @param token Token to check.
* @return false, if the service has previously stored the specified token; Otherwise, true.
*/
protected boolean isUnknown(final String token) {
@@ -275,7 +275,7 @@ public class DefaultTokenStateService implements TokenStateService {
*
* @param tokenIds The unique identifiers of the tokens whose state should be removed.
*
- * @throws UnknownTokenException
+ * @throws UnknownTokenException if the specified token in valid, but not known to the service.
*/
protected void removeTokens(final Set<String> tokenIds) throws UnknownTokenException {
removeTokenState(tokenIds);
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/token/state/TokenStateJournal.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/token/state/TokenStateJournal.java
index f9aa01b..a51d162 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/token/state/TokenStateJournal.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/token/state/TokenStateJournal.java
@@ -34,6 +34,8 @@ public interface TokenStateJournal {
* @param issueTime The issue timestamp
* @param expiration The expiration time
* @param maxLifetime The maximum allowed lifetime
+ *
+ * @throws IOException exception on error
*/
void add(String tokenId, long issueTime, long expiration, long maxLifetime)
throws IOException;
@@ -42,6 +44,8 @@ public interface TokenStateJournal {
* Persist the token state to the journal.
*
* @param entry The entry to persist
+ *
+ * @throws IOException exception on error
*/
void add(JournalEntry entry) throws IOException;
@@ -49,6 +53,8 @@ public interface TokenStateJournal {
* Persist the token state to the journal.
*
* @param entries The entries to persist
+ *
+ * @throws IOException exception on error
*/
void add(List<JournalEntry> entries) throws IOException;
@@ -57,6 +63,8 @@ public interface TokenStateJournal {
*
* @param tokenId The unique token identifier.
*
+ * @throws IOException exception on error
+ *
* @return A JournalEntry with the specified token's journaled state.
*/
JournalEntry get(String tokenId) throws IOException;
@@ -64,6 +72,8 @@ public interface TokenStateJournal {
/**
* Get all the the journaled tokens' state.
*
+ * @throws IOException exception on error
+ *
* @return A List of JournalEntry objects.
*/
List<JournalEntry> get() throws IOException;
@@ -72,6 +82,8 @@ public interface TokenStateJournal {
* Remove the token state for the specified token from the journal
*
* @param tokenId The unique token identifier
+ *
+ * @throws IOException exception on error
*/
void remove(String tokenId) throws IOException;
@@ -79,6 +91,8 @@ public interface TokenStateJournal {
* Remove the token state for the specified tokens from the journal
*
* @param tokenIds A set of unique token identifiers
+ *
+ * @throws IOException exception on error
*/
void remove(Collection<String> tokenIds) throws IOException;
@@ -86,6 +100,8 @@ public interface TokenStateJournal {
* Remove the token state for the specified journal entry
*
* @param entry A JournalEntry for the token for which the state should be removed
+ *
+ * @throws IOException exception on error
*/
void remove(JournalEntry entry) throws IOException;
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreServiceTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreServiceTest.java
index dadb6e6..c6815b2 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreServiceTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreServiceTest.java
@@ -610,7 +610,7 @@ public class DefaultKeystoreServiceTest {
verify(masterService);
}
- /**
+ /*
* Test the bulk key removal method, which should only load the keystore file once, and subsequently write the
* keystore file only once, rather than once each per key.
*/
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/RemoteAliasServiceTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/RemoteAliasServiceTest.java
index 8675ced..ab453a7 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/RemoteAliasServiceTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/services/security/impl/RemoteAliasServiceTest.java
@@ -337,7 +337,7 @@ public class RemoteAliasServiceTest {
aliases.contains(testAutoGeneratedpasswordAlias));
}
- /**
+ /*
* Test the bulk alias removal method.
*/
@Test
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/AliasBasedTokenStateServiceTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/AliasBasedTokenStateServiceTest.java
index 2c0fb6c..bca6088 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/AliasBasedTokenStateServiceTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/AliasBasedTokenStateServiceTest.java
@@ -62,7 +62,7 @@ public class AliasBasedTokenStateServiceTest extends DefaultTokenStateServiceTes
return (tokenStatePersistenceInterval != null) ? tokenStatePersistenceInterval : super.getTokenStatePersistenceInterval();
}
- /**
+ /*
* KNOX-2375
*/
@Test
@@ -199,7 +199,7 @@ public class AliasBasedTokenStateServiceTest extends DefaultTokenStateServiceTes
maxTokenLifetimes.size());
}
- /**
+ /*
* Verify that the token state reaper includes token state which has not been cached, so it's not left in the keystore
* forever.
*/
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/JournalBasedTokenStateServiceTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/JournalBasedTokenStateServiceTest.java
index 4f6ceda..bcfaec3 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/JournalBasedTokenStateServiceTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/services/token/impl/JournalBasedTokenStateServiceTest.java
@@ -131,7 +131,7 @@ public class JournalBasedTokenStateServiceTest extends DefaultTokenStateServiceT
maxTokenLifetimes.size());
}
- /**
+ /*
* Verify that the token state reaper includes previously-persisted token state, so it's not left in the file
* system forever.
*/
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/services/topology/DefaultTopologyServiceTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/services/topology/DefaultTopologyServiceTest.java
index 4b0890d..8a97b0d 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/services/topology/DefaultTopologyServiceTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/services/topology/DefaultTopologyServiceTest.java
@@ -616,7 +616,7 @@ public class DefaultTopologyServiceTest {
}
}
- /**
+ /*
* KNOX-2371
*/
@Test
diff --git a/gateway-service-knoxtoken/src/test/java/org/apache/knox/gateway/service/knoxtoken/TokenServiceResourceTest.java b/gateway-service-knoxtoken/src/test/java/org/apache/knox/gateway/service/knoxtoken/TokenServiceResourceTest.java
index a5c4796..903f559 100644
--- a/gateway-service-knoxtoken/src/test/java/org/apache/knox/gateway/service/knoxtoken/TokenServiceResourceTest.java
+++ b/gateway-service-knoxtoken/src/test/java/org/apache/knox/gateway/service/knoxtoken/TokenServiceResourceTest.java
@@ -158,7 +158,7 @@ public class TokenServiceResourceTest {
assertTrue(authority.verifyToken(parsedToken));
}
- /**
+ /*
* KNOX-2266
*/
@Test
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/config/GatewayConfig.java b/gateway-spi/src/main/java/org/apache/knox/gateway/config/GatewayConfig.java
index 5955624..124d968 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/config/GatewayConfig.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/config/GatewayConfig.java
@@ -696,6 +696,9 @@ public interface GatewayConfig {
boolean isKnoxTokenPermissiveValidationEnabled();
/**
+ * @param service Service to get the parameter for.
+ * @param parameter Parameter key to get the value for.
+ *
* @return the value of the given parameter for the given service if declared; an empty String otherwise
*/
String getServiceParameter(String service, String parameter);
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/TokenStateService.java b/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/TokenStateService.java
index d9a8a16..007c2de 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/TokenStateService.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/TokenStateService.java
@@ -160,6 +160,7 @@ public interface TokenStateService extends Service {
*
* @param tokenId The token unique identifier.
* @param validate Flag indicating whether the token needs to be validated.
+ * @throws UnknownTokenException Exception if token is not found.
*
* @return The token's expiration time in milliseconds.
*/