[grizzly~git:974dac93] [2.3.x] + fix javadocs according to the issue #1583

  • From: oleksiys@...
  • To: commits@...
  • Subject: [grizzly~git:974dac93] [2.3.x] + fix javadocs according to the issue #1583
  • Date: Mon, 9 Sep 2013 18:22:44 +0000

Project:    grizzly
Repository: git
Revision:   974dac9395090182c8e9f9b63e7a90b0875c8eef
Author:     oleksiys
Date:       2013-09-09 18:21:51 UTC
Link:       

Log Message:
------------
[2.3.x] + fix javadocs according to the issue #1583
https://java.net/jira/browse/GRIZZLY-1583

createSimpleHttpServer does not document it accepts null



Revisions:
----------
974dac9395090182c8e9f9b63e7a90b0875c8eef


Modified Paths:
---------------
modules/http-server/src/main/java/org/glassfish/grizzly/http/server/HttpServer.java


Diffs:
------
--- 
a/modules/http-server/src/main/java/org/glassfish/grizzly/http/server/HttpServer.java
+++ 
b/modules/http-server/src/main/java/org/glassfish/grizzly/http/server/HttpServer.java
@@ -135,9 +135,6 @@ public class HttpServer {
 
     protected volatile Object managementObject;
 
-//    private volatile JmxObject serviceManagementObject;
-
-
     // ---------------------------------------------------------- Public 
Methods
 
 
@@ -230,7 +227,7 @@ public class HttpServer {
                 } catch (IOException ioe) {
                     if (LOGGER.isLoggable(Level.SEVERE)) {
                         LOGGER.log(Level.SEVERE,
-                                   "Failed to stop listener [{0}] : {1}",
+                                   "Failed to shutdown listener [{0}] : {1}",
                                     new Object[] { listener.toString(), 
ioe.toString() });
                         LOGGER.log(Level.SEVERE, ioe.toString(), ioe);
                     }
@@ -478,7 +475,7 @@ public class HttpServer {
     /**
      * @return a <code>HttpServer</code> configured to listen to requests
      * on {@link NetworkListener#DEFAULT_NETWORK_HOST}:{@link 
NetworkListener#DEFAULT_NETWORK_PORT},
-     * using the directory in which the server was launched the server's 
document root.
+     * using the directory in which the server was launched the server's 
document root
      */
     public static HttpServer createSimpleServer() {
 
@@ -488,101 +485,107 @@ public class HttpServer {
 
 
     /**
-     * @param path the document root.
+     * @param docRoot the document root,
+     *   can be <code>null</code> when no static pages are needed
      *
      * @return a <code>HttpServer</code> configured to listen to requests
      * on {@link NetworkListener#DEFAULT_NETWORK_HOST}:{@link 
NetworkListener#DEFAULT_NETWORK_PORT},
-     * using the specified <code>path</code> as the server's document root.
+     * using the specified <code>docRoot</code> as the server's document root
      */
-    public static HttpServer createSimpleServer(final String path) {
+    public static HttpServer createSimpleServer(final String docRoot) {
 
-        return createSimpleServer(path, 
NetworkListener.DEFAULT_NETWORK_PORT);
+        return createSimpleServer(docRoot, 
NetworkListener.DEFAULT_NETWORK_PORT);
 
     }
 
 
     /**
-     * @param path the document root.
-     * @param port the network port to which this listener will bind.
+     * @param docRoot the document root,
+     *   can be <code>null</code> when no static pages are needed
+     * @param port the network port to which this listener will bind
      *
      * @return a <code>HttpServer</code> configured to listen to requests
      * on {@link NetworkListener#DEFAULT_NETWORK_HOST}:<code>port</code>,
-     * using the specified <code>path</code> as the server's document root.
+     * using the specified <code>docRoot</code> as the server's document root
      */
-    public static HttpServer createSimpleServer(final String path,
+    public static HttpServer createSimpleServer(final String docRoot,
                                                 final int port) {
 
-        return createSimpleServer(path, 
NetworkListener.DEFAULT_NETWORK_HOST, port);
+        return createSimpleServer(docRoot, 
NetworkListener.DEFAULT_NETWORK_HOST, port);
 
     }
 
 
     /**
-     * @param path the document root.
-     * @param range port range to attempt to bind to.
+     * @param docRoot the document root,
+     *   can be <code>null</code> when no static pages are needed
+     * @param range port range to attempt to bind to
      *
      * @return a <code>HttpServer</code> configured to listen to requests
      * on {@link 
NetworkListener#DEFAULT_NETWORK_HOST}:<code>[port-range]</code>,
-     * using the specified <code>path</code> as the server's document root.
+     * using the specified <code>docRoot</code> as the server's document root
      */
-    public static HttpServer createSimpleServer(final String path,
+    public static HttpServer createSimpleServer(final String docRoot,
                                                 final PortRange range) {
 
-        return createSimpleServer(path,
+        return createSimpleServer(docRoot,
                 NetworkListener.DEFAULT_NETWORK_HOST,
                 range);
 
     }
 
     /**
-     * @param path the document root.
-     * @param socketAddress the endpoint address to which this listener will 
bind.
+     * @param docRoot the document root,
+     *   can be <code>null</code> when no static pages are needed
+     * @param socketAddress the endpoint address to which this listener will 
bind
      *
      * @return a <code>HttpServer</code> configured to listen to requests
      * on <code>socketAddress</code>,
-     * using the specified <code>path</code> as the server's document root.
+     * using the specified <code>docRoot</code> as the server's document root
      */
-    public static HttpServer createSimpleServer(final String path,
+    public static HttpServer createSimpleServer(final String docRoot,
                                                 final SocketAddress 
socketAddress) {
 
         final InetSocketAddress inetAddr = (InetSocketAddress) socketAddress;
-        return createSimpleServer(path, inetAddr.getHostName(), 
inetAddr.getPort());
+        return createSimpleServer(docRoot, inetAddr.getHostName(), 
inetAddr.getPort());
     }
 
     /**
-     * @param path the document root.
-     * @param host the network port to which this listener will bind.
-     * @param port the network port to which this listener will bind.
+     * @param docRoot the document root,
+     *   can be <code>null</code> when no static pages are needed
+     * @param host the network port to which this listener will bind
+     * @param port the network port to which this listener will bind
      *
      * @return a <code>HttpServer</code> configured to listen to requests
      * on <code>host</code>:<code>port</code>,
-     * using the specified <code>path</code> as the server's document root.
+     * using the specified <code>docRoot</code> as the server's document root
      */
-    public static HttpServer createSimpleServer(final String path,
+    public static HttpServer createSimpleServer(final String docRoot,
                                                 final String host,
                                                 final int port) {
         
-        return createSimpleServer(path, host, new PortRange(port));
+        return createSimpleServer(docRoot, host, new PortRange(port));
 
     }
     
     /**
-     * @param path the document root.
-     * @param host the network port to which this listener will bind.
-     * @param range port range to attempt to bind to.
+     * @param docRoot the document root,
+     *   can be <code>null</code> when no static pages are needed
+     * @param host the network port to which this listener will bind
+     * @param range port range to attempt to bind to
      *
      * @return a <code>HttpServer</code> configured to listen to requests
      * on <code>host</code>:<code>[port-range]</code>,
-     * using the specified <code>path</code> as the server's document root.
+     * using the specified <code>docRoot</code> as the server's document root
      */
-    public static HttpServer createSimpleServer(final String path,
+    public static HttpServer createSimpleServer(final String docRoot,
                                                 final String host,
                                                 final PortRange range) {
 
         final HttpServer server = new HttpServer();
         final ServerConfiguration config = server.getServerConfiguration();
-        if (path != null) {
-            config.addHttpHandler(new StaticHttpHandler(path), "/");
+        if (docRoot != null) {
+            config.addHttpHandler(new StaticHttpHandler(docRoot), "/");
         }
         final NetworkListener listener =
                 new NetworkListener("grizzly",





[grizzly~git:974dac93] [2.3.x] + fix javadocs according to the issue #1583

oleksiys 09/09/2013
Terms of Use; Privacy Policy; Copyright ©2013-2016 (revision 20160708.bf2ac18)
 
 
Close
loading
Please Confirm
Close