Skip to content

Commit 36eadf6

Browse files
committed
minor javadoc updates
1 parent 68571b4 commit 36eadf6

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

src/main/java/org/robotframework/remoteserver/RemoteServer.java

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@
3535
/**
3636
* Remote server for Robot Framework implemented in Java. Takes one or more test
3737
* libraries and exposes their methods via XML-RPC using an embedded web server.
38+
* To use a different web server, use
39+
* {@link org.robotframework.remoteserver.servlet.RemoteServerServlet} instead.
3840
*
3941
* @see <a
4042
* href="https://github.com/ombre42/jrobotremoteserver/wiki">jrobotremoteserver
@@ -122,6 +124,12 @@ public void setHost(String hostName) {
122124
connector.setHost(hostName);
123125
}
124126

127+
/**
128+
* Main method for command line usage.
129+
*
130+
* @param args
131+
* @throws Exception
132+
*/
125133
public static void main(String[] args) throws Exception {
126134
configureLogging();
127135
CommandLineHelper helper = new CommandLineHelper(args);
@@ -257,9 +265,8 @@ public void addLibrary(Class<?> clazz, int port) {
257265

258266
/**
259267
* A non-blocking method for stopping the remote server that allows requests
260-
* to complete within the given timeout before shutting down the server.
261-
* This method exists to allow stopping the server remotely. New connections
262-
* will not be accepted after calling this.
268+
* to complete within the given timeout before shutting down the server. New
269+
* connections will not be accepted after calling this.
263270
*
264271
* @param timeoutMS
265272
* the milliseconds to wait for existing request to complete

src/main/java/org/robotframework/remoteserver/servlet/RemoteServerServlet.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@
3939
import org.robotframework.remoteserver.xmlrpc.TypeFactory;
4040

4141
/**
42-
* This servlet uses the same instance of a test library to process all requests
42+
* This servlet can be used with servlet containers such as GlassFish,
43+
* WebSphere, Tiny Java Web Server, etc. The paths for the library mapping are
44+
* relative to the servlet path. When a remote stop is performed,
45+
* <code>System.exit(0)</code> is executed.
4346
*/
4447
public class RemoteServerServlet extends XmlRpcServlet implements RemoteServerContext {
4548
private static final long serialVersionUID = -7981676271855172976L;
@@ -108,7 +111,7 @@ public void doPost(HttpServletRequest req, HttpServletResponse resp) throws Serv
108111
* when the client is Jython 2.5.x (old xmlrpclib using HTTP/1.0), the
109112
* server's sockets got stuck in FIN_WAIT_2 for some time, eventually
110113
* hitting the limit of open sockets on some Windows systems. adding
111-
* this header gets Jetty to close the socket.
114+
* this header gets the web server to close the socket.
112115
*/
113116
String path = req.getPathInfo() == null ? req.getServletPath() : req.getPathInfo();
114117
path = cleanPath(path);

0 commit comments

Comments
 (0)