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 & */
