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 2018/11/02 17:37:22 UTC
[1/3] knox git commit: WIP
Repository: knox
Updated Branches:
refs/heads/master 2868f4a16 -> 488e4445c
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketClient.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketClient.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketClient.java
index 00fc144..08c9ffc 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketClient.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketClient.java
@@ -80,11 +80,6 @@ public class WebsocketClient {
/**
* Check whether we have expected close code
- *
- * @param expectedCloseCode
- * @param timeoutDuration
- * @param timeoutUnit
- * @throws TimeoutException
*/
public void awaitClose(int expectedCloseCode, int timeoutDuration,
TimeUnit timeoutUnit) throws TimeoutException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketEchoTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketEchoTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketEchoTest.java
index 02b8dec..1eda4ee 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketEchoTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketEchoTest.java
@@ -62,7 +62,7 @@ import static org.hamcrest.MatcherAssert.assertThat;
* A basic test that attempts to proxy websocket connections through Knox
* gateway.
* <p>
- * The way the test is set up is as follows: <br/>
+ * The way the test is set up is as follows: <br>
* <ul>
* <li>A Mock Websocket server is setup which simply echos the responses sent by
* client.
@@ -115,10 +115,8 @@ public class WebsocketEchoTest {
@BeforeClass
public static void startServers() throws Exception {
-
startWebsocketServer();
startGatewayServer();
-
}
@AfterClass
@@ -132,13 +130,10 @@ public class WebsocketEchoTest {
/* Cleanup the created files */
FileUtils.deleteQuietly(topoDir);
-
}
/**
* Test direct connection to websocket server without gateway
- *
- * @throws Exception
*/
@Test
public void testDirectEcho() throws Exception {
@@ -150,13 +145,10 @@ public class WebsocketEchoTest {
session.getBasicRemote().sendText("Echo");
client.messageQueue.awaitMessages(1, 1000, TimeUnit.MILLISECONDS);
-
}
/**
* Test websocket proxying through gateway.
- *
- * @throws Exception
*/
@Test
public void testGatewayEcho() throws Exception {
@@ -170,13 +162,10 @@ public class WebsocketEchoTest {
client.messageQueue.awaitMessages(1, 1000, TimeUnit.MILLISECONDS);
assertThat(client.messageQueue.get(0), is("Echo"));
-
}
/**
* Test websocket rewrite rules proxying through gateway.
- *
- * @throws Exception
*/
@Test
public void testGatewayRewriteEcho() throws Exception {
@@ -190,13 +179,10 @@ public class WebsocketEchoTest {
client.messageQueue.awaitMessages(1, 1000, TimeUnit.MILLISECONDS);
assertThat(client.messageQueue.get(0), is("Echo"));
-
}
/**
* Start Mock Websocket server that acts as backend.
- *
- * @throws Exception
*/
private static void startWebsocketServer() throws Exception {
@@ -220,13 +206,10 @@ public class WebsocketEchoTest {
}
int port = connector.getLocalPort();
backendServerUri = new URI(String.format(Locale.ROOT, "ws://%s:%d/ws", host, port));
-
}
/**
* Start Gateway Server.
- *
- * @throws Exception
*/
private static void startGatewayServer() throws Exception {
gatewayServer = new Server();
@@ -264,9 +247,6 @@ public class WebsocketEchoTest {
/**
* Initialize the configs and components required for this test.
- *
- * @param backend
- * @throws IOException
*/
private static void setupGatewayConfig(final String backend)
throws IOException {
@@ -382,17 +362,12 @@ public class WebsocketEchoTest {
synchronized (this) {
for (TopologyEvent event : events) {
if (!event.getType().equals(TopologyEvent.Type.DELETED)) {
-
/* for this test we only care about this part */
DeploymentFactory.createDeployment(gatewayConfig,
event.getTopology());
-
}
}
-
}
-
}
-
}
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketMultipleConnectionTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketMultipleConnectionTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketMultipleConnectionTest.java
index c8b9545..bd8439b 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketMultipleConnectionTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/WebsocketMultipleConnectionTest.java
@@ -123,13 +123,10 @@ public class WebsocketMultipleConnectionTest {
/* Cleanup the created files */
FileUtils.deleteQuietly(topoDir);
-
}
/**
* Test websocket proxying through gateway.
- *
- * @throws Exception
*/
@Test
public void testMultipleConnections() throws Exception {
@@ -186,8 +183,6 @@ public class WebsocketMultipleConnectionTest {
/**
* Start Mock Websocket server that acts as backend.
- *
- * @throws Exception
*/
private static void startWebsocketServer() throws Exception {
@@ -214,11 +209,6 @@ public class WebsocketMultipleConnectionTest {
}
- /**
- * Start Gateway Server.
- *
- * @throws Exception
- */
private static void startGatewayServer() throws Exception {
/* use default Max threads */
gatewayServer = new Server(new QueuedThreadPool(254));
@@ -256,9 +246,6 @@ public class WebsocketMultipleConnectionTest {
/**
* Initialize the configs and components required for this test.
- *
- * @param backend
- * @throws IOException
*/
private static void setupGatewayConfig(final String backend)
throws IOException {
@@ -347,7 +334,6 @@ public class WebsocketMultipleConnectionTest {
.getService(GatewayServices.TOPOLOGY_SERVICE);
monitor.addTopologyChangeListener(topoListener);
monitor.reloadTopologies();
-
}
private static File createDir() throws IOException {
@@ -381,11 +367,8 @@ public class WebsocketMultipleConnectionTest {
}
}
-
}
-
}
-
}
private static abstract class WebsocketClient extends Endpoint
@@ -395,5 +378,4 @@ public class WebsocketMultipleConnectionTest {
session.addMessageHandler(this);
}
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/VersionResource.java
----------------------------------------------------------------------
diff --git a/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/VersionResource.java b/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/VersionResource.java
index ab0e287..4d613c0 100644
--- a/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/VersionResource.java
+++ b/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/VersionResource.java
@@ -52,9 +52,6 @@ public class VersionResource {
}
}
- /**
- * @return
- */
private ServerVersion getServerVersion() {
GatewayServices services = (GatewayServices)request.getServletContext().
getAttribute(GatewayServices.GATEWAY_SERVICES_ATTRIBUTE);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/deploy/AdminServiceDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/deploy/AdminServiceDeploymentContributor.java b/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/deploy/AdminServiceDeploymentContributor.java
index f0b9228..9328f44 100644
--- a/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/deploy/AdminServiceDeploymentContributor.java
+++ b/gateway-service-admin/src/main/java/org/apache/knox/gateway/service/admin/deploy/AdminServiceDeploymentContributor.java
@@ -19,38 +19,22 @@ package org.apache.knox.gateway.service.admin.deploy;
import org.apache.knox.gateway.jersey.JerseyServiceDeploymentContributorBase;
-/**
- *
- */
public class AdminServiceDeploymentContributor extends JerseyServiceDeploymentContributorBase {
-
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "KNOX";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "knox";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{ "org.apache.knox.gateway.service.admin" };
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{ "*/**?**" };
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-health/src/main/java/org/apache/knox/gateway/service/health/deploy/HealthServiceDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-health/src/main/java/org/apache/knox/gateway/service/health/deploy/HealthServiceDeploymentContributor.java b/gateway-service-health/src/main/java/org/apache/knox/gateway/service/health/deploy/HealthServiceDeploymentContributor.java
index b814586..e9ea594 100644
--- a/gateway-service-health/src/main/java/org/apache/knox/gateway/service/health/deploy/HealthServiceDeploymentContributor.java
+++ b/gateway-service-health/src/main/java/org/apache/knox/gateway/service/health/deploy/HealthServiceDeploymentContributor.java
@@ -21,33 +21,21 @@ import org.apache.knox.gateway.jersey.JerseyServiceDeploymentContributorBase;
public class HealthServiceDeploymentContributor extends JerseyServiceDeploymentContributorBase {
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "HEALTH";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "HealthService";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{"org.apache.knox.gateway.service.health"};
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{"*/**?**"};
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-knoxsso/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOServiceDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-knoxsso/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOServiceDeploymentContributor.java b/gateway-service-knoxsso/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOServiceDeploymentContributor.java
index aaf5fb9..261c7c8 100644
--- a/gateway-service-knoxsso/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOServiceDeploymentContributor.java
+++ b/gateway-service-knoxsso/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOServiceDeploymentContributor.java
@@ -22,33 +22,21 @@ import org.apache.knox.gateway.jersey.JerseyServiceDeploymentContributorBase;
public class KnoxSSOServiceDeploymentContributor extends
JerseyServiceDeploymentContributorBase {
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "KNOXSSO";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "KnoxSSOService";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{ "org.apache.knox.gateway.service.knoxsso" };
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{ "api/**?**" };
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-knoxssout/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOutServiceDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-knoxssout/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOutServiceDeploymentContributor.java b/gateway-service-knoxssout/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOutServiceDeploymentContributor.java
index 9b391c7..d183734 100644
--- a/gateway-service-knoxssout/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOutServiceDeploymentContributor.java
+++ b/gateway-service-knoxssout/src/main/java/org/apache/knox/gateway/service/knoxsso/deploy/KnoxSSOutServiceDeploymentContributor.java
@@ -21,33 +21,21 @@ import org.apache.knox.gateway.jersey.JerseyServiceDeploymentContributorBase;
public class KnoxSSOutServiceDeploymentContributor extends JerseyServiceDeploymentContributorBase {
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "KNOXSSOUT";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "KnoxSSOutService";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{ "org.apache.knox.gateway.service.knoxsso" };
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{ "api/**?**" };
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-knoxssout/src/test/java/org/apache/knox/gateway/service/knoxsso/WebSSOutResourceTest.java
----------------------------------------------------------------------
diff --git a/gateway-service-knoxssout/src/test/java/org/apache/knox/gateway/service/knoxsso/WebSSOutResourceTest.java b/gateway-service-knoxssout/src/test/java/org/apache/knox/gateway/service/knoxsso/WebSSOutResourceTest.java
index e5bcbff..a519939 100644
--- a/gateway-service-knoxssout/src/test/java/org/apache/knox/gateway/service/knoxsso/WebSSOutResourceTest.java
+++ b/gateway-service-knoxssout/src/test/java/org/apache/knox/gateway/service/knoxsso/WebSSOutResourceTest.java
@@ -20,9 +20,6 @@ package org.apache.knox.gateway.service.knoxsso;
import org.junit.Assert;
import org.junit.Test;
-/**
- *
- */
public class WebSSOutResourceTest {
@Test
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-knoxtoken/src/main/java/org/apache/knox/gateway/service/knoxtoken/deploy/TokenServiceDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-knoxtoken/src/main/java/org/apache/knox/gateway/service/knoxtoken/deploy/TokenServiceDeploymentContributor.java b/gateway-service-knoxtoken/src/main/java/org/apache/knox/gateway/service/knoxtoken/deploy/TokenServiceDeploymentContributor.java
index e094859..830c660 100644
--- a/gateway-service-knoxtoken/src/main/java/org/apache/knox/gateway/service/knoxtoken/deploy/TokenServiceDeploymentContributor.java
+++ b/gateway-service-knoxtoken/src/main/java/org/apache/knox/gateway/service/knoxtoken/deploy/TokenServiceDeploymentContributor.java
@@ -21,33 +21,21 @@ import org.apache.knox.gateway.jersey.JerseyServiceDeploymentContributorBase;
public class TokenServiceDeploymentContributor extends JerseyServiceDeploymentContributorBase {
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "KNOXTOKEN";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "KnoxTokenService";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{ "org.apache.knox.gateway.service.knoxtoken" };
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{ "knoxtoken/api/**?**" };
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-remoteconfig/src/main/java/org/apache/knox/gateway/service/config/remote/RemoteConfigurationMessages.java
----------------------------------------------------------------------
diff --git a/gateway-service-remoteconfig/src/main/java/org/apache/knox/gateway/service/config/remote/RemoteConfigurationMessages.java b/gateway-service-remoteconfig/src/main/java/org/apache/knox/gateway/service/config/remote/RemoteConfigurationMessages.java
index 2c49506..a243330 100644
--- a/gateway-service-remoteconfig/src/main/java/org/apache/knox/gateway/service/config/remote/RemoteConfigurationMessages.java
+++ b/gateway-service-remoteconfig/src/main/java/org/apache/knox/gateway/service/config/remote/RemoteConfigurationMessages.java
@@ -22,9 +22,6 @@ import org.apache.knox.gateway.i18n.messages.Messages;
import org.apache.knox.gateway.i18n.messages.StackTrace;
-/**
- *
- */
@Messages(logger="org.apache.knox.gateway.service.config.remote")
public interface RemoteConfigurationMessages {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-rm/src/main/java/org/apache/knox/gateway/rm/dispatch/RMUIHaDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-service-rm/src/main/java/org/apache/knox/gateway/rm/dispatch/RMUIHaDispatch.java b/gateway-service-rm/src/main/java/org/apache/knox/gateway/rm/dispatch/RMUIHaDispatch.java
index 3ec7d53..3143af1 100644
--- a/gateway-service-rm/src/main/java/org/apache/knox/gateway/rm/dispatch/RMUIHaDispatch.java
+++ b/gateway-service-rm/src/main/java/org/apache/knox/gateway/rm/dispatch/RMUIHaDispatch.java
@@ -27,9 +27,6 @@ public class RMUIHaDispatch extends RMHaBaseDispatcher {
private static final String RESOURCE_ROLE = "YARNUI";
private HaProvider haProvider;
- /**
- * @throws javax.servlet.ServletException
- */
public RMUIHaDispatch() throws ServletException {
super();
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-test/src/main/java/org/apache/knox/gateway/service/test/deploy/ServiceTestDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-test/src/main/java/org/apache/knox/gateway/service/test/deploy/ServiceTestDeploymentContributor.java b/gateway-service-test/src/main/java/org/apache/knox/gateway/service/test/deploy/ServiceTestDeploymentContributor.java
index ba5c19f..ea08565 100644
--- a/gateway-service-test/src/main/java/org/apache/knox/gateway/service/test/deploy/ServiceTestDeploymentContributor.java
+++ b/gateway-service-test/src/main/java/org/apache/knox/gateway/service/test/deploy/ServiceTestDeploymentContributor.java
@@ -27,40 +27,25 @@ import org.apache.knox.gateway.topology.Service;
import java.util.ArrayList;
import java.util.List;
-/**
- *
- */
public class ServiceTestDeploymentContributor extends JerseyServiceDeploymentContributorBase {
private static final String PACKAGES_PARAM = "jersey.config.server.provider.packages";
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "SERVICE-TEST";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "service-test";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{ "org.apache.knox.gateway.service.test" };
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{ "*/**?**", "/*" };
@@ -92,11 +77,7 @@ public class ServiceTestDeploymentContributor extends JerseyServiceDeploymentCon
traceLevel.name( "jersey.config.server.tracing.threshold" );
traceLevel.value( "VERBOSE" );
params.add( traceLevel );
- context.contributeFilter( service, resource, "pivot", "jersey", params );
-
-
context.contributeFilter(service, resource, "pivot", "jersey", params);
-
}
}
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/CredentialResource.java
----------------------------------------------------------------------
diff --git a/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/CredentialResource.java b/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/CredentialResource.java
index 73c9859..5a78500 100644
--- a/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/CredentialResource.java
+++ b/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/CredentialResource.java
@@ -73,9 +73,6 @@ public class CredentialResource {
}
}
- /**
- * @return
- */
private List<String> getCredentialsList() {
GatewayServices services = (GatewayServices)request.getServletContext().
getAttribute(GatewayServices.GATEWAY_SERVICES_ATTRIBUTE);
@@ -90,10 +87,6 @@ public class CredentialResource {
return aliases;
}
- /**
- * @param alias
- * @return
- */
private CredentialValue getCredentialValueForAlias(String alias) {
GatewayServices services = (GatewayServices)request.getServletContext().
getAttribute(GatewayServices.GATEWAY_SERVICES_ATTRIBUTE);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/deploy/VaultServiceDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/deploy/VaultServiceDeploymentContributor.java b/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/deploy/VaultServiceDeploymentContributor.java
index f46d58f..3eec39d 100644
--- a/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/deploy/VaultServiceDeploymentContributor.java
+++ b/gateway-service-vault/src/main/java/org/apache/knox/gateway/service/vault/deploy/VaultServiceDeploymentContributor.java
@@ -19,38 +19,23 @@ package org.apache.knox.gateway.service.vault.deploy;
import org.apache.knox.gateway.jersey.JerseyServiceDeploymentContributorBase;
-/**
- *
- */
public class VaultServiceDeploymentContributor extends JerseyServiceDeploymentContributorBase {
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getRole()
- */
@Override
public String getRole() {
return "VAULT";
}
- /* (non-Javadoc)
- * @see ServiceDeploymentContributor#getName()
- */
@Override
public String getName() {
return "KnoxVaultService";
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPackages()
- */
@Override
protected String[] getPackages() {
return new String[]{ "org.apache.knox.gateway.service.vault" };
}
- /* (non-Javadoc)
- * @see JerseyServiceDeploymentContributorBase#getPatterns()
- */
@Override
protected String[] getPatterns() {
return new String[]{ "vault/**?**" };
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/HdfsUIHaDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/HdfsUIHaDispatch.java b/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/HdfsUIHaDispatch.java
index 37b7f0d..b84f8f3 100644
--- a/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/HdfsUIHaDispatch.java
+++ b/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/HdfsUIHaDispatch.java
@@ -22,9 +22,6 @@ import javax.servlet.ServletException;
public class HdfsUIHaDispatch extends AbstractHdfsHaDispatch {
public static final String RESOURCE_ROLE = "HDFSUI";
- /**
- * @throws javax.servlet.ServletException
- */
public HdfsUIHaDispatch() throws ServletException {
super();
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/WebHdfsHaDispatch.java b/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
index 657de89..6cff354 100644
--- a/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
+++ b/gateway-service-webhdfs/src/main/java/org/apache/knox/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
@@ -22,9 +22,6 @@ import javax.servlet.ServletException;
public class WebHdfsHaDispatch extends AbstractHdfsHaDispatch {
public static final String RESOURCE_ROLE = "WEBHDFS";
- /**
- * @throws javax.servlet.ServletException
- */
public WebHdfsHaDispatch() throws ServletException {
super();
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractJavaConsoleCredentialCollector.java
----------------------------------------------------------------------
diff --git a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractJavaConsoleCredentialCollector.java b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractJavaConsoleCredentialCollector.java
index 63d7b18..e077ad6 100644
--- a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractJavaConsoleCredentialCollector.java
+++ b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractJavaConsoleCredentialCollector.java
@@ -19,9 +19,6 @@ package org.apache.knox.gateway.shell;
import java.io.Console;
-/**
- *
- */
public abstract class AbstractJavaConsoleCredentialCollector extends AbstractCredentialCollector {
public AbstractJavaConsoleCredentialCollector() {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractRequest.java
----------------------------------------------------------------------
diff --git a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractRequest.java b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractRequest.java
index c95c3f0..1a6af29 100644
--- a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractRequest.java
+++ b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/AbstractRequest.java
@@ -49,11 +49,7 @@ public abstract class AbstractRequest<T> {
addHeaders(request, session.getHeaders());
return session.executeNow( request );
}
-
- /**
- * @param request
- * @param headers
- */
+
private void addHeaders(HttpRequest request, Map<String, String> headers) {
for(Entry<String, String> header : headers.entrySet()) {
request.setHeader(header.getKey(), header.getValue());
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-shell/src/main/java/org/apache/knox/gateway/shell/ClearInputCredentialCollector.java
----------------------------------------------------------------------
diff --git a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/ClearInputCredentialCollector.java b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/ClearInputCredentialCollector.java
index 0b26563..4e94383 100644
--- a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/ClearInputCredentialCollector.java
+++ b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/ClearInputCredentialCollector.java
@@ -17,12 +17,9 @@
*/
package org.apache.knox.gateway.shell;
-
public class ClearInputCredentialCollector extends AbstractJavaConsoleCredentialCollector {
public static final String COLLECTOR_TYPE = "ClearInput";
- /* (non-Javadoc)
- * @see CredentialCollector#collect()
- */
+
@Override
public void collect() throws CredentialCollectionException {
boolean valid = false;
@@ -35,9 +32,6 @@ public class ClearInputCredentialCollector extends AbstractJavaConsoleCredential
}
}
- /* (non-Javadoc)
- * @see CredentialCollector#name()
- */
@Override
public String type() {
return COLLECTOR_TYPE;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-shell/src/main/java/org/apache/knox/gateway/shell/HiddenInputCredentialCollector.java
----------------------------------------------------------------------
diff --git a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/HiddenInputCredentialCollector.java b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/HiddenInputCredentialCollector.java
index 00a9bb7..075fb4c 100644
--- a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/HiddenInputCredentialCollector.java
+++ b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/HiddenInputCredentialCollector.java
@@ -17,12 +17,9 @@
*/
package org.apache.knox.gateway.shell;
-
public class HiddenInputCredentialCollector extends AbstractJavaConsoleCredentialCollector {
public static final String COLLECTOR_TYPE = "HiddenInput";
- /* (non-Javadoc)
- * @see CredentialCollector#collect()
- */
+
@Override
public void collect() throws CredentialCollectionException {
boolean valid = false;
@@ -35,9 +32,6 @@ public class HiddenInputCredentialCollector extends AbstractJavaConsoleCredentia
}
}
- /* (non-Javadoc)
- * @see CredentialCollector#name()
- */
@Override
public String type() {
return COLLECTOR_TYPE;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxSh.java
----------------------------------------------------------------------
diff --git a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxSh.java b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxSh.java
index 34914f5..fdb09a5 100644
--- a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxSh.java
+++ b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxSh.java
@@ -42,9 +42,6 @@ import java.util.Map;
import java.util.Set;
import java.util.TimeZone;
-/**
- *
- */
public class KnoxSh {
private static final String USAGE_PREFIX = "KnoxSh {cmd} [options]";
@@ -61,9 +58,7 @@ public class KnoxSh {
private Command command;
private String gateway = null;
- /* (non-Javadoc)
- * @see org.apache.hadoop.util.Tool#run(java.lang.String[])
- */
+
public int run(String[] args) throws Exception {
int exitCode = 0;
try {
@@ -94,9 +89,9 @@ public class KnoxSh {
* % knoxcli service-test [--u user] [--p password] [--cluster clustername] [--hostname name] [--port port]
*
* </pre>
- * @param args
- * @return
- * @throws IOException
+ * @param args command line arguments
+ * @return exit code
+ * @throws IOException exception on init
*/
private int init(String[] args) throws IOException {
if (args.length == 0) {
@@ -298,8 +293,8 @@ public class KnoxSh {
}
/**
- * @param args
- * @throws Exception
+ * @param args command line arguments
+ * @throws Exception thrown if there is an issue
*/
public static void main(String[] args) throws Exception {
KnoxSh sh = new KnoxSh();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxTokenCredentialCollector.java
----------------------------------------------------------------------
diff --git a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxTokenCredentialCollector.java b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxTokenCredentialCollector.java
index e05f00a..71fe605 100644
--- a/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxTokenCredentialCollector.java
+++ b/gateway-shell/src/main/java/org/apache/knox/gateway/shell/KnoxTokenCredentialCollector.java
@@ -39,9 +39,6 @@ public class KnoxTokenCredentialCollector extends AbstractCredentialCollector {
private String tokenType = null;
- /* (non-Javadoc)
- * @see CredentialCollector#collect()
- */
@Override
public void collect() throws CredentialCollectionException {
String userDir = System.getProperty("user.home");
@@ -75,9 +72,6 @@ public class KnoxTokenCredentialCollector extends AbstractCredentialCollector {
return tokenType;
}
- /* (non-Javadoc)
- * @see CredentialCollector#name()
- */
@Override
public String type() {
return COLLECTOR_TYPE;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayMessages.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayMessages.java b/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayMessages.java
index 22dad46..8fffb36 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayMessages.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayMessages.java
@@ -27,9 +27,7 @@ import java.net.URI;
import java.nio.charset.Charset;
-/**
- *
- */
+
@Messages(logger="org.apache.knox.gateway")
public interface SpiGatewayMessages {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayResources.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayResources.java b/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayResources.java
index 59e97b3..5de55e9 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayResources.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/SpiGatewayResources.java
@@ -20,9 +20,6 @@ package org.apache.knox.gateway;
import org.apache.knox.gateway.i18n.resources.Resource;
import org.apache.knox.gateway.i18n.resources.Resources;
-/**
- *
- */
@Resources
public interface SpiGatewayResources {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/config/GatewayConfig.java
----------------------------------------------------------------------
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 416160b..53e8394 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
@@ -168,56 +168,56 @@ public interface GatewayConfig {
* Returns true if websocket feature enabled else false.
* Default is false.
* @since 0.10
- * @return
+ * @return true if websocket feature is enabled
*/
boolean isWebsocketEnabled();
/**
* Websocket connection max text message size.
* @since 0.10
- * @return
+ * @return max text message size
*/
int getWebsocketMaxTextMessageSize();
/**
* Websocket connection max binary message size.
* @since 0.10
- * @return
+ * @return max binary message size
*/
int getWebsocketMaxBinaryMessageSize();
/**
* Websocket connection max text message buffer size.
* @since 0.10
- * @return
+ * @return buffer size
*/
int getWebsocketMaxTextMessageBufferSize();
/**
* Websocket connection max binary message buffer size.
* @since 0.10
- * @return
+ * @return buffer size
*/
int getWebsocketMaxBinaryMessageBufferSize();
/**
* Websocket connection input buffer size.
* @since 0.10
- * @return
+ * @return buffer size
*/
int getWebsocketInputBufferSize();
/**
* Websocket connection async write timeout.
* @since 0.10
- * @return
+ * @return timeout
*/
int getWebsocketAsyncWriteTimeout();
/**
* Websocket connection idle timeout.
* @since 0.10
- * @return
+ * @return timeout
*/
int getWebsocketIdleTimeout();
@@ -243,68 +243,67 @@ public interface GatewayConfig {
/**
* Configured name of the HTTP Header that is expected
* to be set by a proxy in front of the gateway.
- * @return
+ * @return header name
*/
String getHeaderNameForRemoteAddress();
/**
* Configured Algorithm name to be used by the CryptoService
* and MasterService implementations
- * @return
+ * @return algorithm
*/
String getAlgorithm();
/**
* Configured Algorithm name to be used by the CryptoService
* for password based encryption
- * @return
+ * @return algorithm
*/
String getPBEAlgorithm();
/**
* Configured Transformation name to be used by the CryptoService
* and MasterService implementations
- * @return
+ * @return transformation name
*/
String getTransformation();
/**
* Configured SaltSize to be used by the CryptoService
* and MasterService implementations
- * @return
+ * @return salt size
*/
String getSaltSize();
/**
* Configured IterationCount to be used by the CryptoService
* and MasterService implementations
- * @return
+ * @return iteration count
*/
String getIterationCount();
/**
* Configured KeyLength to be used by the CryptoService
* and MasterService implementations
- * @return
+ * @return key length
*/
String getKeyLength();
/**
* Map of Topology names and their ports.
- *
- * @return
+ * @return Map of Topology names and their ports.
*/
Map<String, Integer> getGatewayPortMappings();
/**
* Is the Port Mapping feature on
- * @return
+ * @return true if port mapping enabled
*/
boolean isGatewayPortMappingEnabled();
/**
* Is the Server header suppressed
- * @return
+ * @return turn if server header enabled
*/
boolean isGatewayServerHeaderEnabled();
@@ -385,13 +384,13 @@ public interface GatewayConfig {
/**
* Get the comma separated list of group names that represent Knox Admin users
- * @return
+ * @return comma separate list of admin group names
*/
String getKnoxAdminGroups();
/**
* Get the comma separated list of user names that represent Knox Admin users
- * @return
+ * @return comma separated list of admin user names
*/
String getKnoxAdminUsers();
@@ -399,7 +398,7 @@ public interface GatewayConfig {
* Custom header name to be used to pass the authenticated principal
* via dispatch
* @since 1.1.0
- * @return
+ * @return federation header
*/
String getFederationHeaderName();
@@ -407,7 +406,7 @@ public interface GatewayConfig {
* Get the list of topology names that should be redeployed on restart.
* manager and admin are default topologies as they may depend on gateway-site.xml
* configuration for deployment time config.
- * @return
+ * @return list of topology names
*/
List<String> getAutoDeployTopologyNames();
@@ -433,7 +432,7 @@ public interface GatewayConfig {
* Knox will log an ERROR and move on.
*
* @since 1.1.0
- * @return
+ * @return true if topology validation enabled
*/
boolean isTopologyValidationEnabled();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/dispatch/DefaultDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/dispatch/DefaultDispatch.java b/gateway-spi/src/main/java/org/apache/knox/gateway/dispatch/DefaultDispatch.java
index cfef9ab..6eaccc8 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/dispatch/DefaultDispatch.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/dispatch/DefaultDispatch.java
@@ -54,9 +54,6 @@ import java.util.HashSet;
import java.util.Locale;
import java.util.Set;
-/**
- *
- */
public class DefaultDispatch extends AbstractGatewayDispatch {
protected static final String SET_COOKIE = "SET-COOKIE";
@@ -228,12 +225,11 @@ public class DefaultDispatch extends AbstractGatewayDispatch {
* This method provides a hook for specialized credential propagation
* in subclasses.
*
- * @param outboundRequest
+ * @param outboundRequest outboundRequest to add credentials to
*/
protected void addCredentialsToRequest(HttpUriRequest outboundRequest) {
}
-
protected HttpEntity createRequestEntity(HttpServletRequest request)
throws IOException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/filter/AbstractGatewayFilter.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/filter/AbstractGatewayFilter.java b/gateway-spi/src/main/java/org/apache/knox/gateway/filter/AbstractGatewayFilter.java
index fc53c6e..9377d95 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/filter/AbstractGatewayFilter.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/filter/AbstractGatewayFilter.java
@@ -31,9 +31,6 @@ import org.apache.knox.gateway.i18n.messages.MessagesFactory;
import java.io.IOException;
-/**
- *
- */
public abstract class AbstractGatewayFilter implements Filter {
public static final String SOURCE_REQUEST_URL_ATTRIBUTE_NAME = "sourceRequestUrl";
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionBase.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionBase.java b/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionBase.java
index 031d9be..263a83b 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionBase.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionBase.java
@@ -26,7 +26,7 @@ public class AbstractIdentityAssertionBase {
/**
* Retrieve the principal to represent the asserted identity from
* the provided Subject.
- * @param subject
+ * @param subject subject to get the principal from
* @return principalName
*/
protected String getPrincipalName(Subject subject) {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionFilter.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionFilter.java b/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionFilter.java
index 99e1d46..2e6e311 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionFilter.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/filter/security/AbstractIdentityAssertionFilter.java
@@ -95,9 +95,6 @@ public abstract class AbstractIdentityAssertionFilter extends AbstractIdentityAs
* Recreate the current Subject based upon the provided mappedPrincipal
* and look for the groups that should be associated with the new Subject.
* Upon finding groups mapped to the principal - add them to the new Subject.
- * @param mappedPrincipalName
- * @throws ServletException
- * @throws IOException
*/
protected void continueChainAsPrincipal(final ServletRequest request, final ServletResponse response,
final FilterChain chain, String mappedPrincipalName) throws IOException, ServletException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/PrincipalMapper.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/PrincipalMapper.java b/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/PrincipalMapper.java
index f11a97d..660f228 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/PrincipalMapper.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/PrincipalMapper.java
@@ -23,7 +23,6 @@ public interface PrincipalMapper {
* Load the internal principal mapping table from the provided
* string value which conforms to the following semicolon delimited format:
* actual[,another-actual]=mapped;...
- * @param principalMapping
*/
public abstract void loadMappingTable(String principalMapping, String groupMapping)
throws PrincipalMappingException;
@@ -32,7 +31,6 @@ public interface PrincipalMapper {
* Acquire a mapped principal name from the mapping table
* as appropriate. Otherwise, the provided principalName
* will be used.
- * @param principalName
* @return principal name to be used in the assertion
*/
public abstract String mapUserPrincipal(String principalName);
@@ -40,7 +38,6 @@ public interface PrincipalMapper {
/**
* Acquire array of group principal names from the mapping table
* as appropriate. Otherwise, return null.
- * @param principalName
* @return group principal names to be used in the assertion
*/
public abstract String[] mapGroupPrincipal(String principalName);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/SimplePrincipalMapper.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/SimplePrincipalMapper.java b/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/SimplePrincipalMapper.java
index 0d0551d..753cb08 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/SimplePrincipalMapper.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/security/principal/SimplePrincipalMapper.java
@@ -27,13 +27,9 @@ public class SimplePrincipalMapper implements PrincipalMapper {
public SimplePrincipalMapper() {
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.filter.PrincipalMapper#loadMappingTable(java.lang.String)
- */
+
@Override
public void loadMappingTable(String principalMapping, String groupMapping) throws PrincipalMappingException {
-// System.out.println("+++++++++++++ Loading the Mapping Table");
if (principalMapping != null) {
principalMappings = parseMapping(principalMapping);
groupMappings = parseMapping(groupMapping);
@@ -51,15 +47,12 @@ public class SimplePrincipalMapper implements PrincipalMapper {
if (t.hasMoreTokens()) {
do {
String mapping = t.nextToken();
- // System.out.println("+++++++++++++ Mapping: " + mapping);
String principals = mapping.substring(0, mapping.indexOf('='));
- // System.out.println("+++++++++++++ Principals: " + principals);
String value = mapping.substring(mapping.indexOf('=')+1);
String[] v = value.split(",");
String[] p = principals.split(",");
for(int i = 0; i < p.length; i++) {
table.put(p[i], v);
- // System.out.println("+++++++++++++ Mapping into Table: " + p[i] + "->" + value);
}
} while(t.hasMoreTokens());
}
@@ -72,10 +65,7 @@ public class SimplePrincipalMapper implements PrincipalMapper {
throw new PrincipalMappingException("Unable to load mappings from provided string: " + mappings + " - no principal mapping will be provided.", e);
}
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.filter.PrincipalMapper#mapPrincipal(java.lang.String)
- */
+
@Override
public String mapUserPrincipal(String principalName) {
String[] p = null;
@@ -89,9 +79,6 @@ public class SimplePrincipalMapper implements PrincipalMapper {
return p[0];
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.filter.PrincipalMapper#mapPrincipal(java.lang.String)
- */
@Override
public String[] mapGroupPrincipal(String principalName) {
String[] groups = null;
@@ -111,11 +98,6 @@ public class SimplePrincipalMapper implements PrincipalMapper {
return groups;
}
- /**
- * @param first
- * @param second
- * @return
- */
public static <T> T[] concat(T[] first, T[] second) {
T[] result = Arrays.copyOf(first, first.length + second.length);
System.arraycopy(second, 0, result, first.length, second.length);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/FileBasedHostMapper.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/FileBasedHostMapper.java b/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/FileBasedHostMapper.java
index 6d8c9d8..2055e53 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/FileBasedHostMapper.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/FileBasedHostMapper.java
@@ -56,9 +56,6 @@ public class FileBasedHostMapper implements HostMapper {
}
}
- /* (non-Javadoc)
- * @see HostMapper#resolveInboundHostName(java.lang.String)
- */
@Override
public String resolveInboundHostName( String hostName ) {
String resolvedHostName = inbound.get( hostName );
@@ -68,9 +65,6 @@ public class FileBasedHostMapper implements HostMapper {
return resolvedHostName;
}
- /* (non-Javadoc)
- * @see HostMapper#resolveOutboundHostName(java.lang.String)
- */
@Override
public String resolveOutboundHostName( String hostName ) {
String resolvedHostName = outbound.get( hostName );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapper.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapper.java b/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapper.java
index a633b69..9c008d0 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapper.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapper.java
@@ -17,21 +17,9 @@
*/
package org.apache.knox.gateway.services.hostmap;
-/**
- *
- */
public interface HostMapper {
-
- /**
- * @param inboundHost
- * @return
- */
public abstract String resolveInboundHostName( String inboundHost );
- /**
- * @param outboundHost
- * @return
- */
public abstract String resolveOutboundHostName( String outboundHost );
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapperService.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapperService.java b/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapperService.java
index 6743370..ebdf77a 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapperService.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/services/hostmap/HostMapperService.java
@@ -21,21 +21,10 @@ import org.apache.knox.gateway.services.Service;
public interface HostMapperService extends Service {
- /**
- * @param clusterName
- * @return
- */
HostMapper getHostMapper( String clusterName );
- /**
- * @param clusterName
- * @param hostMapper
- */
void registerHostMapperForCluster( String clusterName, HostMapper hostMapper );
- /**
- * @param clusterName
- */
void removeHostMapperForCluster( String clusterName );
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTProviderMessages.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTProviderMessages.java b/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTProviderMessages.java
index 1c894cb..2d8e589 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTProviderMessages.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTProviderMessages.java
@@ -26,9 +26,6 @@ import org.apache.knox.gateway.i18n.messages.StackTrace;
import com.nimbusds.jose.JOSEException;
-/**
- *
- */
@Messages(logger="org.apache.knox.gateway")
public interface JWTProviderMessages {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTToken.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTToken.java b/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTToken.java
index 258625b..f714ccc 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTToken.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/services/security/token/impl/JWTToken.java
@@ -78,24 +78,18 @@ public class JWTToken implements JWT {
jwt = new SignedJWT(header, claims);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getPayloadToSign()
- */
@Override
public String getHeader() {
JWSHeader header = jwt.getHeader();
return header.toString();
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getPayloadToSign()
- */
@Override
public String getClaims() {
String c = null;
JWTClaimsSet claims = null;
try {
- claims = (JWTClaimsSet) jwt.getJWTClaimsSet();
+ claims = jwt.getJWTClaimsSet();
c = claims.toJSONObject().toJSONString();
} catch (ParseException e) {
log.unableToParseToken(e);
@@ -103,9 +97,6 @@ public class JWTToken implements JWT {
return c;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getPayloadToSign()
- */
@Override
public String getPayload() {
Payload payload = jwt.getPayload();
@@ -116,17 +107,11 @@ public class JWTToken implements JWT {
return jwt.serialize();
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#setSignaturePayload(byte[])
- */
@Override
public void setSignaturePayload(byte[] payload) {
// this.payload = payload;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getSignaturePayload()
- */
@Override
public byte[] getSignaturePayload() {
byte[] b = null;
@@ -143,9 +128,6 @@ public class JWTToken implements JWT {
return new JWTToken(parts[0], parts[1], parts[2]);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getClaim(java.lang.String)
- */
@Override
public String getClaim(String claimName) {
String claim = null;
@@ -159,25 +141,16 @@ public class JWTToken implements JWT {
return claim;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getSubject()
- */
@Override
public String getSubject() {
return getClaim(JWT.SUBJECT);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getIssuer()
- */
@Override
public String getIssuer() {
return getClaim(JWT.ISSUER);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getAudience()
- */
@Override
public String getAudience() {
String[] claim = null;
@@ -191,9 +164,6 @@ public class JWTToken implements JWT {
return c;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getAudienceClaims()
- */
@Override
public String[] getAudienceClaims() {
String[] claims = null;
@@ -207,9 +177,6 @@ public class JWTToken implements JWT {
return claims;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getExpires()
- */
@Override
public String getExpires() {
Date expires = getExpiresDate();
@@ -241,18 +208,11 @@ public class JWTToken implements JWT {
return date;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#getPrincipal()
- */
@Override
public String getPrincipal() {
return getClaim(JWT.PRINCIPAL);
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#sign(JWSSigner)
- */
@Override
public void sign(JWSSigner signer) {
try {
@@ -262,9 +222,6 @@ public class JWTToken implements JWT {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.impl.JWT#verify(JWSVerifier)
- */
public boolean verify(JWSVerifier verifier) {
boolean rc = false;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/main/java/org/apache/knox/gateway/topology/Service.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/main/java/org/apache/knox/gateway/topology/Service.java b/gateway-spi/src/main/java/org/apache/knox/gateway/topology/Service.java
index b651bec..bff840f 100644
--- a/gateway-spi/src/main/java/org/apache/knox/gateway/topology/Service.java
+++ b/gateway-spi/src/main/java/org/apache/knox/gateway/topology/Service.java
@@ -167,7 +167,7 @@ public class Service {
* Add a custom dispatch that overrides the dispatch
* specified in service definition.
* @since 1.2.0
- * @param dispatch
+ * @param dispatch dispatch to add
*/
public void addDispatch(CustomDispatch dispatch) {
this.dispatch = dispatch;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-spi/src/test/java/org/apache/knox/gateway/dispatch/URLDecodingDispatchTest.java
----------------------------------------------------------------------
diff --git a/gateway-spi/src/test/java/org/apache/knox/gateway/dispatch/URLDecodingDispatchTest.java b/gateway-spi/src/test/java/org/apache/knox/gateway/dispatch/URLDecodingDispatchTest.java
index 61e1e48..2423715 100644
--- a/gateway-spi/src/test/java/org/apache/knox/gateway/dispatch/URLDecodingDispatchTest.java
+++ b/gateway-spi/src/test/java/org/apache/knox/gateway/dispatch/URLDecodingDispatchTest.java
@@ -40,10 +40,8 @@ public class URLDecodingDispatchTest {
super();
}
- /**
+ /*
* Test whether the encoded url is decoded properly.
- *
- * @throws Exception
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT)
public void testGetDispatchUrl() throws Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-test-release-utils/src/main/java/org/apache/knox/gateway/GatewayTestConfig.java
----------------------------------------------------------------------
diff --git a/gateway-test-release-utils/src/main/java/org/apache/knox/gateway/GatewayTestConfig.java b/gateway-test-release-utils/src/main/java/org/apache/knox/gateway/GatewayTestConfig.java
index edf47ce..bd50e07 100644
--- a/gateway-test-release-utils/src/main/java/org/apache/knox/gateway/GatewayTestConfig.java
+++ b/gateway-test-release-utils/src/main/java/org/apache/knox/gateway/GatewayTestConfig.java
@@ -101,37 +101,21 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return gatewayHomeDir + "/deployments";
}
-// public void setDeploymentDir( String clusterConfDir ) {
-// this.deployDir = clusterConfDir;
-// }
-
@Override
public String getHadoopConfDir() {
return hadoopConfDir;
}
-// public void setHadoopConfDir( String hadoopConfDir ) {
-// this.hadoopConfDir = hadoopConfDir;
-// }
-
@Override
public String getGatewayHost() {
return gatewayHost;
}
-// public void setGatewayHost( String gatewayHost ) {
-// this.gatewayHost = gatewayHost;
-// }
-
@Override
public int getGatewayPort() {
return gatewayPort;
}
-// public void setGatewayPort( int gatewayPort ) {
-// this.gatewayPort = gatewayPort;
-// }
-
@Override
public String getGatewayPath() {
return gatewayPath;
@@ -146,7 +130,6 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return new InetSocketAddress( getGatewayHost(), getGatewayPort() );
}
-
public long getGatewayIdleTimeout() {
return 0l;
}
@@ -201,23 +184,15 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
this.defaultTopologyName = defaultTopologyName;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getDefaultAppRedirectPath()
- */
@Override
public String getDefaultAppRedirectPath() {
-
if(StringUtils.isBlank(this.defaultTopologyName)) {
return "/gateway/sandbox";
} else {
return "/gateway/"+this.defaultTopologyName;
}
-
}
- /* (non-Javadoc)
- * @see GatewayConfig#getFrontendUrl()
- */
@Override
public String getFrontendUrl() { return frontendUrl; }
@@ -225,9 +200,6 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
this.frontendUrl = frontendUrl;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getExcludedSSLProtocols()
- */
@Override
public List getExcludedSSLProtocols() {
List<String> protocols = new ArrayList<>();
@@ -253,33 +225,21 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
excludedSSLCiphers = list;
}
- /* (non-Javadoc)
- * @see GatewayConfig#isClientAuthNeeded()
- */
@Override
public boolean isClientAuthNeeded() {
return false;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getTruststorePath()
- */
@Override
public String getTruststorePath() {
return null;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getTrustAllCerts()
- */
@Override
public boolean getTrustAllCerts() {
return false;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getTruststoreType()
- */
@Override
public String getTruststoreType() {
return truststoreType;
@@ -289,9 +249,6 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
this.truststoreType = truststoreType;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getKeystoreType()
- */
@Override
public String getKeystoreType() {
return keystoreType;
@@ -341,9 +298,6 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
xForwardedEnabled = enabled;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getEphemeralDHKeySize()
- */
@Override
public String getEphemeralDHKeySize() {
return "2048";
@@ -415,17 +369,11 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
backupAgeLimit = newBackupAgeLimit;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getSigningKeystoreName()
- */
@Override
public String getSigningKeystoreName() {
return null;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getSigningKeyAlias()
- */
@Override
public String getSigningKeyAlias() {
return null;
@@ -443,65 +391,41 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return services;
}
- /* (non-Javadoc)
- * @see GatewayConfig#isWebsocketEnabled()
- */
@Override
public boolean isWebsocketEnabled() {
return DEFAULT_WEBSOCKET_FEATURE_ENABLED;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketMaxTextMessageSize()
- */
@Override
public int getWebsocketMaxTextMessageSize() {
return DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketMaxBinaryMessageSize()
- */
@Override
public int getWebsocketMaxBinaryMessageSize() {
return DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketMaxTextMessageBufferSize()
- */
@Override
public int getWebsocketMaxTextMessageBufferSize() {
return DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketMaxBinaryMessageBufferSize()
- */
@Override
public int getWebsocketMaxBinaryMessageBufferSize() {
return DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketInputBufferSize()
- */
@Override
public int getWebsocketInputBufferSize() {
return DEFAULT_WEBSOCKET_INPUT_BUFFER_SIZE;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketAsyncWriteTimeout()
- */
@Override
public int getWebsocketAsyncWriteTimeout() {
return DEFAULT_WEBSOCKET_ASYNC_WRITE_TIMEOUT;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getWebsocketIdleTimeout()
- */
@Override
public int getWebsocketIdleTimeout() {
return DEFAULT_WEBSOCKET_IDLE_TIMEOUT;
@@ -577,21 +501,11 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return null;
}
- /**
- * Map of Topology names and their ports.
- *
- * @return
- */
@Override
public Map<String, Integer> getGatewayPortMappings() {
return topologyPortMapping;
}
- /**
- * Is the Port Mapping feature on ?
- *
- * @return
- */
@Override
public boolean isGatewayPortMappingEnabled() {
return isTopologyPortMappingEnabled;
@@ -642,14 +556,6 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return null;
}
- /**
- * Returns whether the Remote Alias Service is enabled or not.
- * This value also depends on whether remote registry is enabled or not.
- * if it is enabled then this option takes effect else this option has no
- * effect.
- *
- * @return
- */
@Override
public boolean isRemoteAliasServiceEnabled() {
return true;
@@ -692,13 +598,6 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return null;
}
- /**
- * Custom header name to be used to pass the authenticated principal via
- * dispatch
- *
- * @return
- * @since 1.1.0
- */
@Override
public String getFederationHeaderName() {
return "SM_USER";
@@ -721,17 +620,8 @@ public class GatewayTestConfig extends Configuration implements GatewayConfig {
return Collections.emptyList();
}
- /**
- * Returns true when strict topology validation is enabled, in which case if
- * topology validation fails Knox will throw a runtime exception. If false and
- * topology validation fails Knox will log an ERROR and move on.
- *
- * @return
- * @since 1.1.0
- */
@Override
public boolean isTopologyValidationEnabled() {
return false;
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingDisableFeatureTest.java
----------------------------------------------------------------------
diff --git a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingDisableFeatureTest.java b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingDisableFeatureTest.java
index 33c4114..ab7cab7 100644
--- a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingDisableFeatureTest.java
+++ b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingDisableFeatureTest.java
@@ -72,7 +72,7 @@ public class GatewayPortMappingDisableFeatureTest {
* registry of sorts for all of the services that will be used by the test methods.
* The createTopology method is used to create the topology file that would normally be read from disk.
* The driver.setupGateway invocation is where the creation of GATEWAY_HOME occurs.
- * <p/>
+ * <p>
* This would normally be done once for this suite but the failure tests start affecting each other depending
* on the state the last 'active' url
*
@@ -113,10 +113,8 @@ public class GatewayPortMappingDisableFeatureTest {
LOG_EXIT();
}
- /**
+ /*
* Test the standard case
- *
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testBasicListOperation() throws IOException {
@@ -125,9 +123,8 @@ public class GatewayPortMappingDisableFeatureTest {
LOG_EXIT();
}
- /**
+ /*
* Test the multi port fail scenario when the feature is disabled.
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testMultiPortFailOperation() throws IOException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFailTest.java
----------------------------------------------------------------------
diff --git a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFailTest.java b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFailTest.java
index 3ae2aa5..7daed0f 100644
--- a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFailTest.java
+++ b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFailTest.java
@@ -64,7 +64,7 @@ public class GatewayPortMappingFailTest {
* registry of sorts for all of the services that will be used by the test methods.
* The createTopology method is used to create the topology file that would normally be read from disk.
* The driver.setupGateway invocation is where the creation of GATEWAY_HOME occurs.
- * <p/>
+ * <p>
* This would normally be done once for this suite but the failure tests start affecting each other depending
* on the state the last 'active' url
*
@@ -104,13 +104,11 @@ public class GatewayPortMappingFailTest {
}
- /**
+ /*
* Fail when trying to use this feature on the standard port.
* Here we do not have Default Topology Feature not enabled.
*
* http://localhost:{gatewayPort}/webhdfs/v1
- *
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testMultiPortOperationFail() throws IOException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFuncTest.java
----------------------------------------------------------------------
diff --git a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFuncTest.java b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFuncTest.java
index c0a2e0c..7f8ce7a 100644
--- a/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFuncTest.java
+++ b/gateway-test/src/test/java/org/apache/knox/gateway/GatewayPortMappingFuncTest.java
@@ -65,7 +65,7 @@ public class GatewayPortMappingFuncTest {
* registry of sorts for all of the services that will be used by the test methods.
* The createTopology method is used to create the topology file that would normally be read from disk.
* The driver.setupGateway invocation is where the creation of GATEWAY_HOME occurs.
- * <p/>
+ * <p>
* This would normally be done once for this suite but the failure tests start affecting each other depending
* on the state the last 'active' url
*
@@ -107,11 +107,9 @@ public class GatewayPortMappingFuncTest {
LOG_EXIT();
}
- /**
+ /*
* Test the standard case:
* http://localhost:{gatewayPort}/gateway/eerie/webhdfs/v1
- *
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testBasicListOperation() throws IOException {
@@ -120,13 +118,11 @@ public class GatewayPortMappingFuncTest {
LOG_EXIT();
}
- /**
+ /*
* Test the Default Topology Feature, activated by property
* "default.app.topology.name"
*
* http://localhost:{eeriePort}/gateway/eerie/webhdfs/v1
- *
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testDefaultTopologyFeature() throws IOException {
@@ -135,12 +131,10 @@ public class GatewayPortMappingFuncTest {
LOG_EXIT();
}
- /**
+ /*
* Test the multi port scenario.
*
* http://localhost:{eeriePort}/webhdfs/v1
- *
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testMultiPortOperation() throws IOException {
@@ -149,12 +143,10 @@ public class GatewayPortMappingFuncTest {
LOG_EXIT();
}
- /**
+ /*
* Test the multi port scenario when gateway path is included.
*
* http://localhost:{eeriePort}/gateway/eerie/webhdfs/v1
- *
- * @throws IOException
*/
@Test(timeout = TestUtils.MEDIUM_TIMEOUT )
public void testMultiPortWithGatewayPath() throws IOException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-test/src/test/java/org/apache/knox/gateway/WebHdfsHaFuncTest.java
----------------------------------------------------------------------
diff --git a/gateway-test/src/test/java/org/apache/knox/gateway/WebHdfsHaFuncTest.java b/gateway-test/src/test/java/org/apache/knox/gateway/WebHdfsHaFuncTest.java
index d024190..2290b23 100644
--- a/gateway-test/src/test/java/org/apache/knox/gateway/WebHdfsHaFuncTest.java
+++ b/gateway-test/src/test/java/org/apache/knox/gateway/WebHdfsHaFuncTest.java
@@ -58,7 +58,7 @@ public class WebHdfsHaFuncTest {
* registry of sorts for all of the services that will be used by the test methods.
* The createTopology method is used to create the topology file that would normally be read from disk.
* The driver.setupGateway invocation is where the creation of GATEWAY_HOME occurs.
- * <p/>
+ * <p>
* This would normally be done once for this suite but the failure tests start affecting each other depending
* on the state the last 'active' url
*
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-test/src/test/java/org/apache/knox/gateway/deploy/DeploymentFactoryFuncTest.java
----------------------------------------------------------------------
diff --git a/gateway-test/src/test/java/org/apache/knox/gateway/deploy/DeploymentFactoryFuncTest.java b/gateway-test/src/test/java/org/apache/knox/gateway/deploy/DeploymentFactoryFuncTest.java
index a7cd59c..16761e7 100644
--- a/gateway-test/src/test/java/org/apache/knox/gateway/deploy/DeploymentFactoryFuncTest.java
+++ b/gateway-test/src/test/java/org/apache/knox/gateway/deploy/DeploymentFactoryFuncTest.java
@@ -635,16 +635,10 @@ public class DeploymentFactoryFuncTest {
LOG_EXIT();
}
- /**
+ /*
* Test the case where topology has federation provider configured
* and service uses anonymous authentication in which case we should
* add AnonymousFilter to the filter chain.
- * @since 1.1.0
- * @throws IOException
- * @throws SAXException
- * @throws ParserConfigurationException
- * @throws URISyntaxException
- * @throws TransformerException
*/
@Test( timeout = MEDIUM_TIMEOUT )
public void testServiceAnonAuth() throws IOException, SAXException, ParserConfigurationException, URISyntaxException, TransformerException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-util-common/src/main/java/org/apache/knox/gateway/audit/log4j/audit/Log4jAuditor.java
----------------------------------------------------------------------
diff --git a/gateway-util-common/src/main/java/org/apache/knox/gateway/audit/log4j/audit/Log4jAuditor.java b/gateway-util-common/src/main/java/org/apache/knox/gateway/audit/log4j/audit/Log4jAuditor.java
index 1a4f533..291c703 100644
--- a/gateway-util-common/src/main/java/org/apache/knox/gateway/audit/log4j/audit/Log4jAuditor.java
+++ b/gateway-util-common/src/main/java/org/apache/knox/gateway/audit/log4j/audit/Log4jAuditor.java
@@ -137,7 +137,7 @@ public class Log4jAuditor implements Auditor {
/**
* If the url contains knoxtoken parameter, mask it when logging.
- * @param originalUrl
+ * @param originalUrl original url to try to mask
* @return originalUrl masking token value
*/
public static String maskTokenFromURL(final String originalUrl) {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-util-common/src/main/java/org/apache/knox/gateway/util/CertificateUtils.java
----------------------------------------------------------------------
diff --git a/gateway-util-common/src/main/java/org/apache/knox/gateway/util/CertificateUtils.java b/gateway-util-common/src/main/java/org/apache/knox/gateway/util/CertificateUtils.java
index b55db71..dada236 100644
--- a/gateway-util-common/src/main/java/org/apache/knox/gateway/util/CertificateUtils.java
+++ b/gateway-util-common/src/main/java/org/apache/knox/gateway/util/CertificateUtils.java
@@ -37,6 +37,7 @@ public class CertificateUtils {
* @param pem
* - the pem encoding from config without the header and footer
* @return RSAPublicKey
+ * @throws ServletException exception on PEM issue
*/
public static RSAPublicKey parseRSAPublicKey(String pem) throws ServletException {
String fullPem = PEM_HEADER + pem + PEM_FOOTER;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-util-common/src/main/java/org/apache/knox/gateway/util/IpAddressValidator.java
----------------------------------------------------------------------
diff --git a/gateway-util-common/src/main/java/org/apache/knox/gateway/util/IpAddressValidator.java b/gateway-util-common/src/main/java/org/apache/knox/gateway/util/IpAddressValidator.java
index 8cb1d03..e668ee9 100644
--- a/gateway-util-common/src/main/java/org/apache/knox/gateway/util/IpAddressValidator.java
+++ b/gateway-util-common/src/main/java/org/apache/knox/gateway/util/IpAddressValidator.java
@@ -42,6 +42,7 @@ public class IpAddressValidator {
/**
* ctor - initialize an instance with the given ip address list
+ * @param commaSeparatedIpAddresses - comma separated list of ip addresses
*/
public IpAddressValidator(String commaSeparatedIpAddresses) {
if (commaSeparatedIpAddresses == null) {
@@ -52,9 +53,6 @@ public class IpAddressValidator {
parseIpAddesses(commaSeparatedIpAddresses);
}
- /**
- * @param commaSeparatedIpAddresses
- */
private void parseIpAddesses(String commaSeparatedIpAddresses) {
String[] ips = commaSeparatedIpAddresses.split(",");
ipaddr = new ArrayList<>();
@@ -100,16 +98,10 @@ public class IpAddressValidator {
return valid;
}
- /**
- * @return
- */
public boolean allowsAnyIP() {
return anyIP;
}
-
- /**
- * @return
- */
+
public ArrayList<String> getIPAddresses() {
return ipaddr;
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-util-common/src/main/java/org/apache/knox/gateway/util/Urls.java
----------------------------------------------------------------------
diff --git a/gateway-util-common/src/main/java/org/apache/knox/gateway/util/Urls.java b/gateway-util-common/src/main/java/org/apache/knox/gateway/util/Urls.java
index 1d066ef..346f3f3 100644
--- a/gateway-util-common/src/main/java/org/apache/knox/gateway/util/Urls.java
+++ b/gateway-util-common/src/main/java/org/apache/knox/gateway/util/Urls.java
@@ -27,9 +27,6 @@ import java.util.regex.Pattern;
import org.apache.commons.codec.DecoderException;
import org.apache.commons.codec.net.URLCodec;
-/**
- *
- */
public class Urls {
public static String ensureLeadingSlash( String s ) {
@@ -80,7 +77,7 @@ public class Urls {
* @param url a given URL
* @param domainSuffix a domain suffix (can be <code>null</code>)
* @return the extracted domain name
- * @throws MalformedURLException
+ * @throws MalformedURLException exception on a bad url
*/
public static String getDomainName(String url, String domainSuffix) throws MalformedURLException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-util-common/src/test/java/org/apache/knox/gateway/util/UrlsTest.java
----------------------------------------------------------------------
diff --git a/gateway-util-common/src/test/java/org/apache/knox/gateway/util/UrlsTest.java b/gateway-util-common/src/test/java/org/apache/knox/gateway/util/UrlsTest.java
index 8e6b4e7..ad76d09 100644
--- a/gateway-util-common/src/test/java/org/apache/knox/gateway/util/UrlsTest.java
+++ b/gateway-util-common/src/test/java/org/apache/knox/gateway/util/UrlsTest.java
@@ -24,13 +24,12 @@ import org.junit.Test;
public class UrlsTest {
- /**
+ /*
* Domain name creation follows the following algorithm:
* 1. if the incoming request hostname endsWith a configured domain suffix return the suffix - with prefixed dot
* 2. if the request hostname is an ip address return null for default domain
* 3. if the request hostname has less than 3 dots return null for default domain
* 4. if request hostname has more than two dots strip the first element and return the remainder as domain
- * @throws Exception
*/
@Test
public void testDomainNameCreation() throws Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-util-urltemplate/src/test/java/org/apache/knox/gateway/util/urltemplate/ParserTest.java
----------------------------------------------------------------------
diff --git a/gateway-util-urltemplate/src/test/java/org/apache/knox/gateway/util/urltemplate/ParserTest.java b/gateway-util-urltemplate/src/test/java/org/apache/knox/gateway/util/urltemplate/ParserTest.java
index 9e64bf9..9f4e417 100644
--- a/gateway-util-urltemplate/src/test/java/org/apache/knox/gateway/util/urltemplate/ParserTest.java
+++ b/gateway-util-urltemplate/src/test/java/org/apache/knox/gateway/util/urltemplate/ParserTest.java
@@ -343,7 +343,7 @@ public class ParserTest {
assertThat( template.toString(), is( text ) );
}
- /**
+ /*
* KNOX-1055
* In some cases & could be encoded as &
*/
[3/3] knox git commit: WIP
Posted by kr...@apache.org.
WIP
Signed-off-by: Kevin Risden <kr...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/knox/repo
Commit: http://git-wip-us.apache.org/repos/asf/knox/commit/488e4445
Tree: http://git-wip-us.apache.org/repos/asf/knox/tree/488e4445
Diff: http://git-wip-us.apache.org/repos/asf/knox/diff/488e4445
Branch: refs/heads/master
Commit: 488e4445cf7e37c0c645b65c77c3a95c06500cfe
Parents: 2868f4a
Author: Kevin Risden <kr...@apache.org>
Authored: Thu Nov 1 18:39:17 2018 -0400
Committer: Kevin Risden <kr...@apache.org>
Committed: Fri Nov 2 13:22:42 2018 -0400
----------------------------------------------------------------------
.../gateway/dispatch/DefaultDispatch.java | 6 -
.../hadoop/gateway/dispatch/NiFiDispatch.java | 8 -
.../hadoop/gateway/dispatch/NiFiHaDispatch.java | 8 -
.../hdfs/dispatch/WebHdfsHaDispatch.java | 11 --
.../gateway/rm/dispatch/RMUIHaDispatch.java | 3 -
.../ambari/AmbariConfigurationMonitorTest.java | 2 +-
.../knox/gateway/i18n/messages/Message.java | 3 -
.../gateway/i18n/messages/MessageLevel.java | 3 -
.../gateway/i18n/messages/MessageLogger.java | 3 -
.../i18n/messages/MessageLoggerFactory.java | 3 -
.../knox/gateway/i18n/messages/Messages.java | 3 -
.../gateway/i18n/messages/MessagesFactory.java | 3 -
.../gateway/i18n/messages/MessagesInvoker.java | 3 -
.../knox/gateway/i18n/messages/StackTrace.java | 3 -
.../messages/loggers/jdk/JdkMessageLogger.java | 3 -
.../loggers/jdk/JdkMessageLoggerFactory.java | 3 -
.../loggers/sout/SoutMessageLogger.java | 3 -
.../loggers/sout/SoutMessageLoggerFactory.java | 3 -
.../loggers/test/TestMessageLogger.java | 3 -
.../loggers/test/TestMessageLoggerFactory.java | 3 -
.../loggers/test/TestMessageRecord.java | 3 -
.../knox/gateway/i18n/resources/Resource.java | 3 -
.../knox/gateway/i18n/resources/Resources.java | 3 -
.../i18n/resources/ResourcesFactory.java | 3 -
.../i18n/resources/ResourcesInvoker.java | 3 -
.../gateway/i18n/messages/MessagesTest.java | 3 -
.../i18n/messages/MessagesTestSubject.java | 3 -
.../gateway/i18n/resources/ResourcesTest.java | 3 -
.../ResourcesTestFormattingSubject.java | 3 -
.../resources/ResourcesTestLocaleSubject.java | 3 -
.../resources/ResourcesTestNamedSubject.java | 3 -
.../provider/impl/KafkaZookeeperURLManager.java | 2 +-
.../filter/AbstractIdentityAssertionFilter.java | 12 +-
.../filter/CommonIdentityAssertionFilter.java | 19 +-
.../filter/ConcatIdentityAssertionFilter.java | 11 +-
.../ConcatIdentityAssertionFilterTest.java | 3 -
...adoopGroupProviderDeploymentContributor.java | 12 --
.../filter/HadoopGroupProviderFilterTest.java | 20 +--
.../IdentityAsserterDeploymentContributor.java | 3 -
.../DefaultIdentityAssertionFilterTest.java | 7 -
.../rewrite/api/UrlRewriteServletFilter.java | 3 -
.../filter/rewrite/impl/UrlRewriteResponse.java | 3 -
.../rewrite/api/UrlRewriteProcessorTest.java | 4 +-
.../api/UrlRewriteServletFilterTest.java | 20 +--
.../rewrite/impl/UrlRewriteRequestTest.java | 4 +-
.../apache/knox/gateway/filter/AclParser.java | 3 -
.../jwt/filter/AbstractJWTFilter.java | 7 -
.../jwt/filter/SSOCookieFederationFilter.java | 4 +-
.../federation/AbstractJWTFilterTest.java | 51 +-----
.../gateway/pac4j/session/KnoxSessionStore.java | 6 +-
.../filter/AbstractPreAuthFederationFilter.java | 11 +-
.../preauth/filter/DefaultValidator.java | 6 -
.../filter/HeaderPreAuthFederationFilter.java | 6 -
.../gateway/preauth/filter/IPValidator.java | 9 -
.../preauth/filter/PreAuthFederationFilter.java | 6 -
.../gateway/preauth/filter/PreAuthService.java | 3 -
.../preauth/filter/PreAuthValidator.java | 9 -
.../HeaderPreAuthFederationFilterTest.java | 10 --
.../webappsec/filter/CSRFPreventionFilter.java | 8 +-
.../webappsec/filter/StrictTransportFilter.java | 20 +--
.../webappsec/filter/XFrameOptionsFilter.java | 20 +--
.../webappsec/filter/XSSProtectionFilter.java | 19 +-
.../webappsec/StrictTransportFilterTest.java | 21 ---
.../webappsec/XFrameOptionsFilterTest.java | 15 --
.../webappsec/XSSProtectionFilterTest.java | 12 --
.../org/apache/knox/gateway/GatewayFactory.java | 3 -
.../org/apache/knox/gateway/GatewayFilter.java | 3 -
.../apache/knox/gateway/GatewayMessages.java | 46 -----
.../apache/knox/gateway/GatewayResources.java | 3 -
.../org/apache/knox/gateway/GatewayServer.java | 25 +--
.../gateway/config/impl/GatewayConfigImpl.java | 172 +++----------------
.../gateway/dispatch/UrlConnectionDispatch.java | 3 -
.../filter/BasicAuthChallengeFilter.java | 3 -
.../knox/gateway/filter/JaasLoginFilter.java | 3 -
.../gateway/services/CLIGatewayServices.java | 13 +-
.../services/DefaultGatewayServices.java | 11 +-
.../services/DefaultServerInfoService.java | 15 --
.../hostmap/impl/DefaultHostMapperService.java | 22 ---
.../services/metrics/impl/instr/InstrUtils.java | 4 +-
.../security/impl/DefaultAliasService.java | 15 --
.../security/impl/DefaultKeystoreService.java | 8 -
.../security/impl/RemoteAliasService.java | 30 ----
.../impl/DefaultTokenAuthorityService.java | 13 +-
.../simple/SimpleDescriptorFactory.java | 2 +-
.../org/apache/knox/gateway/util/KnoxCLI.java | 93 +---------
.../websockets/GatewayWebsocketHandler.java | 25 ---
.../websockets/MessageEventCallback.java | 8 -
.../apache/knox/gateway/GatewayFilterTest.java | 3 -
.../gateway/GatewayPortMappingConfigTest.java | 4 +-
.../knox/gateway/jetty/JettyPathMapTest.java | 3 -
.../knox/gateway/mock/MockConsoleFactory.java | 3 -
.../knox/gateway/websockets/BadBackendTest.java | 4 +-
.../knox/gateway/websockets/BadUrlTest.java | 26 +--
.../websockets/ConnectionDroppedTest.java | 7 +-
.../gateway/websockets/MessageFailureTest.java | 9 -
.../websockets/ProxyInboundClientTest.java | 99 -----------
.../gateway/websockets/WebsocketClient.java | 5 -
.../gateway/websockets/WebsocketEchoTest.java | 27 +--
.../WebsocketMultipleConnectionTest.java | 18 --
.../gateway/service/admin/VersionResource.java | 3 -
.../AdminServiceDeploymentContributor.java | 16 --
.../HealthServiceDeploymentContributor.java | 12 --
.../KnoxSSOServiceDeploymentContributor.java | 12 --
.../KnoxSSOutServiceDeploymentContributor.java | 12 --
.../service/knoxsso/WebSSOutResourceTest.java | 3 -
.../TokenServiceDeploymentContributor.java | 12 --
.../remote/RemoteConfigurationMessages.java | 3 -
.../gateway/rm/dispatch/RMUIHaDispatch.java | 3 -
.../ServiceTestDeploymentContributor.java | 19 --
.../service/vault/CredentialResource.java | 7 -
.../VaultServiceDeploymentContributor.java | 15 --
.../gateway/hdfs/dispatch/HdfsUIHaDispatch.java | 3 -
.../hdfs/dispatch/WebHdfsHaDispatch.java | 3 -
.../AbstractJavaConsoleCredentialCollector.java | 3 -
.../knox/gateway/shell/AbstractRequest.java | 6 +-
.../shell/ClearInputCredentialCollector.java | 8 +-
.../shell/HiddenInputCredentialCollector.java | 8 +-
.../org/apache/knox/gateway/shell/KnoxSh.java | 17 +-
.../shell/KnoxTokenCredentialCollector.java | 6 -
.../apache/knox/gateway/SpiGatewayMessages.java | 4 +-
.../knox/gateway/SpiGatewayResources.java | 3 -
.../knox/gateway/config/GatewayConfig.java | 47 +++--
.../knox/gateway/dispatch/DefaultDispatch.java | 6 +-
.../gateway/filter/AbstractGatewayFilter.java | 3 -
.../security/AbstractIdentityAssertionBase.java | 2 +-
.../AbstractIdentityAssertionFilter.java | 3 -
.../security/principal/PrincipalMapper.java | 3 -
.../principal/SimplePrincipalMapper.java | 22 +--
.../services/hostmap/FileBasedHostMapper.java | 6 -
.../gateway/services/hostmap/HostMapper.java | 12 --
.../services/hostmap/HostMapperService.java | 11 --
.../token/impl/JWTProviderMessages.java | 3 -
.../services/security/token/impl/JWTToken.java | 45 +----
.../apache/knox/gateway/topology/Service.java | 2 +-
.../dispatch/URLDecodingDispatchTest.java | 4 +-
.../apache/knox/gateway/GatewayTestConfig.java | 110 ------------
.../GatewayPortMappingDisableFeatureTest.java | 9 +-
.../gateway/GatewayPortMappingFailTest.java | 6 +-
.../gateway/GatewayPortMappingFuncTest.java | 18 +-
.../apache/knox/gateway/WebHdfsHaFuncTest.java | 2 +-
.../deploy/DeploymentFactoryFuncTest.java | 8 +-
.../gateway/audit/log4j/audit/Log4jAuditor.java | 2 +-
.../knox/gateway/util/CertificateUtils.java | 1 +
.../knox/gateway/util/IpAddressValidator.java | 12 +-
.../java/org/apache/knox/gateway/util/Urls.java | 5 +-
.../org/apache/knox/gateway/util/UrlsTest.java | 3 +-
.../gateway/util/urltemplate/ParserTest.java | 2 +-
147 files changed, 139 insertions(+), 1596 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/DefaultDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/DefaultDispatch.java b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/DefaultDispatch.java
index 0be40ad..540f782 100644
--- a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/DefaultDispatch.java
+++ b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/DefaultDispatch.java
@@ -87,12 +87,6 @@ public class DefaultDispatch extends org.apache.knox.gateway.dispatch.DefaultDis
super.closeInboundResponse(response, stream);
}
- /**
- * This method provides a hook for specialized credential propagation
- * in subclasses.
- *
- * @param outboundRequest
- */
@Override
protected void addCredentialsToRequest(HttpUriRequest outboundRequest) {
super.addCredentialsToRequest(outboundRequest);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiDispatch.java b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiDispatch.java
index 815da74..989278f 100644
--- a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiDispatch.java
+++ b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiDispatch.java
@@ -32,14 +32,6 @@ public class NiFiDispatch extends org.apache.knox.gateway.dispatch.NiFiDispatch
super.executeRequest(outboundRequest, inboundRequest, outboundResponse);
}
- /**
- * Overridden to provide a spot to modify the outbound response before its stream is closed.
- *
- * @param outboundRequest
- * @param inboundRequest
- * @param outboundResponse
- * @param inboundResponse
- */
@Override
protected void writeOutboundResponse(HttpUriRequest outboundRequest,
HttpServletRequest inboundRequest, HttpServletResponse outboundResponse,
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiHaDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiHaDispatch.java b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiHaDispatch.java
index 88cb841..e95b08b 100644
--- a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiHaDispatch.java
+++ b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/dispatch/NiFiHaDispatch.java
@@ -36,14 +36,6 @@ public class NiFiHaDispatch extends org.apache.knox.gateway.dispatch.NiFiHaDispa
super.executeRequest(outboundRequest, inboundRequest, outboundResponse);
}
- /**
- * Overridden to provide a spot to modify the outbound response before its stream is closed.
- *
- * @param outboundRequest
- * @param inboundRequest
- * @param outboundResponse
- * @param inboundResponse
- */
@Override
protected void writeOutboundResponse(HttpUriRequest outboundRequest,
HttpServletRequest inboundRequest, HttpServletResponse outboundResponse,
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-adapter/src/main/java/org/apache/hadoop/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/hdfs/dispatch/WebHdfsHaDispatch.java b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
index bcc0db9..753ace3 100644
--- a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
+++ b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/hdfs/dispatch/WebHdfsHaDispatch.java
@@ -28,9 +28,6 @@ import java.io.IOException;
@Deprecated
public class WebHdfsHaDispatch extends org.apache.knox.gateway.hdfs.dispatch.WebHdfsHaDispatch {
- /**
- * @throws ServletException
- */
public WebHdfsHaDispatch() throws ServletException {
super();
}
@@ -57,14 +54,6 @@ public class WebHdfsHaDispatch extends org.apache.knox.gateway.hdfs.dispatch.Web
super.executeRequest(outboundRequest, inboundRequest, outboundResponse);
}
- /**
- * Checks for specific outbound response codes/content to trigger a retry or failover
- *
- * @param outboundRequest
- * @param inboundRequest
- * @param outboundResponse
- * @param inboundResponse
- */
@Override
protected void writeOutboundResponse(HttpUriRequest outboundRequest,
HttpServletRequest inboundRequest, HttpServletResponse outboundResponse,
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-adapter/src/main/java/org/apache/hadoop/gateway/rm/dispatch/RMUIHaDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/rm/dispatch/RMUIHaDispatch.java b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/rm/dispatch/RMUIHaDispatch.java
index 472fab0..d1c3085 100644
--- a/gateway-adapter/src/main/java/org/apache/hadoop/gateway/rm/dispatch/RMUIHaDispatch.java
+++ b/gateway-adapter/src/main/java/org/apache/hadoop/gateway/rm/dispatch/RMUIHaDispatch.java
@@ -22,9 +22,6 @@ import javax.servlet.ServletException;
@Deprecated
public class RMUIHaDispatch extends org.apache.knox.gateway.rm.dispatch.RMUIHaDispatch {
- /**
- * @throws ServletException
- */
public RMUIHaDispatch() throws ServletException {
super();
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-discovery-ambari/src/test/java/org/apache/knox/gateway/topology/discovery/ambari/AmbariConfigurationMonitorTest.java
----------------------------------------------------------------------
diff --git a/gateway-discovery-ambari/src/test/java/org/apache/knox/gateway/topology/discovery/ambari/AmbariConfigurationMonitorTest.java b/gateway-discovery-ambari/src/test/java/org/apache/knox/gateway/topology/discovery/ambari/AmbariConfigurationMonitorTest.java
index 324d08e..449a2a5 100644
--- a/gateway-discovery-ambari/src/test/java/org/apache/knox/gateway/topology/discovery/ambari/AmbariConfigurationMonitorTest.java
+++ b/gateway-discovery-ambari/src/test/java/org/apache/knox/gateway/topology/discovery/ambari/AmbariConfigurationMonitorTest.java
@@ -244,7 +244,7 @@ public class AmbariConfigurationMonitorTest {
* @param name The cluster name
* @param serviceConfigs A map of service configurations (keyed by service name)
*
- * @return
+ * @return a mocked AmbariCluster
*/
private AmbariCluster createTestCluster(String name,
Map<String, Map<String, AmbariCluster.ServiceConfiguration>> serviceConfigs) {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Message.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Message.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Message.java
index 2703bc0..89e4662 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Message.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Message.java
@@ -22,9 +22,6 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- *
- */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.METHOD )
public @interface Message {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLevel.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLevel.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLevel.java
index 135ce5a..f1c0b91 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLevel.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLevel.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.messages;
-/**
- *
- */
public enum MessageLevel {
FATAL, ERROR, WARN, INFO, DEBUG, TRACE
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLogger.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLogger.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLogger.java
index 8fe33e8..e6f6468 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLogger.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLogger.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.messages;
-/**
- *
- */
public interface MessageLogger {
boolean isLoggable( MessageLevel level );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLoggerFactory.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLoggerFactory.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLoggerFactory.java
index 775573e..b0ff0ae 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLoggerFactory.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessageLoggerFactory.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.messages;
-/**
- *
- */
public interface MessageLoggerFactory {
MessageLogger getLogger( String name );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Messages.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Messages.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Messages.java
index 237a7f6..6908146 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Messages.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/Messages.java
@@ -22,9 +22,6 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- *
- */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.TYPE )
public @interface Messages {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesFactory.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesFactory.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesFactory.java
index ff9e95c..751febd 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesFactory.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesFactory.java
@@ -25,9 +25,6 @@ import java.util.Map;
import java.util.ServiceLoader;
import java.util.concurrent.ConcurrentHashMap;
-/**
- *
- */
public class MessagesFactory {
private static MessageLoggerFactory loggers = getMessageLoggerFactory();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesInvoker.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesInvoker.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesInvoker.java
index 6d46cfb..edfeae3 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesInvoker.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/MessagesInvoker.java
@@ -25,9 +25,6 @@ import java.lang.reflect.Method;
import java.text.MessageFormat;
import java.util.Locale;
-/**
- *
- */
public class MessagesInvoker extends ResourcesInvoker implements InvocationHandler {
private String codes;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/StackTrace.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/StackTrace.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/StackTrace.java
index 2026c32..dd342d1 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/StackTrace.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/StackTrace.java
@@ -22,9 +22,6 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- *
- */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.PARAMETER )
public @interface StackTrace {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLogger.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLogger.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLogger.java
index 8223fac..c8d63fe 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLogger.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLogger.java
@@ -24,9 +24,6 @@ import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
-/**
- *
- */
final class JdkMessageLogger implements MessageLogger {
private final Logger logger;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLoggerFactory.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLoggerFactory.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLoggerFactory.java
index 9263474..965d28f 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLoggerFactory.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/jdk/JdkMessageLoggerFactory.java
@@ -22,9 +22,6 @@ import org.apache.knox.gateway.i18n.messages.MessageLoggerFactory;
import java.util.logging.Logger;
-/**
- *
- */
public class JdkMessageLoggerFactory implements MessageLoggerFactory {
@Override
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLogger.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLogger.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLogger.java
index 273917c..b214ae4 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLogger.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLogger.java
@@ -23,9 +23,6 @@ import org.apache.knox.gateway.i18n.messages.MessageLogger;
import java.text.MessageFormat;
import java.util.Locale;
-/**
- *
- */
public class SoutMessageLogger implements MessageLogger {
private static final String FORMAT_WITHOUT_ID = "{0}: {2}";
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLoggerFactory.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLoggerFactory.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLoggerFactory.java
index 04a7d84..74ab6f6 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLoggerFactory.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/sout/SoutMessageLoggerFactory.java
@@ -23,9 +23,6 @@ import org.apache.knox.gateway.i18n.messages.MessageLoggerFactory;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
-/**
- *
- */
public class SoutMessageLoggerFactory implements MessageLoggerFactory {
private static SoutMessageLoggerFactory INSTANCE;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLogger.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLogger.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLogger.java
index 67a2966..1c31444 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLogger.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLogger.java
@@ -24,9 +24,6 @@ import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
-/**
- *
- */
public class TestMessageLogger implements MessageLogger {
public final List<TestMessageRecord> records = Collections.synchronizedList( new ArrayList<TestMessageRecord>() );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLoggerFactory.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLoggerFactory.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLoggerFactory.java
index e398365..6f23de6 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLoggerFactory.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageLoggerFactory.java
@@ -23,9 +23,6 @@ import org.apache.knox.gateway.i18n.messages.MessageLoggerFactory;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
-/**
- *
- */
public class TestMessageLoggerFactory implements MessageLoggerFactory {
private static TestMessageLoggerFactory INSTANCE;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageRecord.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageRecord.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageRecord.java
index 2779775..786cfff 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageRecord.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/messages/loggers/test/TestMessageRecord.java
@@ -19,9 +19,6 @@ package org.apache.knox.gateway.i18n.messages.loggers.test;
import org.apache.knox.gateway.i18n.messages.MessageLevel;
-/**
- *
- */
public class TestMessageRecord {
private final TestMessageLogger logger;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resource.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resource.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resource.java
index 251ea8a..021f81b 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resource.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resource.java
@@ -22,9 +22,6 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- *
- */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.METHOD )
public @interface Resource {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resources.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resources.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resources.java
index 6df03be..cba4a9d 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resources.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/Resources.java
@@ -22,9 +22,6 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/**
- *
- */
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.TYPE )
public @interface Resources {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesFactory.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesFactory.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesFactory.java
index de835a5..44f1a5a 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesFactory.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesFactory.java
@@ -21,9 +21,6 @@ import java.lang.reflect.Proxy;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
-/**
- *
- */
public class ResourcesFactory {
private static Map<Class<?>, Object> proxies = new ConcurrentHashMap<>();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesInvoker.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesInvoker.java b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesInvoker.java
index d041cbb..d1a3926 100644
--- a/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesInvoker.java
+++ b/gateway-i18n/src/main/java/org/apache/knox/gateway/i18n/resources/ResourcesInvoker.java
@@ -26,9 +26,6 @@ import java.util.MissingResourceException;
import java.util.ResourceBundle;
import java.util.concurrent.ConcurrentHashMap;
-/**
- *
- */
public class ResourcesInvoker implements InvocationHandler {
private static ResourceBundle MISSING_BUNDLE = new ListResourceBundle() {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTest.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTest.java b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTest.java
index 7b94c67..873a666 100644
--- a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTest.java
+++ b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTest.java
@@ -29,9 +29,6 @@ import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;
-/**
- *
- */
@Category( { UnitTests.class, FastTests.class } )
public class MessagesTest {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTestSubject.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTestSubject.java b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTestSubject.java
index a2b746c..8bb985f 100644
--- a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTestSubject.java
+++ b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/messages/MessagesTestSubject.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.messages;
-/**
- *
- */
@Messages( bundle="some.bundle.name", logger="some.logger.name", codes="ID:{0}" )
public interface MessagesTestSubject {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTest.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTest.java b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTest.java
index 66b33fc..7696266 100644
--- a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTest.java
+++ b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTest.java
@@ -29,9 +29,6 @@ import java.util.Locale;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.junit.Assert.assertThat;
-/**
- *
- */
@Category( { UnitTests.class, FastTests.class } )
public class ResourcesTest {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestFormattingSubject.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestFormattingSubject.java b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestFormattingSubject.java
index 30f9db6..655d847 100644
--- a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestFormattingSubject.java
+++ b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestFormattingSubject.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.resources;
-/**
- *
- */
@Resources( bundle="some.bundle.name" )
public interface ResourcesTestFormattingSubject {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestLocaleSubject.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestLocaleSubject.java b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestLocaleSubject.java
index 45fc01d..60ed856 100644
--- a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestLocaleSubject.java
+++ b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestLocaleSubject.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.resources;
-/**
- *
- */
@Resources
public interface ResourcesTestLocaleSubject {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestNamedSubject.java
----------------------------------------------------------------------
diff --git a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestNamedSubject.java b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestNamedSubject.java
index 6ce8db4..c6062c3 100644
--- a/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestNamedSubject.java
+++ b/gateway-i18n/src/test/java/org/apache/knox/gateway/i18n/resources/ResourcesTestNamedSubject.java
@@ -17,9 +17,6 @@
*/
package org.apache.knox.gateway.i18n.resources;
-/**
- *
- */
@Resources( bundle="org.apache.knox.gateway.i18n.resources.NamedBundle" )
public interface ResourcesTestNamedSubject {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-ha/src/main/java/org/apache/knox/gateway/ha/provider/impl/KafkaZookeeperURLManager.java
----------------------------------------------------------------------
diff --git a/gateway-provider-ha/src/main/java/org/apache/knox/gateway/ha/provider/impl/KafkaZookeeperURLManager.java b/gateway-provider-ha/src/main/java/org/apache/knox/gateway/ha/provider/impl/KafkaZookeeperURLManager.java
index f14c385..3472d78 100644
--- a/gateway-provider-ha/src/main/java/org/apache/knox/gateway/ha/provider/impl/KafkaZookeeperURLManager.java
+++ b/gateway-provider-ha/src/main/java/org/apache/knox/gateway/ha/provider/impl/KafkaZookeeperURLManager.java
@@ -125,7 +125,7 @@ public class KafkaZookeeperURLManager extends BaseZookeeperURLManager {
* @param serverInfo Server Info in JSON Format from Zookeeper (required)
*
* @return URL to Kafka
- * @throws ParseException
+ * @throws ParseException failure parsing json from string
*/
private String constructURL(String serverInfo) throws ParseException {
String scheme = "http";
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/AbstractIdentityAssertionFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/AbstractIdentityAssertionFilter.java b/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/AbstractIdentityAssertionFilter.java
index b2c1c07..18ce1be 100644
--- a/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/AbstractIdentityAssertionFilter.java
+++ b/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/AbstractIdentityAssertionFilter.java
@@ -50,9 +50,6 @@ import org.apache.knox.gateway.security.GroupPrincipal;
import org.apache.knox.gateway.security.ImpersonatedPrincipal;
import org.apache.knox.gateway.security.PrimaryPrincipal;
-/**
- *
- */
public abstract class AbstractIdentityAssertionFilter extends
AbstractIdentityAssertionBase implements Filter {
@@ -86,18 +83,11 @@ public abstract class AbstractIdentityAssertionFilter extends
* This method is used to map the username of the authenticated identity to some other
* principal name based on an implementation specific mechanism. It will either return
* a new principal name or the provided principal name if there is no mapping required.
- * @param principalName
+ * @param principalName principal to try to map
* @return new username or the provided principalName
*/
public abstract String mapUserPrincipal(String principalName);
- /**
- * @param request
- * @param response
- * @param chain
- * @param mappedPrincipalName
- * @param groups
- */
protected void continueChainAsPrincipal(HttpServletRequestWrapper request, ServletResponse response,
FilterChain chain, String mappedPrincipalName, String[] groups) throws IOException,
ServletException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/CommonIdentityAssertionFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/CommonIdentityAssertionFilter.java b/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/CommonIdentityAssertionFilter.java
index a143f27..2076e0a 100644
--- a/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/CommonIdentityAssertionFilter.java
+++ b/gateway-provider-identity-assertion-common/src/main/java/org/apache/knox/gateway/identityasserter/common/filter/CommonIdentityAssertionFilter.java
@@ -41,10 +41,7 @@ public class CommonIdentityAssertionFilter extends AbstractIdentityAssertionFilt
private static final String GROUP_PRINCIPAL_MAPPING = "group.principal.mapping";
private static final String PRINCIPAL_MAPPING = "principal.mapping";
private SimplePrincipalMapper mapper = new SimplePrincipalMapper();
-
- /* (non-Javadoc)
- * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
- */
+
@Override
public void init(FilterConfig filterConfig) throws ServletException {
String principalMapping = filterConfig.getInitParameter(PRINCIPAL_MAPPING);
@@ -64,9 +61,6 @@ public class CommonIdentityAssertionFilter extends AbstractIdentityAssertionFilt
}
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#destroy()
- */
@Override
public void destroy() {
}
@@ -99,11 +93,6 @@ public class CommonIdentityAssertionFilter extends AbstractIdentityAssertionFilt
continueChainAsPrincipal(wrapper, response, chain, mappedPrincipalName, groups);
}
- /**
- * @param mappedGroups
- * @param groups
- * @return
- */
private String[] combineGroupMappings(String[] mappedGroups, String[] groups) {
if (mappedGroups != null && groups != null) {
return (String[])ArrayUtils.addAll(mappedGroups, groups);
@@ -132,18 +121,12 @@ public class CommonIdentityAssertionFilter extends AbstractIdentityAssertionFilt
return mapper.mapUserPrincipal(principalName);
}
- /* (non-Javadoc)
- * @see AbstractIdentityAssertionFilter#mapGroupPrincipals(java.lang.String, javax.security.auth.Subject)
- */
@Override
public String[] mapGroupPrincipals(String mappedPrincipalName, Subject subject) {
// NOP
return null;
}
- /* (non-Javadoc)
- * @see AbstractIdentityAssertionFilter#mapUserPrincipal(java.lang.String)
- */
@Override
public String mapUserPrincipal(String principalName) {
// NOP
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-concat/src/main/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-concat/src/main/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilter.java b/gateway-provider-identity-assertion-concat/src/main/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilter.java
index c1ea3a3..7d72c97 100644
--- a/gateway-provider-identity-assertion-concat/src/main/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilter.java
+++ b/gateway-provider-identity-assertion-concat/src/main/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilter.java
@@ -25,10 +25,7 @@ import org.apache.knox.gateway.identityasserter.common.filter.CommonIdentityAsse
public class ConcatIdentityAssertionFilter extends CommonIdentityAssertionFilter {
private String prefix = null;
private String suffix = null;
-
- /* (non-Javadoc)
- * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
- */
+
@Override
public void init(FilterConfig filterConfig) throws ServletException {
super.init(filterConfig);
@@ -43,17 +40,11 @@ public class ConcatIdentityAssertionFilter extends CommonIdentityAssertionFilter
}
}
- /* (non-Javadoc)
- * @see AbstractIdentityAssertionFilter#mapGroupPrincipals(java.lang.String, javax.security.auth.Subject)
- */
@Override
public String[] mapGroupPrincipals(String mappedPrincipalName, Subject subject) {
return null;
}
- /* (non-Javadoc)
- * @see AbstractIdentityAssertionFilter#mapUserPrincipal(java.lang.String)
- */
@Override
public String mapUserPrincipal(String principalName) {
return prefix + principalName + suffix;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-concat/src/test/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-concat/src/test/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilterTest.java b/gateway-provider-identity-assertion-concat/src/test/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilterTest.java
index e465da8..e960c0a 100644
--- a/gateway-provider-identity-assertion-concat/src/test/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilterTest.java
+++ b/gateway-provider-identity-assertion-concat/src/test/java/org/apache/knox/gateway/identityasserter/concat/filter/ConcatIdentityAssertionFilterTest.java
@@ -31,9 +31,6 @@ import org.apache.knox.gateway.security.PrimaryPrincipal;
import org.easymock.EasyMock;
import org.junit.Test;
-/**
- *
- */
public class ConcatIdentityAssertionFilterTest {
@Test
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-hadoop-groups/src/main/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-hadoop-groups/src/main/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderDeploymentContributor.java b/gateway-provider-identity-assertion-hadoop-groups/src/main/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderDeploymentContributor.java
index 3bfa809..f41f793 100644
--- a/gateway-provider-identity-assertion-hadoop-groups/src/main/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderDeploymentContributor.java
+++ b/gateway-provider-identity-assertion-hadoop-groups/src/main/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderDeploymentContributor.java
@@ -51,23 +51,11 @@ public class HadoopGroupProviderDeploymentContributor
super();
}
- /*
- * (non-Javadoc)
- *
- * @see
- * ProviderDeploymentContributor#getName()
- */
@Override
public String getName() {
return HADOOP_GROUP_PROVIDER;
}
- /*
- * (non-Javadoc)
- *
- * @see org.apache.knox.gateway.identityasserter.common.filter.
- * AbstractIdentityAsserterDeploymentContributor#getFilterClassname()
- */
@Override
protected String getFilterClassname() {
return HadoopGroupProviderFilter.class.getName();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-hadoop-groups/src/test/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-hadoop-groups/src/test/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderFilterTest.java b/gateway-provider-identity-assertion-hadoop-groups/src/test/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderFilterTest.java
index 953f371..ee59411 100644
--- a/gateway-provider-identity-assertion-hadoop-groups/src/test/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderFilterTest.java
+++ b/gateway-provider-identity-assertion-hadoop-groups/src/test/java/org/apache/knox/gateway/identityasserter/hadoop/groups/filter/HadoopGroupProviderFilterTest.java
@@ -31,8 +31,6 @@ import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import org.apache.knox.gateway.security.PrimaryPrincipal;
-import org.apache.hadoop.security.LdapGroupsMapping;
-import org.apache.hadoop.security.ShellBasedUnixGroupsMapping;
import org.easymock.EasyMock;
import org.junit.Test;
@@ -54,22 +52,14 @@ public class HadoopGroupProviderFilterTest {
private static final String username = System.getProperty("user.name");
/**
- * Configuration object needed by for hadoop classes
- */
-
- /**
* Hadoop Groups implementation.
*/
-
- /* create an instance */
public HadoopGroupProviderFilterTest() {
super();
}
- /**
+ /*
* Test that valid groups are retrieved for a legitimate user.
- *
- * @throws ServletException
*/
@Test
public void testGroups() throws ServletException {
@@ -100,10 +90,8 @@ public class HadoopGroupProviderFilterTest {
}
- /**
+ /*
* Test that no groups are retrieved for a dummy user.
- *
- * @throws ServletException
*/
@Test
public void testUnknownUser() throws ServletException {
@@ -134,13 +122,11 @@ public class HadoopGroupProviderFilterTest {
}
- /**
+ /*
* Test for a bad config (nonexistent). This test proves, we are not falling
* back on {@link ShellBasedUnixGroupsMapping} because we explicitly use
* {@link LdapGroupsMapping} and in case of bad config we get empty groups
* (Hadoop way).
- *
- * @throws ServletException
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@Test
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-pseudo/src/main/java/org/apache/knox/gateway/identityasserter/filter/IdentityAsserterDeploymentContributor.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-pseudo/src/main/java/org/apache/knox/gateway/identityasserter/filter/IdentityAsserterDeploymentContributor.java b/gateway-provider-identity-assertion-pseudo/src/main/java/org/apache/knox/gateway/identityasserter/filter/IdentityAsserterDeploymentContributor.java
index e23bccf..f6356df 100644
--- a/gateway-provider-identity-assertion-pseudo/src/main/java/org/apache/knox/gateway/identityasserter/filter/IdentityAsserterDeploymentContributor.java
+++ b/gateway-provider-identity-assertion-pseudo/src/main/java/org/apache/knox/gateway/identityasserter/filter/IdentityAsserterDeploymentContributor.java
@@ -42,9 +42,6 @@ public class IdentityAsserterDeploymentContributor extends AbstractIdentityAsser
context.getWebAppDescriptor().createContextParam().paramName(GROUP_PRINCIPAL_MAPPING_PARAM_NAME).paramValue(groupMappings);
}
- /* (non-Javadoc)
- * @see AbstractIdentityAsserterDeploymentContributor#getFilterClassname()
- */
@Override
protected String getFilterClassname() {
return FILTER_CLASSNAME;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-identity-assertion-pseudo/src/test/java/org/apache/knox/gateway/identityasserter/filter/DefaultIdentityAssertionFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-identity-assertion-pseudo/src/test/java/org/apache/knox/gateway/identityasserter/filter/DefaultIdentityAssertionFilterTest.java b/gateway-provider-identity-assertion-pseudo/src/test/java/org/apache/knox/gateway/identityasserter/filter/DefaultIdentityAssertionFilterTest.java
index ea2aa70..b66dbb1 100644
--- a/gateway-provider-identity-assertion-pseudo/src/test/java/org/apache/knox/gateway/identityasserter/filter/DefaultIdentityAssertionFilterTest.java
+++ b/gateway-provider-identity-assertion-pseudo/src/test/java/org/apache/knox/gateway/identityasserter/filter/DefaultIdentityAssertionFilterTest.java
@@ -33,9 +33,6 @@ import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
-/**
- *
- */
public class DefaultIdentityAssertionFilterTest {
@Test
@@ -94,10 +91,6 @@ public class DefaultIdentityAssertionFilterTest {
assertTrue("group1 not found in groups: " + Arrays.toString(mappedGroups), groupFoundIn("group1", mappedGroups));
}
- /**
- * @param string
- * @return
- */
private boolean groupFoundIn(String expected, String[] mappedGroups) {
if (mappedGroups == null) return false;
for(int i = 0; i < mappedGroups.length; i++) {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilter.java b/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilter.java
index 1a3fa98..eea17a5 100644
--- a/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilter.java
+++ b/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilter.java
@@ -30,9 +30,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
-/**
- *
- */
public class UrlRewriteServletFilter extends AbstractGatewayFilter {
public static final String REQUEST_URL_RULE_PARAM = "request.url";
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteResponse.java
----------------------------------------------------------------------
diff --git a/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteResponse.java b/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteResponse.java
index 93e9f07..7712986 100644
--- a/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteResponse.java
+++ b/gateway-provider-rewrite/src/main/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteResponse.java
@@ -59,9 +59,6 @@ import java.util.zip.GZIPOutputStream;
import static org.apache.knox.gateway.filter.rewrite.impl.UrlRewriteUtil.getRewriteFilterConfig;
import static org.apache.knox.gateway.filter.rewrite.impl.UrlRewriteUtil.pickFirstRuleWithEqualsIgnoreCasePathMatch;
-/**
- *
- */
public class UrlRewriteResponse extends GatewayResponseWrapper implements Params,
ResponseStreamer {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteProcessorTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteProcessorTest.java b/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteProcessorTest.java
index 7ffbfeb..b7f56fa 100644
--- a/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteProcessorTest.java
+++ b/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteProcessorTest.java
@@ -302,10 +302,8 @@ public class UrlRewriteProcessorTest {
processor.destroy();
}
- /**
+ /*
* Tests the rewrite pattern used for re-writing Solr urls passed through Knox.
- *
- * @throws Exception
*/
@Test
public void testSolrRewrite() throws Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilterTest.java b/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilterTest.java
index ddf14b6..f857dcf 100644
--- a/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilterTest.java
+++ b/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/api/UrlRewriteServletFilterTest.java
@@ -25,7 +25,6 @@ import org.apache.knox.test.log.NoOpAppender;
import org.apache.knox.test.mock.MockInteraction;
import org.apache.knox.test.mock.MockServlet;
import org.apache.log4j.Appender;
-import org.apache.log4j.Logger;
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.http.HttpTester;
import org.eclipse.jetty.servlet.FilterHolder;
@@ -61,8 +60,6 @@ import static org.xmlmatchers.transform.XmlConverters.the;
public class UrlRewriteServletFilterTest {
- Logger LOG = Logger.getLogger(UrlRewriteServletFilterTest.class);
-
private ServletTester server;
private HttpTester.Request request;
private HttpTester.Response response;
@@ -71,8 +68,7 @@ public class UrlRewriteServletFilterTest {
private static URL getTestResource( String name ) {
name = UrlRewriteServletFilterTest.class.getName().replaceAll( "\\.", "/" ) + "/" + name;
- URL url = ClassLoader.getSystemResource( name );
- return url;
+ return ClassLoader.getSystemResource( name );
}
public void setUp( Map<String,String> initParams ) throws Exception {
@@ -805,7 +801,7 @@ public class UrlRewriteServletFilterTest {
assertThat(content, anyOf( is(responseHtmlOne), is(responseHtmlTwo)));
}
- /**
+ /*
* Test the prefix function
* @see KNOX-994
* @since 0.14.0
@@ -843,7 +839,7 @@ public class UrlRewriteServletFilterTest {
}
- /**
+ /*
* Test the postfix function
* @since 1.1.0
* KNOX-1305
@@ -883,7 +879,7 @@ public class UrlRewriteServletFilterTest {
assertThat(content, is(expectedLocationHeader));
}
- /**
+ /*
* Test the infix function
* @since 1.1.0
* KNOX-1305
@@ -922,13 +918,9 @@ public class UrlRewriteServletFilterTest {
assertThat(content, is(expectedCustomHeader));
}
-
-
-
- /**
+
+ /*
* See KNOX-791
- * @since 0.11.0
- * @throws Exception
*/
@Test
public void testResponseHtmlAttributeEscaping() throws Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteRequestTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteRequestTest.java b/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteRequestTest.java
index c37f887..2b408e2 100644
--- a/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteRequestTest.java
+++ b/gateway-provider-rewrite/src/test/java/org/apache/knox/gateway/filter/rewrite/impl/UrlRewriteRequestTest.java
@@ -100,11 +100,9 @@ public class UrlRewriteRequestTest {
assertEquals(hostHeader, "targethost.com");
}
- /**
+ /*
* Test the case where a request has
* Content-Type:text/xml and Content-Encoding:gzip
- * @since 1.1.0
- * @throws Exception
*/
@Test
public void testContentEncoding() throws Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-authz-acls/src/main/java/org/apache/knox/gateway/filter/AclParser.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-authz-acls/src/main/java/org/apache/knox/gateway/filter/AclParser.java b/gateway-provider-security-authz-acls/src/main/java/org/apache/knox/gateway/filter/AclParser.java
index a988ff5..d82f88d 100644
--- a/gateway-provider-security-authz-acls/src/main/java/org/apache/knox/gateway/filter/AclParser.java
+++ b/gateway-provider-security-authz-acls/src/main/java/org/apache/knox/gateway/filter/AclParser.java
@@ -23,9 +23,6 @@ import java.util.Collections;
import org.apache.knox.gateway.i18n.messages.MessagesFactory;
import org.apache.knox.gateway.util.IpAddressValidator;
-/**
- *
- */
public class AclParser {
private static AclsAuthorizationMessages log = MessagesFactory.get( AclsAuthorizationMessages.class );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/AbstractJWTFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/AbstractJWTFilter.java b/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/AbstractJWTFilter.java
index db93d73..e28a0f3 100644
--- a/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/AbstractJWTFilter.java
+++ b/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/AbstractJWTFilter.java
@@ -60,9 +60,6 @@ import org.apache.knox.gateway.services.security.token.impl.JWT;
import com.nimbusds.jose.JWSHeader;
-/**
- *
- */
public abstract class AbstractJWTFilter implements Filter {
/**
* If specified, this configuration property refers to a value which the issuer of a received
@@ -123,10 +120,6 @@ public abstract class AbstractJWTFilter implements Filter {
}
}
- /**
- * @param expectedAudiences
- * @return
- */
protected List<String> parseExpectedAudiences(String expectedAudiences) {
List<String> audList = null;
// setup the list of valid audiences for token validation
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/SSOCookieFederationFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/SSOCookieFederationFilter.java b/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/SSOCookieFederationFilter.java
index 68104a1..7ab5bf3 100644
--- a/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/SSOCookieFederationFilter.java
+++ b/gateway-provider-security-jwt/src/main/java/org/apache/knox/gateway/provider/federation/jwt/filter/SSOCookieFederationFilter.java
@@ -192,8 +192,8 @@ private String gatewayPath;
/**
* Derive a provider URL from the request assuming that the
* KnoxSSO endpoint is local to the endpoint serving this request.
- * @param request
- * @return
+ * @param request origin request
+ * @return url that is based on KnoxSSO endpoint
*/
public String deriveDefaultAuthenticationProviderUrl(HttpServletRequest request) {
String scheme = null;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-jwt/src/test/java/org/apache/knox/gateway/provider/federation/AbstractJWTFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-jwt/src/test/java/org/apache/knox/gateway/provider/federation/AbstractJWTFilterTest.java b/gateway-provider-security-jwt/src/test/java/org/apache/knox/gateway/provider/federation/AbstractJWTFilterTest.java
index 1ef2c1b..7e98ee6 100644
--- a/gateway-provider-security-jwt/src/test/java/org/apache/knox/gateway/provider/federation/AbstractJWTFilterTest.java
+++ b/gateway-provider-security-jwt/src/test/java/org/apache/knox/gateway/provider/federation/AbstractJWTFilterTest.java
@@ -89,8 +89,7 @@ public abstract class AbstractJWTFilterTest {
MessageFormat headerFormatter = new MessageFormat(dnTemplate, Locale.ROOT);
String[] paramArray = new String[1];
paramArray[0] = hostname;
- String dn = headerFormatter.format(paramArray);
- return dn;
+ return headerFormatter.format(paramArray);
}
@BeforeClass
@@ -202,7 +201,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be true.", !chain.doFilterCalled);
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -264,7 +263,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be true.", !chain.doFilterCalled);
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -338,8 +337,6 @@ public abstract class AbstractJWTFilterTest {
try {
Properties props = getProperties();
-// System.out.println("+" + pem + "+");
-
props.put(getAudienceProperty(), "bar");
props.put("sso.authentication.provider.url", "https://localhost:8443/gateway/knoxsso/api/v1/websso");
props.put(getVerificationPemProperty(), pem);
@@ -393,7 +390,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be false.", !chain.doFilterCalled);
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -452,7 +449,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be true.", !chain.doFilterCalled);
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -487,7 +484,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be true.", !chain.doFilterCalled);
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -556,7 +553,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be true.", !chain.doFilterCalled);
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -648,7 +645,7 @@ public abstract class AbstractJWTFilterTest {
TestFilterChain chain = new TestFilterChain();
handler.doFilter(request, response, chain);
Assert.assertTrue("doFilterCalled should not be false.", !chain.doFilterCalled );
- Assert.assertTrue("No Subject should be returned.", chain.subject == null);
+ Assert.assertNull("No Subject should be returned.", chain.subject);
} catch (ServletException se) {
fail("Should NOT have thrown a ServletException.");
}
@@ -743,9 +740,6 @@ public abstract class AbstractJWTFilterTest {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getServletContext()
- */
@Override
public ServletContext getServletContext() {
// JWTokenAuthority authority = EasyMock.createNiceMock(JWTokenAuthority.class);
@@ -756,17 +750,11 @@ public abstract class AbstractJWTFilterTest {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameter(java.lang.String)
- */
@Override
public String getInitParameter(String name) {
return props.getProperty(name, null);
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameterNames()
- */
@Override
public Enumeration<String> getInitParameterNames() {
return null;
@@ -782,43 +770,28 @@ public abstract class AbstractJWTFilterTest {
this.verifyingKey = verifyingKey;
}
- /* (non-Javadoc)
- * @see JWTokenAuthority#issueToken(javax.security.auth.Subject, java.lang.String)
- */
@Override
public JWT issueToken(Subject subject, String algorithm) throws TokenServiceException {
return null;
}
- /* (non-Javadoc)
- * @see JWTokenAuthority#issueToken(java.security.Principal, java.lang.String)
- */
@Override
public JWT issueToken(Principal p, String algorithm) throws TokenServiceException {
return null;
}
- /* (non-Javadoc)
- * @see JWTokenAuthority#issueToken(java.security.Principal, java.lang.String, java.lang.String)
- */
@Override
public JWT issueToken(Principal p, String audience, String algorithm)
throws TokenServiceException {
return null;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.token.JWTokenAuthority#verifyToken(org.apache.knox.gateway.services.security.token.impl.JWT)
- */
@Override
public boolean verifyToken(JWT token) throws TokenServiceException {
JWSVerifier verifier = new RSASSAVerifier((RSAPublicKey) verifyingKey);
return token.verify(verifier);
}
- /* (non-Javadoc)
- * @see JWTokenAuthority#issueToken(java.security.Principal, java.lang.String, java.lang.String, long)
- */
@Override
public JWT issueToken(Principal p, String audience, String algorithm,
long expires) throws TokenServiceException {
@@ -831,9 +804,6 @@ public abstract class AbstractJWTFilterTest {
return null;
}
- /* (non-Javadoc)
- * @see JWTokenAuthority#issueToken(java.security.Principal, java.lang.String, long)
- */
@Override
public JWT issueToken(Principal p, String algorithm, long expires) throws TokenServiceException {
return null;
@@ -844,16 +814,12 @@ public abstract class AbstractJWTFilterTest {
JWSVerifier verifier = new RSASSAVerifier(publicKey);
return token.verify(verifier);
}
-
}
protected static class TestFilterChain implements FilterChain {
boolean doFilterCalled = false;
Subject subject = null;
- /* (non-Javadoc)
- * @see javax.servlet.FilterChain#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
- */
@Override
public void doFilter(ServletRequest request, ServletResponse response)
throws IOException, ServletException {
@@ -861,6 +827,5 @@ public abstract class AbstractJWTFilterTest {
subject = Subject.getSubject( AccessController.getContext() );
}
-
}
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-pac4j/src/main/java/org/apache/knox/gateway/pac4j/session/KnoxSessionStore.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-pac4j/src/main/java/org/apache/knox/gateway/pac4j/session/KnoxSessionStore.java b/gateway-provider-security-pac4j/src/main/java/org/apache/knox/gateway/pac4j/session/KnoxSessionStore.java
index fc02277..3ffbee6 100644
--- a/gateway-provider-security-pac4j/src/main/java/org/apache/knox/gateway/pac4j/session/KnoxSessionStore.java
+++ b/gateway-provider-security-pac4j/src/main/java/org/apache/knox/gateway/pac4j/session/KnoxSessionStore.java
@@ -145,7 +145,7 @@ public class KnoxSessionStore implements SessionStore {
/**
* A function used to compress the data using GZIP
- * @param data
+ * @param data data to be compressed
* @return gziped data
* @since 1.1.0
*/
@@ -163,9 +163,9 @@ public class KnoxSessionStore implements SessionStore {
/**
* Decompress the data compressed using gzip
*
- * @param data
+ * @param data data to be decompressed
* @return uncompressed data
- * @throws IOException
+ * @throws IOException exception if can't decompress
* @since 1.1.0
*/
private static byte[] unCompress(final byte[] data) throws IOException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/AbstractPreAuthFederationFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/AbstractPreAuthFederationFilter.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/AbstractPreAuthFederationFilter.java
index caacbd4..e4f7685 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/AbstractPreAuthFederationFilter.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/AbstractPreAuthFederationFilter.java
@@ -44,9 +44,6 @@ import org.apache.knox.gateway.audit.log4j.audit.AuditConstants;
import org.apache.knox.gateway.filter.AbstractGatewayFilter;
import org.apache.knox.gateway.security.PrimaryPrincipal;
-/**
- *
- */
public abstract class AbstractPreAuthFederationFilter implements Filter {
private List<PreAuthValidator> validators = null;
@@ -129,14 +126,8 @@ public abstract class AbstractPreAuthFederationFilter implements Filter {
}
}
}
-
- /**
- * @param httpRequest
- */
+
abstract protected String getPrimaryPrincipal(HttpServletRequest httpRequest);
- /**
- * @param principals
- */
abstract protected void addGroupPrincipals(HttpServletRequest request, Set<Principal> principals);
}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/DefaultValidator.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/DefaultValidator.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/DefaultValidator.java
index f85070c..6566503 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/DefaultValidator.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/DefaultValidator.java
@@ -33,12 +33,6 @@ public class DefaultValidator implements PreAuthValidator {
public DefaultValidator() {
}
- /**
- * @param httpRequest
- * @param filterConfig
- * @return true if validated, otherwise false
- * @throws PreAuthValidationException
- */
@Override
public boolean validate(HttpServletRequest httpRequest, FilterConfig filterConfig) throws PreAuthValidationException {
return true;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/HeaderPreAuthFederationFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/HeaderPreAuthFederationFilter.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/HeaderPreAuthFederationFilter.java
index 2106dae..2d92192 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/HeaderPreAuthFederationFilter.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/HeaderPreAuthFederationFilter.java
@@ -45,17 +45,11 @@ public class HeaderPreAuthFederationFilter extends AbstractPreAuthFederationFilt
}
}
- /**
- * @param httpRequest
- */
@Override
protected String getPrimaryPrincipal(HttpServletRequest httpRequest) {
return httpRequest.getHeader(headerName);
}
- /**
- * @param principals
- */
@Override
protected void addGroupPrincipals(HttpServletRequest request, Set<Principal> principals) {
if (groupHeaderName != null) {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/IPValidator.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/IPValidator.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/IPValidator.java
index 0e763c1..5086189 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/IPValidator.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/IPValidator.java
@@ -22,9 +22,6 @@ import javax.servlet.http.HttpServletRequest;
import org.apache.knox.gateway.util.IpAddressValidator;
-/**
- *
- */
public class IPValidator implements PreAuthValidator {
public static final String IP_ADDRESSES_PARAM = "preauth.ip.addresses";
public static final String IP_VALIDATION_METHOD_VALUE = "preauth.ip.validation";
@@ -32,12 +29,6 @@ public class IPValidator implements PreAuthValidator {
public IPValidator() {
}
- /**
- * @param httpRequest
- * @param filterConfig
- * @return true if validated, otherwise false
- * @throws PreAuthValidationException
- */
@Override
public boolean validate(HttpServletRequest httpRequest, FilterConfig filterConfig)
throws PreAuthValidationException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthFederationFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthFederationFilter.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthFederationFilter.java
index 841d11a..eefbc26 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthFederationFilter.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthFederationFilter.java
@@ -69,9 +69,6 @@ public class PreAuthFederationFilter implements Filter {
}
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#destroy()
- */
@Override
public void destroy() {
@@ -81,9 +78,6 @@ public class PreAuthFederationFilter implements Filter {
* Recreate the current Subject based upon the provided mappedPrincipal
* and look for the groups that should be associated with the new Subject.
* Upon finding groups mapped to the principal - add them to the new Subject.
- * @param principal
- * @throws ServletException
- * @throws IOException
*/
protected void continueChainAsPrincipal(final ServletRequest request, final ServletResponse response,
final FilterChain chain, String principal) throws IOException, ServletException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthService.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthService.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthService.java
index fab1624..59100b5 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthService.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthService.java
@@ -43,7 +43,6 @@ public class PreAuthService {
initializeValidators();
}
-
private static void initializeValidators() {
ServiceLoader<PreAuthValidator> servLoader = ServiceLoader.load(PreAuthValidator.class);
validatorMap = new ConcurrentHashMap<>();
@@ -61,9 +60,7 @@ public class PreAuthService {
* This method returns appropriate pre-auth Validator as defined in config
*
* @since 0.12
- * @param filterConfig
* @return a list of PreAuthValidator instances as defined in config
- * @throws ServletException
*/
public static List<PreAuthValidator> getValidators(FilterConfig filterConfig) throws ServletException {
String validationMethods = filterConfig.getInitParameter(VALIDATION_METHOD_PARAM);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthValidator.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthValidator.java b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthValidator.java
index ca40ff7..6900d12 100644
--- a/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthValidator.java
+++ b/gateway-provider-security-preauth/src/main/java/org/apache/knox/gateway/preauth/filter/PreAuthValidator.java
@@ -20,16 +20,7 @@ package org.apache.knox.gateway.preauth.filter;
import javax.servlet.FilterConfig;
import javax.servlet.http.HttpServletRequest;
-/**
- *
- */
public interface PreAuthValidator {
- /**
- * @param httpRequest
- * @param filterConfig
- * @return true if validated, otherwise false
- * @throws PreAuthValidationException
- */
public abstract boolean validate(HttpServletRequest httpRequest, FilterConfig filterConfig) throws
PreAuthValidationException;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-preauth/src/test/java/org/apache/knox/gateway/provider/federation/HeaderPreAuthFederationFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-preauth/src/test/java/org/apache/knox/gateway/provider/federation/HeaderPreAuthFederationFilterTest.java b/gateway-provider-security-preauth/src/test/java/org/apache/knox/gateway/provider/federation/HeaderPreAuthFederationFilterTest.java
index 1751509..86516fe 100644
--- a/gateway-provider-security-preauth/src/test/java/org/apache/knox/gateway/provider/federation/HeaderPreAuthFederationFilterTest.java
+++ b/gateway-provider-security-preauth/src/test/java/org/apache/knox/gateway/provider/federation/HeaderPreAuthFederationFilterTest.java
@@ -130,22 +130,12 @@ public class HeaderPreAuthFederationFilterTest extends org.junit.Assert {
}
- /**
- * @param httpRequest
- * @param filterConfig
- * @return true if validated, otherwise false
- */
@Override
public boolean validate(HttpServletRequest httpRequest, FilterConfig filterConfig) {
String token = httpRequest.getHeader("CUSTOM_TOKEN");
return token.equalsIgnoreCase("HelloWorld");
}
- /**
- * Return unique validator name
- *
- * @return name of validator
- */
@Override
public String getName() {
return NAME;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/CSRFPreventionFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/CSRFPreventionFilter.java b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/CSRFPreventionFilter.java
index c03798f..befa540 100644
--- a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/CSRFPreventionFilter.java
+++ b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/CSRFPreventionFilter.java
@@ -18,6 +18,7 @@
package org.apache.knox.gateway.webappsec.filter;
import java.io.IOException;
+import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
@@ -49,9 +50,7 @@ public class CSRFPreventionFilter implements Filter {
}
String[] methods = mti.split(",");
methodsToIgnore = new HashSet<>();
- for (int i = 0; i < methods.length; i++) {
- methodsToIgnore.add(methods[i]);
- }
+ methodsToIgnore.addAll(Arrays.asList(methods));
}
@Override
@@ -65,9 +64,6 @@ public class CSRFPreventionFilter implements Filter {
}
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#destroy()
- */
@Override
public void destroy() {
[2/3] knox git commit: WIP
Posted by kr...@apache.org.
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/StrictTransportFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/StrictTransportFilter.java b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/StrictTransportFilter.java
index 3fcbd3a..f88dc8c 100644
--- a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/StrictTransportFilter.java
+++ b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/StrictTransportFilter.java
@@ -41,16 +41,10 @@ public class StrictTransportFilter implements Filter {
private String option = "max-age=31536000";
- /* (non-Javadoc)
- * @see javax.servlet.Filter#destroy()
- */
@Override
public void destroy() {
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)
- */
@Override
public void doFilter(ServletRequest req, ServletResponse res,
FilterChain chain) throws IOException, ServletException {
@@ -58,9 +52,6 @@ public class StrictTransportFilter implements Filter {
chain.doFilter(req, new StrictTransportResponseWrapper((HttpServletResponse) res));
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
- */
@Override
public void init(FilterConfig config) throws ServletException {
String customOption = config.getInitParameter(CUSTOM_HEADER_PARAM);
@@ -87,11 +78,6 @@ public class StrictTransportFilter implements Filter {
}
}
- /**
- * construct a wrapper for this response
- *
- * @param response
- */
public StrictTransportResponseWrapper(HttpServletResponse response) {
super(response);
}
@@ -107,10 +93,7 @@ public class StrictTransportFilter implements Filter {
}
return headerValue;
}
-
- /**
- * get the Header names
- */
+
@Override
public Collection<String> getHeaderNames() {
List<String> names = (List<String>) super.getHeaderNames();
@@ -133,5 +116,4 @@ public class StrictTransportFilter implements Filter {
return values;
}
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XFrameOptionsFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XFrameOptionsFilter.java b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XFrameOptionsFilter.java
index 981cb37..44b0e9f 100644
--- a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XFrameOptionsFilter.java
+++ b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XFrameOptionsFilter.java
@@ -41,16 +41,10 @@ public class XFrameOptionsFilter implements Filter {
private String option = "DENY";
- /* (non-Javadoc)
- * @see javax.servlet.Filter#destroy()
- */
@Override
public void destroy() {
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)
- */
@Override
public void doFilter(ServletRequest req, ServletResponse res,
FilterChain chain) throws IOException, ServletException {
@@ -58,9 +52,6 @@ public class XFrameOptionsFilter implements Filter {
chain.doFilter(req, new XFrameOptionsResponseWrapper((HttpServletResponse) res));
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
- */
@Override
public void init(FilterConfig config) throws ServletException {
String customOption = config.getInitParameter(CUSTOM_HEADER_PARAM);
@@ -86,12 +77,7 @@ public class XFrameOptionsFilter implements Filter {
super.setHeader(name, value);
}
}
-
- /**
- * construct a wrapper for this response
- *
- * @param response
- */
+
public XFrameOptionsResponseWrapper(HttpServletResponse response) {
super(response);
}
@@ -108,9 +94,6 @@ public class XFrameOptionsFilter implements Filter {
return headerValue;
}
- /**
- * get the Header names
- */
@Override
public Collection<String> getHeaderNames() {
List<String> names = (List<String>) super.getHeaderNames();
@@ -133,5 +116,4 @@ public class XFrameOptionsFilter implements Filter {
return values;
}
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XSSProtectionFilter.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XSSProtectionFilter.java b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XSSProtectionFilter.java
index 02a6c7a..4045fab 100644
--- a/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XSSProtectionFilter.java
+++ b/gateway-provider-security-webappsec/src/main/java/org/apache/knox/gateway/webappsec/filter/XSSProtectionFilter.java
@@ -36,13 +36,8 @@ public class XSSProtectionFilter implements Filter {
public static final String DEFAULT_VALUE = "1;mode=block";
-
private String option = DEFAULT_VALUE;
-
- /* (non-Javadoc)
- * @see javax.servlet.Filter#init(javax.servlet.FilterConfig)
- */
@Override
public void init(FilterConfig config) throws ServletException {
String customOption = config.getInitParameter(CUSTOM_HEADER_PARAM);
@@ -51,18 +46,12 @@ public class XSSProtectionFilter implements Filter {
}
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse, javax.servlet.FilterChain)
- */
@Override
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
((HttpServletResponse) res).setHeader(X_XSS_PROTECTION, option);
chain.doFilter(req, new XSSProtectionResponseWrapper((HttpServletResponse) res));
}
- /* (non-Javadoc)
- * @see javax.servlet.Filter#destroy()
- */
@Override
public void destroy() {
}
@@ -103,14 +92,11 @@ public class XSSProtectionFilter implements Filter {
return headerValue;
}
- /**
- * get the Header names
- */
@Override
public Collection<String> getHeaderNames() {
List<String> names = (List<String>) super.getHeaderNames();
if (names == null) {
- names = new ArrayList();
+ names = new ArrayList<>();
}
names.add(X_XSS_PROTECTION);
return names;
@@ -121,12 +107,11 @@ public class XSSProtectionFilter implements Filter {
List<String> values = (List<String>) super.getHeaders(name);
if (name.equals(X_XSS_PROTECTION)) {
if (values == null) {
- values = new ArrayList();
+ values = new ArrayList<>();
}
values.add(option);
}
return values;
}
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/StrictTransportFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/StrictTransportFilterTest.java b/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/StrictTransportFilterTest.java
index 00c342b..1217405 100644
--- a/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/StrictTransportFilterTest.java
+++ b/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/StrictTransportFilterTest.java
@@ -37,13 +37,7 @@ import org.easymock.EasyMock;
import org.junit.Assert;
import org.junit.Test;
-/**
- *
- */
public class StrictTransportFilterTest {
- /**
- *
- */
private static final String STRICT_TRANSPORT = "Strict-Transport-Security";
String options = null;
Collection<String> headerNames = null;
@@ -118,38 +112,25 @@ public class StrictTransportFilterTest {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getServletContext()
- */
@Override
public ServletContext getServletContext() {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameter(java.lang.String)
- */
@Override
public String getInitParameter(String name) {
return props.getProperty(name, null);
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameterNames()
- */
@Override
public Enumeration<String> getInitParameterNames() {
return null;
}
-
}
class TestFilterChain implements FilterChain {
boolean doFilterCalled = false;
- /* (non-Javadoc)
- * @see javax.servlet.FilterChain#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
- */
@Override
public void doFilter(ServletRequest request, ServletResponse response)
throws IOException, ServletException {
@@ -158,7 +139,5 @@ public class StrictTransportFilterTest {
headerNames = ((HttpServletResponse)response).getHeaderNames();
headers = ((HttpServletResponse)response).getHeaders(STRICT_TRANSPORT);
}
-
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XFrameOptionsFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XFrameOptionsFilterTest.java b/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XFrameOptionsFilterTest.java
index f3d16e1..252e1ca 100644
--- a/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XFrameOptionsFilterTest.java
+++ b/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XFrameOptionsFilterTest.java
@@ -37,9 +37,6 @@ import org.easymock.EasyMock;
import org.junit.Assert;
import org.junit.Test;
-/**
- *
- */
public class XFrameOptionsFilterTest {
/**
*
@@ -147,25 +144,16 @@ public class XFrameOptionsFilterTest {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getServletContext()
- */
@Override
public ServletContext getServletContext() {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameter(java.lang.String)
- */
@Override
public String getInitParameter(String name) {
return props.getProperty(name, null);
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameterNames()
- */
@Override
public Enumeration<String> getInitParameterNames() {
return null;
@@ -176,9 +164,6 @@ public class XFrameOptionsFilterTest {
class TestFilterChain implements FilterChain {
boolean doFilterCalled = false;
- /* (non-Javadoc)
- * @see javax.servlet.FilterChain#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
- */
@Override
public void doFilter(ServletRequest request, ServletResponse response)
throws IOException, ServletException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XSSProtectionFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XSSProtectionFilterTest.java b/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XSSProtectionFilterTest.java
index 84f030b..f11bd95 100644
--- a/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XSSProtectionFilterTest.java
+++ b/gateway-provider-security-webappsec/src/test/java/org/apache/knox/gateway/webappsec/XSSProtectionFilterTest.java
@@ -104,25 +104,16 @@ public class XSSProtectionFilterTest {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getServletContext()
- */
@Override
public ServletContext getServletContext() {
return null;
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameter(java.lang.String)
- */
@Override
public String getInitParameter(String name) {
return props.getProperty(name, null);
}
- /* (non-Javadoc)
- * @see javax.servlet.FilterConfig#getInitParameterNames()
- */
@Override
public Enumeration<String> getInitParameterNames() {
return null;
@@ -133,9 +124,6 @@ public class XSSProtectionFilterTest {
class TestFilterChain implements FilterChain {
boolean doFilterCalled = false;
- /* (non-Javadoc)
- * @see javax.servlet.FilterChain#doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse)
- */
@Override
public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {
doFilterCalled = true;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFactory.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFactory.java b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFactory.java
index 7e97620..c6d5cb1 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFactory.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFactory.java
@@ -29,9 +29,6 @@ import java.util.HashMap;
import java.util.List;
import java.util.Map;
-/**
- *
- */
public class GatewayFactory {
// public static GatewayFilter create( Config gatewayConfig ) throws URISyntaxException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFilter.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFilter.java b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFilter.java
index 6fc9a9e..c6eb5a8 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFilter.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayFilter.java
@@ -58,9 +58,6 @@ import java.util.Map;
import java.util.Set;
import java.util.UUID;
-/**
- *
- */
public class GatewayFilter implements Filter {
private static final FilterChain EMPTY_CHAIN = new FilterChain() {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
index 0c480a9..001799d 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayMessages.java
@@ -30,9 +30,6 @@ import java.util.Date;
import java.util.Map;
import java.util.Set;
-/**
- *
- */
@Messages(logger="org.apache.knox.gateway")
public interface GatewayMessages {
@@ -439,83 +436,40 @@ public interface GatewayMessages {
@Message( level = MessageLevel.INFO, text = "Cookie scoping feature enabled: {0}" )
void cookieScopingFeatureEnabled( boolean enabled );
- /**
- * Log whether Topology port mapping feature is enabled/disabled.
- *
- * @param enabled
- */
@Message(level = MessageLevel.INFO,
text = "Topology port mapping feature enabled: {0}")
void gatewayTopologyPortMappingEnabled(final boolean enabled);
- /**
- * @param topology
- * @param port
- */
@Message(level = MessageLevel.DEBUG,
text = "Creating a connector for topology {0} listening on port {1}.")
void createJettyConnector(final String topology, final int port);
- /**
- * @param topology
- */
@Message(level = MessageLevel.DEBUG,
text = "Creating a handler for topology {0}.")
void createJettyHandler(final String topology);
- /**
- * @param oldTarget
- * @param newTarget
- */
@Message(level = MessageLevel.INFO,
text = "Updating request context from {0} to {1}")
void topologyPortMappingAddContext(final String oldTarget,
final String newTarget);
- /**
- * @param oldTarget
- * @param newTarget
- */
@Message(level = MessageLevel.DEBUG,
text = "Updating request target from {0} to {1}")
void topologyPortMappingUpdateRequest(final String oldTarget,
final String newTarget);
- /**
- * Messages for Topology Port Mapping
- *
- * @param port
- * @param topology
- */
@Message(level = MessageLevel.ERROR,
text = "Port {0} configured for Topology - {1} is already in use.")
void portAlreadyInUse(final int port, final String topology);
- /**
- * Messages for Topology Port Mapping
- *
- * @param port
- */
@Message(level = MessageLevel.ERROR,
text = "Port {0} is already in use.")
void portAlreadyInUse(final int port);
- /**
- * Log topology and port
- *
- * @param topology
- * @param port
- */
@Message(level = MessageLevel.INFO,
text = "Started gateway, topology \"{0}\" listening on port \"{1}\".")
void startedGateway(final String topology, final int port);
- /**
- * Log topology and port
- *
- * @param topology
- * @param port
- */
@Message(level = MessageLevel.ERROR,
text = "Topology \"{0}\" failed to start listening on port \"{1}\".")
void startedGatewayPortConflict(final String topology, final int port);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/GatewayResources.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayResources.java b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayResources.java
index 5f74d09..0d8d0c7 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayResources.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayResources.java
@@ -20,9 +20,6 @@ package org.apache.knox.gateway;
import org.apache.knox.gateway.i18n.resources.Resource;
import org.apache.knox.gateway.i18n.resources.Resources;
-/**
- *
- */
@Resources
public interface GatewayResources {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
index ddcba82..9f9bc1e 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/GatewayServer.java
@@ -350,11 +350,6 @@ public class GatewayServer {
* @param port If value is > 0 then the given value is used else we
* use the port provided in GatewayConfig.
* @param topologyName Connector name, only used when not null
- * @return
- * @throws IOException
- * @throws CertificateException
- * @throws NoSuchAlgorithmException
- * @throws KeyStoreException
*/
private Connector createConnector(final Server server,
final GatewayConfig config, final int port, final String topologyName)
@@ -472,10 +467,10 @@ public class GatewayServer {
* Sanity Check to make sure configured ports are free and there is not port
* conflict.
*
- * @param port
- * @param topologyName
- * @param config
- * @throws IOException
+ * @param port port to check
+ * @param topologyName topology name to log
+ * @param config config to use for topology name validation
+ * @throws IOException if there is a port conflict
*/
public void checkPortConflict(final int port,
final String topologyName, final GatewayConfig config)
@@ -625,7 +620,7 @@ public class GatewayServer {
/**
* Check whether a port is free
*
- * @param port
+ * @param port port to check
* @return true if port in use else false
*/
public static boolean isPortInUse(final int port) {
@@ -647,24 +642,16 @@ public class GatewayServer {
/**
* Checks whether the topologies defined in gateway-xml as part of Topology
* Port mapping feature exists. If it does not Log a message and move on.
- *
- * @param configTopologies
- * @param topologies
- * @return
*/
private void checkMappedTopologiesExist(
final Map<String, Integer> configTopologies,
- final List<String> topologies) throws IOException {
-
+ final List<String> topologies) {
for(final Map.Entry<String, Integer> entry : configTopologies.entrySet()) {
-
// If the topologies defined in gateway-config.xml are not found in gateway
if (!topologies.contains(entry.getKey())) {
log.topologyPortMappingCannotFindTopology(entry.getKey(), entry.getValue());
}
-
}
-
}
public URI getURI() {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/config/impl/GatewayConfigImpl.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/config/impl/GatewayConfigImpl.java b/gateway-server/src/main/java/org/apache/knox/gateway/config/impl/GatewayConfigImpl.java
index cb3cb06..9c538cd 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/config/impl/GatewayConfigImpl.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/config/impl/GatewayConfigImpl.java
@@ -94,20 +94,6 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
GATEWAY_CONFIG_DIR_PREFIX + "/" + GATEWAY_CONFIG_FILE_PREFIX + "-site.xml"
};
-// private static final String[] HADOOP_CONF_FILENAMES = {
-// "core-default.xml",
-// "core-site.xml"
-//// "hdfs-default.xml",
-//// "hdfs-site.xml",
-//// "mapred-default.xml",
-//// "mapred-site.xml"
-// };
-
-// private static final String[] HADOOP_PREFIX_VARS = {
-// "HADOOP_PREFIX",
-// "HADOOP_HOME"
-// };
-
public static final String HTTP_HOST = GATEWAY_CONFIG_FILE_PREFIX + ".host";
public static final String HTTP_PORT = GATEWAY_CONFIG_FILE_PREFIX + ".port";
public static final String HTTP_PATH = GATEWAY_CONFIG_FILE_PREFIX + ".path";
@@ -197,8 +183,8 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
/* Websocket defaults */
public static final boolean DEFAULT_WEBSOCKET_FEATURE_ENABLED = false;
- public static final int DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE = Integer.MAX_VALUE;;
- public static final int DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE = Integer.MAX_VALUE;;
+ public static final int DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE = Integer.MAX_VALUE;
+ public static final int DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE = Integer.MAX_VALUE;
public static final int DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE = 32768;
public static final int DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE = 32768;
public static final int DEFAULT_WEBSOCKET_INPUT_BUFFER_SIZE = 4096;
@@ -244,7 +230,6 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
private static List<String> DEFAULT_GLOBAL_RULES_SERVICES;
-
public GatewayConfigImpl() {
init();
}
@@ -264,12 +249,7 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
}
private String getGatewayHomeDir() {
- String home = get(
- GATEWAY_HOME_VAR,
- System.getProperty(
- GATEWAY_HOME_VAR,
- System.getenv( GATEWAY_HOME_VAR ) ) );
- return home;
+ return get(GATEWAY_HOME_VAR, System.getProperty(GATEWAY_HOME_VAR, System.getenv(GATEWAY_HOME_VAR)));
}
private void setGatewayHomeDir( String dir ) {
@@ -425,8 +405,7 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
@Override
public String getGatewayHost() {
- String host = get( HTTP_HOST, "0.0.0.0" );
- return host;
+ return get( HTTP_HOST, "0.0.0.0" );
}
@Override
@@ -468,8 +447,7 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
public InetSocketAddress getGatewayAddress() throws UnknownHostException {
String host = getGatewayHost();
int port = getGatewayPort();
- InetSocketAddress address = new InetSocketAddress( host, port );
- return address;
+ return new InetSocketAddress( host, port );
}
@Override
@@ -501,18 +479,12 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
return get( KRB5_LOGIN_CONFIG );
}
- /* (non-Javadoc)
- * @see GatewayConfig#getDefaultTopologyName()
- */
@Override
public String getDefaultTopologyName() {
String name = get(GATEWAY_DEFAULT_TOPOLOGY_NAME_PARAM);
return name != null ? name : GATEWAY_DEFAULT_TOPOLOGY_NAME;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getDefaultAppRedirectPath()
- */
@Override
public String getDefaultAppRedirectPath() {
String defTopo = getDefaultTopologyName();
@@ -523,18 +495,11 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
}
}
- /* (non-Javadoc)
- * @see GatewayConfig#getFrontendUrl()
- */
@Override
public String getFrontendUrl() {
- String url = get( FRONTEND_URL, null );
- return url;
+ return get( FRONTEND_URL, null );
}
- /* (non-Javadoc)
- * @see GatewayConfig#getExcludedSSLProtocols()
- */
@Override
public List<String> getExcludedSSLProtocols() {
List<String> protocols = null;
@@ -565,52 +530,34 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
return list;
}
- /* (non-Javadoc)
- * @see GatewayConfig#isClientAuthNeeded()
- */
@Override
public boolean isClientAuthNeeded() {
String clientAuthNeeded = get( CLIENT_AUTH_NEEDED, "false" );
return "true".equals(clientAuthNeeded);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.config.GatewayConfig#isClientAuthWanted()
- */
@Override
public boolean isClientAuthWanted() {
String clientAuthWanted = get( CLIENT_AUTH_WANTED, "false" );
return "true".equals(clientAuthWanted);
}
- /* (non-Javadoc)
- * @see GatewayConfig#getTruststorePath()
- */
@Override
public String getTruststorePath() {
return get( TRUSTSTORE_PATH, null);
}
- /* (non-Javadoc)
- * @see GatewayConfig#getTrustAllCerts()
- */
@Override
public boolean getTrustAllCerts() {
String trustAllCerts = get( TRUST_ALL_CERTS, "false" );
return "true".equals(trustAllCerts);
}
-
- /* (non-Javadoc)
- * @see GatewayConfig#getTruststorePath()
- */
+
@Override
public String getTruststoreType() {
return get( TRUSTSTORE_TYPE, "JKS");
}
- /* (non-Javadoc)
- * @see GatewayConfig#getTruststorePath()
- */
@Override
public String getKeystoreType() {
return get( KEYSTORE_TYPE, "JKS");
@@ -622,17 +569,11 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
return "true".equals(xForwardedEnabled);
}
- /* (non-Javadoc)
- * @see GatewayConfig#getEphemeralDHKeySize()
- */
@Override
public String getEphemeralDHKeySize() {
return get( EPHEMERAL_DH_KEY_SIZE, "2048");
}
- /* (non-Javadoc)
- * @see GatewayConfig#getHttpClientMaxConnections()
- */
@Override
public int getHttpClientMaxConnections() {
return getInt( HTTP_CLIENT_MAX_CONNECTION, 32 );
@@ -666,9 +607,6 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
return t;
}
- /* (non-Javadoc)
- * @see GatewayConfig#getThreadPoolMax()
- */
@Override
public int getThreadPoolMax() {
int i = getInt( THREAD_POOL_MAX, 254 );
@@ -681,26 +619,22 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
@Override
public int getHttpServerRequestBuffer() {
- int i = getInt( HTTP_SERVER_REQUEST_BUFFER, 16 * 1024 );
- return i;
+ return getInt( HTTP_SERVER_REQUEST_BUFFER, 16 * 1024 );
}
@Override
public int getHttpServerRequestHeaderBuffer() {
- int i = getInt( HTTP_SERVER_REQUEST_HEADER_BUFFER, 8 * 1024 );
- return i;
+ return getInt( HTTP_SERVER_REQUEST_HEADER_BUFFER, 8 * 1024 );
}
@Override
public int getHttpServerResponseBuffer() {
- int i = getInt( HTTP_SERVER_RESPONSE_BUFFER, 32 * 1024 );
- return i;
+ return getInt( HTTP_SERVER_RESPONSE_BUFFER, 32 * 1024 );
}
@Override
public int getHttpServerResponseHeaderBuffer() {
- int i = getInt( HTTP_SERVER_RESPONSE_HEADER_BUFFER, 8 * 1024 );
- return i;
+ return getInt( HTTP_SERVER_RESPONSE_HEADER_BUFFER, 8 * 1024 );
}
@Override
@@ -773,92 +707,60 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
@Override
public String getGraphiteHost() {
- String host = get( GRAPHITE_METRICS_REPORTING_HOST, "localhost" );
- return host;
+ return get( GRAPHITE_METRICS_REPORTING_HOST, "localhost" );
}
@Override
public int getGraphitePort() {
- int i = getInt( GRAPHITE_METRICS_REPORTING_PORT, 32772 );
- return i;
+ return getInt( GRAPHITE_METRICS_REPORTING_PORT, 32772 );
}
@Override
public int getGraphiteReportingFrequency() {
- int i = getInt( GRAPHITE_METRICS_REPORTING_FREQUENCY, 1 );
- return i;
+ return getInt( GRAPHITE_METRICS_REPORTING_FREQUENCY, 1 );
}
- /* (non-Javadoc)
- * @see GatewayConfig#isWebsocketEnabled()
- */
@Override
public boolean isWebsocketEnabled() {
final String result = get( WEBSOCKET_FEATURE_ENABLED, Boolean.toString(DEFAULT_WEBSOCKET_FEATURE_ENABLED));
return Boolean.parseBoolean(result);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketMaxTextMessageSize()
- */
@Override
public int getWebsocketMaxTextMessageSize() {
return getInt( WEBSOCKET_MAX_TEXT_MESSAGE_SIZE, DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_SIZE);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketMaxBinaryMessageSize()
- */
@Override
public int getWebsocketMaxBinaryMessageSize() {
return getInt( WEBSOCKET_MAX_BINARY_MESSAGE_SIZE, DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_SIZE);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketMaxTextMessageBufferSize()
- */
@Override
public int getWebsocketMaxTextMessageBufferSize() {
return getInt( WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE, DEFAULT_WEBSOCKET_MAX_TEXT_MESSAGE_BUFFER_SIZE);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketMaxBinaryMessageBufferSize()
- */
@Override
public int getWebsocketMaxBinaryMessageBufferSize() {
return getInt( WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE, DEFAULT_WEBSOCKET_MAX_BINARY_MESSAGE_BUFFER_SIZE);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketInputBufferSize()
- */
@Override
public int getWebsocketInputBufferSize() {
return getInt( WEBSOCKET_INPUT_BUFFER_SIZE, DEFAULT_WEBSOCKET_INPUT_BUFFER_SIZE);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketAsyncWriteTimeout()
- */
@Override
public int getWebsocketAsyncWriteTimeout() {
return getInt( WEBSOCKET_ASYNC_WRITE_TIMEOUT, DEFAULT_WEBSOCKET_ASYNC_WRITE_TIMEOUT);
}
- /* (non-Javadoc)
- * @see GatewayConfig#websocketIdleTimeout()
- */
@Override
public int getWebsocketIdleTimeout() {
return getInt( WEBSOCKET_IDLE_TIMEOUT, DEFAULT_WEBSOCKET_IDLE_TIMEOUT);
}
- /**
- * Map of Topology names and their ports.
- *
- * @return
- */
@Override
public Map<String, Integer> getGatewayPortMappings() {
@@ -872,17 +774,11 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
// extract the topology name and use it as a key
result.put(StringUtils.substringAfter(e.getKey(), GATEWAY_PORT_MAPPING_PREFIX), Integer.parseInt(e.getValue()) );
}
-
}
return Collections.unmodifiableMap(result);
}
- /**
- * Is the Port Mapping feature on ?
- *
- * @return
- */
@Override
public boolean isGatewayPortMappingEnabled() {
final String result = get( GATEWAY_PORT_MAPPING_ENABLED, Boolean.toString(DEFAULT_GATEWAY_PORT_MAPPING_ENABLED));
@@ -900,15 +796,13 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
@Override
public boolean isCookieScopingToPathEnabled() {
- final boolean result = Boolean.parseBoolean(get(COOKIE_SCOPING_ENABLED,
- Boolean.toString(DEFAULT_COOKIE_SCOPING_FEATURE_ENABLED)));
- return result;
+ return Boolean.parseBoolean(get(COOKIE_SCOPING_ENABLED,
+ Boolean.toString(DEFAULT_COOKIE_SCOPING_FEATURE_ENABLED)));
}
@Override
public String getHeaderNameForRemoteAddress() {
- String value = getVar(REMOTE_IP_HEADER_NAME, "X-Forwarded-For");
- return value;
+ return getVar(REMOTE_IP_HEADER_NAME, "X-Forwarded-For");
}
@Override
@@ -999,14 +893,6 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
return Boolean.parseBoolean(get(REMOTE_CONFIG_MONITOR_CLIENT_ALLOW_READ_ACCESS, String.valueOf(false)));
}
- /**
- * Returns whether the Remote Alias Service is enabled or not.
- * This value also depends on whether remote registry is enabled or not.
- * if it is enabled then this option takes effect else this option has no
- * effect.
- *
- * @return
- */
@Override
public boolean isRemoteAliasServiceEnabled() {
final String result = get( REMOTE_ALIAS_SERVICE_ENABLED, Boolean.toString(DEFAULT_REMOTE_ALIAS_SERVICE_ENABLED));
@@ -1027,23 +913,14 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
@Override
public String getKnoxAdminGroups() {
- final String result = get(KNOX_ADMIN_GROUPS, null);
- return result;
+ return get(KNOX_ADMIN_GROUPS, null);
}
@Override
public String getKnoxAdminUsers() {
- final String result = get(KNOX_ADMIN_USERS, null);
- return result;
+ return get(KNOX_ADMIN_USERS, null);
}
- /**
- * Custom header name to be used to pass the authenticated principal via
- * dispatch
- *
- * @return
- * @since 1.1.0
- */
@Override
public String getFederationHeaderName() {
return get(CUSTOM_FEDERATION_HEADER_NAME, DEFAULT_FEDERATION_HEADER_NAME);
@@ -1072,7 +949,7 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
String serviceList = get(DISPATCH_HOST_WHITELIST_SERVICES);
if (serviceList != null) {
- for (String service : Arrays.asList(serviceList.split(","))) {
+ for (String service : serviceList.split(",")) {
result.add(service.trim());
}
}
@@ -1080,18 +957,9 @@ public class GatewayConfigImpl extends Configuration implements GatewayConfig {
return result;
}
- /**
- * Returns true when strict topology validation is enabled, in which case if
- * topology validation fails Knox will throw a runtime exception. If false and
- * topology validation fails Knox will log an ERROR and move on.
- *
- * @return
- * @since 1.1.0
- */
@Override
public boolean isTopologyValidationEnabled() {
final String result = get(STRICT_TOPOLOGY_VALIDATION, Boolean.toString(DEFAULT_STRICT_TOPOLOGY_VALIDATION));
return Boolean.parseBoolean(result);
}
-
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/dispatch/UrlConnectionDispatch.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/dispatch/UrlConnectionDispatch.java b/gateway-server/src/main/java/org/apache/knox/gateway/dispatch/UrlConnectionDispatch.java
index 6e8ea83..3aa8f4a 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/dispatch/UrlConnectionDispatch.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/dispatch/UrlConnectionDispatch.java
@@ -54,9 +54,6 @@ import java.nio.charset.StandardCharsets;
import java.util.Enumeration;
import java.util.Locale;
-/**
- *
- */
public class UrlConnectionDispatch extends AbstractGatewayFilter {
private static final GatewayMessages LOG = MessagesFactory.get( GatewayMessages.class );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/filter/BasicAuthChallengeFilter.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/filter/BasicAuthChallengeFilter.java b/gateway-server/src/main/java/org/apache/knox/gateway/filter/BasicAuthChallengeFilter.java
index 5cedc72..07d5280 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/filter/BasicAuthChallengeFilter.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/filter/BasicAuthChallengeFilter.java
@@ -28,9 +28,6 @@ import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
-/**
- *
- */
//TODO: Remove the Authenticate header from the expect so that downstream filters and dispatch don't see it.
public class BasicAuthChallengeFilter extends AbstractGatewayFilter {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/filter/JaasLoginFilter.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/filter/JaasLoginFilter.java b/gateway-server/src/main/java/org/apache/knox/gateway/filter/JaasLoginFilter.java
index 71ce479..e895470 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/filter/JaasLoginFilter.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/filter/JaasLoginFilter.java
@@ -23,9 +23,6 @@ import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
-/**
- *
- */
public class JaasLoginFilter extends AbstractGatewayFilter {
public static final String JGSS_LOGIN_MOUDLE = "com.sun.security.jgss.login";
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/CLIGatewayServices.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/CLIGatewayServices.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/CLIGatewayServices.java
index e75d379..af20c6a 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/CLIGatewayServices.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/CLIGatewayServices.java
@@ -95,9 +95,6 @@ public class CLIGatewayServices implements GatewayServices {
DefaultTopologyService tops = new DefaultTopologyService();
tops.init( config, options );
services.put(TOPOLOGY_SERVICE, tops);
-
-
-
}
public void start() throws ServiceLifecycleException {
@@ -125,18 +122,12 @@ public class CLIGatewayServices implements GatewayServices {
DefaultTopologyService tops = (DefaultTopologyService)services.get(TOPOLOGY_SERVICE);
tops.stop();
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.GatewayServices#getServiceNames()
- */
+
@Override
public Collection<String> getServiceNames() {
return services.keySet();
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.GatewayServices#getService(java.lang.String)
- */
+
@Override
public <T> T getService(String serviceName) {
return (T)services.get( serviceName );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultGatewayServices.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultGatewayServices.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultGatewayServices.java
index 3e14ec2..8c0848a 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultGatewayServices.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultGatewayServices.java
@@ -197,20 +197,13 @@ public class DefaultGatewayServices implements GatewayServices {
DefaultMetricsService metricsService = (DefaultMetricsService) services.get(METRICS_SERVICE);
metricsService.stop();
-
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.GatewayServices#getServiceNames()
- */
+
@Override
public Collection<String> getServiceNames() {
return services.keySet();
}
-
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.GatewayServices#getService(java.lang.String)
- */
+
@Override
public <T> T getService(String serviceName) {
return (T)services.get(serviceName);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultServerInfoService.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultServerInfoService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultServerInfoService.java
index 790d5e9..4036c18 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultServerInfoService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/DefaultServerInfoService.java
@@ -28,39 +28,24 @@ import org.apache.knox.gateway.config.GatewayConfig;
*/
public class DefaultServerInfoService implements ServerInfoService {
- /* (non-Javadoc)
- * @see Service#init(GatewayConfig, java.util.Map)
- */
@Override
public void init(GatewayConfig config, Map<String, String> options)
throws ServiceLifecycleException {
}
- /* (non-Javadoc)
- * @see Service#start()
- */
@Override
public void start() throws ServiceLifecycleException {
}
- /* (non-Javadoc)
- * @see Service#stop()
- */
@Override
public void stop() throws ServiceLifecycleException {
}
- /* (non-Javadoc)
- * @see ServerInfoService#getBuildVersion()
- */
@Override
public String getBuildVersion() {
return GatewayServer.getBuildVersion();
}
- /* (non-Javadoc)
- * @see ServerInfoService#getBuildHash()
- */
@Override
public String getBuildHash() {
return GatewayServer.getBuildHash();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/hostmap/impl/DefaultHostMapperService.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/hostmap/impl/DefaultHostMapperService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/hostmap/impl/DefaultHostMapperService.java
index acffae2..350644c 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/hostmap/impl/DefaultHostMapperService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/hostmap/impl/DefaultHostMapperService.java
@@ -25,54 +25,32 @@ import org.apache.knox.gateway.services.hostmap.HostMapperService;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
-/**
- *
- *
- */
public class DefaultHostMapperService implements HostMapperService {
private ConcurrentHashMap<String, HostMapper> map = new ConcurrentHashMap<>();
- /* (non-Javadoc)
- * @see Service#init(GatewayConfig, java.util.Map)
- */
@Override
public void init( GatewayConfig config, Map<String, String> options ) throws ServiceLifecycleException {
}
- /* (non-Javadoc)
- * @see Service#start()
- */
@Override
public void start() throws ServiceLifecycleException {
}
- /* (non-Javadoc)
- * @see Service#stop()
- */
@Override
public void stop() throws ServiceLifecycleException {
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.hostmap.HostMappingService#getHostMapper(java.lang.String)
- */
@Override
public HostMapper getHostMapper( String clusterName ) {
return map.get( clusterName );
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.hostmap.HostMappingService#registerHostMapperForCluster(java.lang.String, HostMapper)
- */
@Override
public void registerHostMapperForCluster( String clusterName, HostMapper hostMapper ) {
map.put( clusterName, hostMapper );
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.hostmap.HostMappingService#removeHostMapperForCluster(java.lang.String)
- */
@Override
public void removeHostMapperForCluster( String clusterName ) {
map.remove( clusterName );
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/metrics/impl/instr/InstrUtils.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/metrics/impl/instr/InstrUtils.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/metrics/impl/instr/InstrUtils.java
index fa1992b..f550ca7 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/metrics/impl/instr/InstrUtils.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/metrics/impl/instr/InstrUtils.java
@@ -33,8 +33,8 @@ public class InstrUtils {
* returns the segment that is related to the resource.
* For example, if the path is "/webhdfs/v1/d1/d2/d2/d4". it returns "/webhdfs/v1"
*
- * @param fullPath
- * @return
+ * @param fullPath full path to determine the resource from
+ * @return resource path
*/
public static String getResourcePath(String fullPath) {
String resourcePath = "";
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultAliasService.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultAliasService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultAliasService.java
index 7d71a8d..9a173f4 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultAliasService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultAliasService.java
@@ -72,18 +72,12 @@ public class DefaultAliasService implements AliasService {
return passphrase;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.impl.AliasService#getAliasForCluster(java.lang.String, java.lang.String)
- */
@Override
public char[] getPasswordFromAliasForCluster(String clusterName, String alias)
throws AliasServiceException {
return getPasswordFromAliasForCluster(clusterName, alias, false);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.impl.AliasService#getAliasForCluster(java.lang.String, java.lang.String, boolean)
- */
@Override
public char[] getPasswordFromAliasForCluster(String clusterName, String alias, boolean generate)
throws AliasServiceException {
@@ -134,9 +128,6 @@ public class DefaultAliasService implements AliasService {
addAliasForCluster(clusterName, alias, passwordString);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.services.security.impl.AliasService#addAliasForCluster(java.lang.String, java.lang.String, java.lang.String)
- */
@Override
public void addAliasForCluster(String clusterName, String alias, String value) {
try {
@@ -168,9 +159,6 @@ public class DefaultAliasService implements AliasService {
generateAliasForCluster("__gateway", alias);
}
- /* (non-Javadoc)
- * @see AliasService#getCertificateForGateway(java.lang.String)
- */
@Override
public Certificate getCertificateForGateway(String alias) {
Certificate cert = null;
@@ -185,9 +173,6 @@ public class DefaultAliasService implements AliasService {
return cert;
}
- /* (non-Javadoc)
- * @see AliasService#getAliasesForCluster(java.lang.String)
- */
@Override
public List<String> getAliasesForCluster(String clusterName) {
ArrayList<String> list = new ArrayList<>();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreService.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreService.java
index f3997d9..994e3d4 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/DefaultKeystoreService.java
@@ -436,9 +436,6 @@ public class DefaultKeystoreService extends BaseKeystoreService implements
/**
* Called only from within critical sections of other methods above.
- * @param clusterName
- * @param alias
- * @return
*/
private char[] checkCache(String clusterName, String alias) {
char[] c = null;
@@ -456,9 +453,6 @@ public class DefaultKeystoreService extends BaseKeystoreService implements
/**
* Called only from within critical sections of other methods above.
- * @param clusterName
- * @param alias
- * @param credentialString
*/
private void addToCache(String clusterName, String alias, String credentialString) {
HashMap<String, String> clusterCache = (HashMap<String, String>) cache.get(clusterName);
@@ -470,8 +464,6 @@ public class DefaultKeystoreService extends BaseKeystoreService implements
/**
* Called only from within critical sections of other methods above.
- * @param clusterName
- * @param alias
*/
private void removeFromCache(String clusterName, String alias) {
HashMap<String, String> clusterCache = (HashMap<String, String>) cache.get(clusterName);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/RemoteAliasService.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/RemoteAliasService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/RemoteAliasService.java
index 7954361..447af26 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/RemoteAliasService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/security/impl/RemoteAliasService.java
@@ -111,10 +111,6 @@ public class RemoteAliasService implements AliasService {
/**
* Build an entry path for the given cluster and alias
- *
- * @param clusterName
- * @param alias
- * @return
*/
private static String buildAliasEntryName(final String clusterName,
final String alias) {
@@ -123,9 +119,6 @@ public class RemoteAliasService implements AliasService {
/**
* Build an entry path for the given cluster
- *
- * @param clusterName
- * @return
*/
private static String buildClusterEntryName(final String clusterName) {
return PATH_KNOX_ALIAS_STORE_TOPOLOGY + PATH_SEPARATOR + clusterName;
@@ -133,9 +126,6 @@ public class RemoteAliasService implements AliasService {
/**
* Ensure that the given entry path exists.
- *
- * @param path
- * @param remoteClient
*/
private static void ensureEntry(final String path,
final RemoteConfigurationRegistryClient remoteClient) {
@@ -168,8 +158,6 @@ public class RemoteAliasService implements AliasService {
/**
* Check to make sure all the required entries are properly set up
- *
- * @param remoteClient
*/
private static void checkPathsExist(
final RemoteConfigurationRegistryClient remoteClient) {
@@ -185,9 +173,6 @@ public class RemoteAliasService implements AliasService {
/**
* Returns an empty list if the given list is null,
* else returns the given list.
- *
- * @param given
- * @return
*/
private static List<String> safe(final List given) {
return given == null ? Collections.EMPTY_LIST : given;
@@ -196,8 +181,6 @@ public class RemoteAliasService implements AliasService {
/**
* Set a {@link RemoteConfigurationRegistryClientService} instance
* used to talk to remote remote service registry.
- *
- * @param registryClientService
*/
public void setRegistryClientService(
final RemoteConfigurationRegistryClientService registryClientService) {
@@ -206,8 +189,6 @@ public class RemoteAliasService implements AliasService {
/**
* Set a {@link MasterService} instance.
- *
- * @param ms
*/
public void setMasterService(final MasterService ms) {
this.ms = ms;
@@ -215,8 +196,6 @@ public class RemoteAliasService implements AliasService {
/**
* Set local alias service
- *
- * @param localAliasService
*/
public void setLocalAliasService(AliasService localAliasService) {
this.localAliasService = localAliasService;
@@ -228,7 +207,6 @@ public class RemoteAliasService implements AliasService {
*
* @param clusterName cluster name
* @return List of all the aliases
- * @throws AliasServiceException
*/
@Override
public List<String> getAliasesForCluster(final String clusterName)
@@ -507,7 +485,6 @@ public class RemoteAliasService implements AliasService {
* @param clusterName Name of the cluster
* @param alias Alias name to be added
* @param value alias value to be added
- * @throws AliasServiceException
*/
public void addAliasForClusterLocally(final String clusterName,
final String alias, final String value) throws AliasServiceException {
@@ -520,7 +497,6 @@ public class RemoteAliasService implements AliasService {
*
* @param clusterName Name of the cluster
* @param alias Alias name to be removed
- * @throws AliasServiceException
*/
public void removeAliasForClusterLocally(final String clusterName,
final String alias) throws AliasServiceException {
@@ -530,8 +506,6 @@ public class RemoteAliasService implements AliasService {
/**
* Ensure that the nodes are properly set up.
- *
- * @param remoteClient
*/
private void ensureEntries(
final RemoteConfigurationRegistryClient remoteClient) {
@@ -547,7 +521,6 @@ public class RemoteAliasService implements AliasService {
* Encrypt the clear text with master password.
* @param clear clear text to be encrypted
* @return encrypted and base 64 encoded result.
- * @throws Exception
*/
public String encrypt(final String clear) throws Exception {
@@ -658,9 +631,6 @@ public class RemoteAliasService implements AliasService {
/**
* Create an instance
- *
- * @param cluster
- * @param alias
*/
public RemoteAliasEntryListener(final String cluster, final String alias, final RemoteAliasService remoteAliasService) {
super();
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenAuthorityService.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenAuthorityService.java b/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenAuthorityService.java
index e5ed23f..ad8f999 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenAuthorityService.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/services/token/impl/DefaultTokenAuthorityService.java
@@ -74,39 +74,28 @@ public class DefaultTokenAuthorityService implements JWTokenAuthority, Service {
this.as = as;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.provider.federation.jwt.JWTokenAuthority#issueToken(javax.security.auth.Subject, java.lang.String)
- */
@Override
public JWT issueToken(Subject subject, String algorithm) throws TokenServiceException {
Principal p = (Principal) subject.getPrincipals().toArray()[0];
return issueToken(p, algorithm);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.provider.federation.jwt.JWTokenAuthority#issueToken(java.security.Principal, java.lang.String)
- */
@Override
public JWT issueToken(Principal p, String algorithm) throws TokenServiceException {
return issueToken(p, null, algorithm);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.provider.federation.jwt.JWTokenAuthority#issueToken(java.security.Principal, java.lang.String, long expires)
- */
@Override
public JWT issueToken(Principal p, String algorithm, long expires) throws TokenServiceException {
return issueToken(p, (String)null, algorithm, expires);
}
+ @Override
public JWT issueToken(Principal p, String audience, String algorithm)
throws TokenServiceException {
return issueToken(p, audience, algorithm, -1);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.provider.federation.jwt.JWTokenAuthority#issueToken(java.security.Principal, java.lang.String, java.lang.String)
- */
@Override
public JWT issueToken(Principal p, String audience, String algorithm, long expires)
throws TokenServiceException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/topology/simple/SimpleDescriptorFactory.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/topology/simple/SimpleDescriptorFactory.java b/gateway-server/src/main/java/org/apache/knox/gateway/topology/simple/SimpleDescriptorFactory.java
index f48b694..63a6559 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/topology/simple/SimpleDescriptorFactory.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/topology/simple/SimpleDescriptorFactory.java
@@ -32,7 +32,7 @@ public class SimpleDescriptorFactory {
* @param path The path to the file.
* @return A SimpleDescriptor based on the contents of the file.
*
- * @throws IOException
+ * @throws IOException exception on parsing the path
*/
public static SimpleDescriptor parse(String path) throws IOException {
SimpleDescriptor sd;
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/util/KnoxCLI.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/util/KnoxCLI.java b/gateway-server/src/main/java/org/apache/knox/gateway/util/KnoxCLI.java
index fd39bb4..68f9c16 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/util/KnoxCLI.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/util/KnoxCLI.java
@@ -85,9 +85,6 @@ import java.util.Map;
import java.util.Properties;
import java.util.UUID;
-/**
- *
- */
public class KnoxCLI extends Configured implements Tool {
private static final String USAGE_PREFIX = "KnoxCLI {cmd} [options]";
@@ -141,9 +138,6 @@ public class KnoxCLI extends Configured implements Tool {
private String master = null;
private String type = null;
- /* (non-Javadoc)
- * @see org.apache.hadoop.util.Tool#run(java.lang.String[])
- */
@Override
public int run(String[] args) throws Exception {
int exitCode = 0;
@@ -210,9 +204,9 @@ public class KnoxCLI extends Configured implements Tool {
* % knoxcli delete-provider-config providerConfig --registry-client name
* % knoxcli delete-descriptor descriptor --registry-client name
* </pre>
- * @param args
- * @return
- * @throws IOException
+ * @param args command line arguments
+ * @return return exit code
+ * @throws IOException exception on starting KnoxCLI
*/
private int init(String[] args) throws IOException {
if (args.length == 0) {
@@ -559,9 +553,6 @@ public class KnoxCLI extends Configured implements Tool {
"for the given hadoop --cluster. The default\n" +
"--cluster being the gateway itself.";
- /* (non-Javadoc)
- * @see KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
AliasService as = getAliasService();
@@ -584,9 +575,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -615,9 +603,6 @@ public class KnoxCLI extends Configured implements Tool {
return result;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
KeystoreService ks = getKeystoreService();
@@ -660,9 +645,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -683,9 +665,6 @@ public class KnoxCLI extends Configured implements Tool {
public CertCreateCommand() {
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
KeystoreService ks = getKeystoreService();
@@ -731,9 +710,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -754,16 +730,10 @@ public class KnoxCLI extends Configured implements Tool {
private String name = null;
- /**
- * @param alias
- */
public AliasCreateCommand(String alias) {
name = alias;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
AliasService as = getAliasService();
@@ -787,9 +757,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -822,9 +789,6 @@ public class KnoxCLI extends Configured implements Tool {
}
- /**
- *
- */
public class AliasDeleteCommand extends Command {
public static final String USAGE = "delete-alias aliasname [--cluster clustername]";
public static final String DESC = "The delete-alias command removes the\n" +
@@ -833,16 +797,10 @@ public class KnoxCLI extends Configured implements Tool {
private String name = null;
- /**
- * @param alias
- */
public AliasDeleteCommand(String alias) {
name = alias;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
AliasService as = getAliasService();
@@ -868,9 +826,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -878,9 +833,6 @@ public class KnoxCLI extends Configured implements Tool {
}
- /**
- *
- */
public class MasterCreateCommand extends Command {
public static final String USAGE = "create-master [--force]";
public static final String DESC = "The create-master command persists the\n" +
@@ -944,17 +896,11 @@ public class KnoxCLI extends Configured implements Tool {
return valid;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
out.println("Master secret has been persisted to disk.");
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -1004,8 +950,8 @@ public class KnoxCLI extends Configured implements Tool {
}
/**
- * @param cluster
- * @param ts
+ * @param cluster Cluster name to validate against the TopologyService
+ * @param ts ToplogyService to validate the given cluster name
*/
private boolean validateClusterName(String cluster, TopologyService ts) {
boolean valid = false;
@@ -1870,9 +1816,6 @@ public class KnoxCLI extends Configured implements Tool {
static final String USAGE = "list-registry-clients";
static final String DESC = "Lists all of the remote configuration registry clients defined in gateway-site.xml.\n";
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
GatewayConfig config = getGatewayConfig();
@@ -1885,9 +1828,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -2021,7 +1961,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
-
public class RemoteRegistryUploadProviderConfigCommand extends RemoteRegistryUploadCommand {
static final String USAGE = "upload-provider-config providerConfigFile --registry-client name [--entry-name entryName]";
@@ -2033,17 +1972,11 @@ public class KnoxCLI extends Configured implements Tool {
super(fileName);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
super.execute(getEntryName(PROVIDER_CONFIG_ENTRY), getSourceFile());
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -2062,17 +1995,11 @@ public class KnoxCLI extends Configured implements Tool {
super(fileName);
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
super.execute(getEntryName(DESCRIPTORS_ENTRY), getSourceFile());
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -2091,9 +2018,6 @@ public class KnoxCLI extends Configured implements Tool {
this.entry = entry;
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#execute()
- */
@Override
public void execute() throws Exception {
RemoteConfigurationRegistryClient client = getClient();
@@ -2107,9 +2031,6 @@ public class KnoxCLI extends Configured implements Tool {
}
}
- /* (non-Javadoc)
- * @see org.apache.knox.gateway.util.KnoxCLI.Command#getUsage()
- */
@Override
public String getUsage() {
return USAGE + ":\n\n" + DESC;
@@ -2199,10 +2120,6 @@ public class KnoxCLI extends Configured implements Tool {
return properties;
}
- /**
- * @param args
- * @throws Exception
- */
public static void main(String[] args) throws Exception {
PropertyConfigurator.configure( System.getProperty( "log4j.configuration" ) );
int res = ToolRunner.run(new GatewayConfigImpl(), new KnoxCLI(), args);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/websockets/GatewayWebsocketHandler.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/websockets/GatewayWebsocketHandler.java b/gateway-server/src/main/java/org/apache/knox/gateway/websockets/GatewayWebsocketHandler.java
index 73be055..99ee19d 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/websockets/GatewayWebsocketHandler.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/websockets/GatewayWebsocketHandler.java
@@ -76,12 +76,6 @@ public class GatewayWebsocketHandler extends WebSocketHandler
final GatewayConfig config;
final GatewayServices services;
- /**
- * Create an instance
- *
- * @param config
- * @param services
- */
public GatewayWebsocketHandler(final GatewayConfig config,
final GatewayServices services) {
super();
@@ -92,13 +86,6 @@ public class GatewayWebsocketHandler extends WebSocketHandler
}
- /*
- * (non-Javadoc)
- *
- * @see
- * org.eclipse.jetty.websocket.server.WebSocketHandler#configure(org.eclipse.
- * jetty.websocket.servlet.WebSocketServletFactory)
- */
@Override
public void configure(final WebSocketServletFactory factory) {
factory.setCreator(this);
@@ -121,14 +108,6 @@ public class GatewayWebsocketHandler extends WebSocketHandler
}
- /*
- * (non-Javadoc)
- *
- * @see
- * org.eclipse.jetty.websocket.servlet.WebSocketCreator#createWebSocket(org.
- * eclipse.jetty.websocket.servlet.ServletUpgradeRequest,
- * org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse)
- */
@Override
public Object createWebSocket(ServletUpgradeRequest req,
ServletUpgradeResponse resp) {
@@ -152,8 +131,6 @@ public class GatewayWebsocketHandler extends WebSocketHandler
* Returns a {@link ClientEndpointConfig} config that contains the headers
* to be passed to the backend.
* @since 0.14.0
- * @param req
- * @return
*/
private ClientEndpointConfig getClientEndpointConfig(final ServletUpgradeRequest req) {
@@ -173,8 +150,6 @@ public class GatewayWebsocketHandler extends WebSocketHandler
* This method looks at the context path and returns the backend websocket
* url. If websocket url is found it is used as is, or we default to
* ws://{host}:{port} which might or might not be right.
- *
- * @param
* @return Websocket backend url
*/
private synchronized String getMatchedBackendURL(final String path) {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/main/java/org/apache/knox/gateway/websockets/MessageEventCallback.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/main/java/org/apache/knox/gateway/websockets/MessageEventCallback.java b/gateway-server/src/main/java/org/apache/knox/gateway/websockets/MessageEventCallback.java
index bdecc68..801d198 100644
--- a/gateway-server/src/main/java/org/apache/knox/gateway/websockets/MessageEventCallback.java
+++ b/gateway-server/src/main/java/org/apache/knox/gateway/websockets/MessageEventCallback.java
@@ -32,34 +32,26 @@ public interface MessageEventCallback {
/**
* Callback when connection is established.
- * @param session
*/
void onConnectionOpen(final Object session);
/**
* Callback when connection is closed.
- * @param reason
*/
void onConnectionClose(final CloseReason reason);
/**
* Callback when there is an error in connection.
- * @param cause
*/
void onError(final Throwable cause);
/**
* Callback when a text message is received.
- * @param message
- * @param session
*/
void onMessageText(final String message, final Object session);
/**
* Callback when a binary message is received.
- * @param message
- * @param last
- * @param session
*/
void onMessageBinary(final byte[] message, final boolean last, final Object session);
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/GatewayFilterTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/GatewayFilterTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/GatewayFilterTest.java
index 83b397c..1d15874 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/GatewayFilterTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/GatewayFilterTest.java
@@ -42,9 +42,6 @@ import java.net.URISyntaxException;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
-/**
- *
- */
@Category( { UnitTests.class, FastTests.class } )
public class GatewayFilterTest {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/GatewayPortMappingConfigTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/GatewayPortMappingConfigTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/GatewayPortMappingConfigTest.java
index 59738de..6db10d2 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/GatewayPortMappingConfigTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/GatewayPortMappingConfigTest.java
@@ -182,11 +182,9 @@ public class GatewayPortMappingConfigTest {
}
- /**
+ /*
* Test a case where gateway is already running and same port is used to start
* another gateway.
- *
- * @throws IOException
*/
@Test
public void testDefaultPortInUse() throws IOException {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/jetty/JettyPathMapTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/jetty/JettyPathMapTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/jetty/JettyPathMapTest.java
index 778b11c..e5d4d44 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/jetty/JettyPathMapTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/jetty/JettyPathMapTest.java
@@ -22,9 +22,6 @@ import org.eclipse.jetty.http.PathMap;
import static org.hamcrest.core.Is.is;
import static org.junit.Assert.assertThat;
-/**
- *
- */
//@Category( { UnitTests.class, FastTests.class } )
public class JettyPathMapTest {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/mock/MockConsoleFactory.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/mock/MockConsoleFactory.java b/gateway-server/src/test/java/org/apache/knox/gateway/mock/MockConsoleFactory.java
index 80c2459..d40ef26 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/mock/MockConsoleFactory.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/mock/MockConsoleFactory.java
@@ -22,9 +22,6 @@ import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;
-/**
- *
- */
public class MockConsoleFactory {
public static Handler create() {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadBackendTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadBackendTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadBackendTest.java
index a706808..036224b 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadBackendTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadBackendTest.java
@@ -64,10 +64,8 @@ public class BadBackendTest {
}
- /**
+ /*
* Test for a message within limit.
- * @throws IOException
- * @throws Exception
*/
@Test(timeout = 8000)
public void testBadBackEnd() throws IOException, Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadUrlTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadUrlTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadUrlTest.java
index 885dbbc..0382a88 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadUrlTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/BadUrlTest.java
@@ -96,9 +96,7 @@ public class BadUrlTest {
@BeforeClass
public static void startServers() throws Exception {
-
startGatewayServer();
-
}
@AfterClass
@@ -111,15 +109,8 @@ public class BadUrlTest {
/* Cleanup the created files */
FileUtils.deleteQuietly(topoDir);
-
}
- /**
- * Test websocket proxying through gateway.
- *
- * @throws Exception
- */
-
@Test
public void testBadUrl() throws Exception {
WebSocketContainer container = ContainerProvider.getWebSocketContainer();
@@ -137,12 +128,6 @@ public class BadUrlTest {
}
-
- /**
- * Start Gateway Server.
- *
- * @throws Exception
- */
private static void startGatewayServer() throws Exception {
gatewayServer = new Server();
final ServerConnector connector = new ServerConnector(gatewayServer);
@@ -177,11 +162,8 @@ public class BadUrlTest {
gatewayWebsocketHandler.start();
}
- /**
+ /*
* Initialize the configs and components required for this test.
- *
- * @param backend
- * @throws IOException
*/
private static void setupGatewayConfig(final String backend)
throws IOException {
@@ -280,9 +262,6 @@ public class BadUrlTest {
/**
* Intentionally add bad URL
- *
- * @param backend
- * @return
*/
private static XMLTag createKnoxTopology(final String backend) {
XMLTag xml = XMLDoc.newDocument(true).addRoot("topology").addTag("service")
@@ -310,10 +289,7 @@ public class BadUrlTest {
}
}
-
}
-
}
-
}
}
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ConnectionDroppedTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ConnectionDroppedTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ConnectionDroppedTest.java
index 699696b..bdc5672 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ConnectionDroppedTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ConnectionDroppedTest.java
@@ -64,7 +64,6 @@ public class ConnectionDroppedTest {
public static void startServer() throws Exception {
startBackend();
startProxy();
-
}
@AfterClass
@@ -72,15 +71,11 @@ public class ConnectionDroppedTest {
/* ORDER MATTERS ! */
proxy.stop();
backend.stop();
-
}
- /**
+ /*
* The connection is dropped, so we should see a tineout exception when we try
* to poll the message from queue.
- *
- * @throws IOException
- * @throws Exception
*/
@Test(expected = java.util.concurrent.TimeoutException.class)
public void testDroppedConnection() throws IOException, Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/MessageFailureTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/MessageFailureTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/MessageFailureTest.java
index 6066a36..1e74d11 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/MessageFailureTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/MessageFailureTest.java
@@ -64,7 +64,6 @@ public class MessageFailureTest {
public static void startServer() throws Exception {
startBackend();
startProxy();
-
}
@AfterClass
@@ -72,14 +71,10 @@ public class MessageFailureTest {
/* ORDER MATTERS ! */
proxy.stop();
backend.stop();
-
}
-
/**
* Test for a message that bigger than configured value
- * @throws IOException
- * @throws Exception
*/
@Test(timeout = 8000)
public void testMessageTooBig() throws IOException, Exception {
@@ -96,14 +91,10 @@ public class MessageFailureTest {
TimeUnit.MILLISECONDS);
Assert.assertThat(client.close.getCloseCode().getCode(), CoreMatchers.is(CloseReason.CloseCodes.TOO_BIG.getCode()));
-
}
-
/**
* Test for a message within limit.
- * @throws IOException
- * @throws Exception
*/
@Test(timeout = 8000)
public void testMessageOk() throws IOException, Exception {
http://git-wip-us.apache.org/repos/asf/knox/blob/488e4445/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ProxyInboundClientTest.java
----------------------------------------------------------------------
diff --git a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ProxyInboundClientTest.java b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ProxyInboundClientTest.java
index e4ec5a2..a56ea49 100644
--- a/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ProxyInboundClientTest.java
+++ b/gateway-server/src/test/java/org/apache/knox/gateway/websockets/ProxyInboundClientTest.java
@@ -110,65 +110,32 @@ public class ProxyInboundClientTest {
final WebSocketContainer container = ContainerProvider.getWebSocketContainer();
final ProxyInboundClient client = new ProxyInboundClient( new MessageEventCallback() {
- /**
- * A generic callback, can be left un-implemented
- *
- * @param message
- */
@Override
public void doCallback(String message) {
}
- /**
- * Callback when connection is established.
- *
- * @param session
- */
@Override
public void onConnectionOpen(Object session) {
}
- /**
- * Callback when connection is closed.
- *
- * @param reason
- */
@Override
public void onConnectionClose(CloseReason reason) {
isTestComplete.set(true);
}
- /**
- * Callback when there is an error in connection.
- *
- * @param cause
- */
@Override
public void onError(Throwable cause) {
isTestComplete.set(true);
}
- /**
- * Callback when a text message is received.
- *
- * @param message
- * @param session
- */
@Override
public void onMessageText(String message, Object session) {
recievedMessage = message;
isTestComplete.set(true);
}
- /**
- * Callback when a binary message is received.
- *
- * @param message
- * @param last
- * @param session
- */
@Override
public void onMessageBinary(byte[] message, boolean last,
Object session) {
@@ -200,65 +167,32 @@ public class ProxyInboundClientTest {
final WebSocketContainer container = ContainerProvider.getWebSocketContainer();
final ProxyInboundClient client = new ProxyInboundClient( new MessageEventCallback() {
- /**
- * A generic callback, can be left un-implemented
- *
- * @param message
- */
@Override
public void doCallback(String message) {
}
- /**
- * Callback when connection is established.
- *
- * @param session
- */
@Override
public void onConnectionOpen(Object session) {
}
- /**
- * Callback when connection is closed.
- *
- * @param reason
- */
@Override
public void onConnectionClose(CloseReason reason) {
isTestComplete.set(true);
}
- /**
- * Callback when there is an error in connection.
- *
- * @param cause
- */
@Override
public void onError(Throwable cause) {
isTestComplete.set(true);
}
- /**
- * Callback when a text message is received.
- *
- * @param message
- * @param session
- */
@Override
public void onMessageText(String message, Object session) {
recievedMessage = message;
isTestComplete.set(true);
}
- /**
- * Callback when a binary message is received.
- *
- * @param message
- * @param last
- * @param session
- */
@Override
public void onMessageBinary(byte[] message, boolean last,
Object session) {
@@ -290,65 +224,32 @@ public class ProxyInboundClientTest {
final WebSocketContainer container = ContainerProvider.getWebSocketContainer();
final ProxyInboundClient client = new ProxyInboundClient( new MessageEventCallback() {
- /**
- * A generic callback, can be left un-implemented
- *
- * @param message
- */
@Override
public void doCallback(String message) {
}
- /**
- * Callback when connection is established.
- *
- * @param session
- */
@Override
public void onConnectionOpen(Object session) {
}
- /**
- * Callback when connection is closed.
- *
- * @param reason
- */
@Override
public void onConnectionClose(CloseReason reason) {
isTestComplete.set(true);
}
- /**
- * Callback when there is an error in connection.
- *
- * @param cause
- */
@Override
public void onError(Throwable cause) {
isTestComplete.set(true);
}
- /**
- * Callback when a text message is received.
- *
- * @param message
- * @param session
- */
@Override
public void onMessageText(String message, Object session) {
recievedMessage = message;
isTestComplete.set(true);
}
- /**
- * Callback when a binary message is received.
- *
- * @param message
- * @param last
- * @param session
- */
@Override
public void onMessageBinary(byte[] message, boolean last,
Object session) {