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) {
