Skip to content
This repository was archived by the owner on Jul 31, 2022. It is now read-only.

Commit 375ff32

Browse files
committed
Add httpconfig doc
1 parent 099025a commit 375ff32

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/main/java/com/kttdevelopment/simplehttpserver/SimpleHttpsServer.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
import java.io.IOException;
66

77
/**
8-
* <i>This class is a simplified implementation of {@link HttpsServer}.</i><br>
8+
* <i>This class is a simplified implementation of {@link HttpsServer}.</i>
9+
* The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.<br>
910
* At least one {@link HttpHandler} must be created in order to process requests. When handling requests the server will use the most specific context. If no handler can be found it is rejected with a 404 response. <br>
1011
* <b>Contexts are case-sensitive.</b>
1112
*
@@ -31,7 +32,7 @@ public abstract class SimpleHttpsServer extends SimpleHttpServer {
3132
//
3233

3334
/**
34-
* Creates a {@link SimpleHttpsServer}.
35+
* Creates a {@link SimpleHttpsServer}. The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.
3536
*
3637
* @return a {@link SimpleHttpsServer}
3738
* @throws IOException uncaught exception
@@ -44,7 +45,7 @@ public static SimpleHttpsServer create() throws IOException {
4445
}
4546

4647
/**
47-
* Creates a {@link SimpleHttpsServer} bounded to a port.
48+
* Creates a {@link SimpleHttpsServer} bounded to a port. The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.
4849
*
4950
* @param port port to bind to
5051
* @return a {@link SimpleHttpsServer}
@@ -61,7 +62,7 @@ public static SimpleHttpsServer create(final int port) throws IOException {
6162
}
6263

6364
/**
64-
* Creates a {@link SimpleHttpsServer} bounded to a port.
65+
* Creates a {@link SimpleHttpsServer} bounded to a port. The server must have a {@link HttpsConfigurator} set using {@link #setHttpsConfigurator(HttpsConfigurator)}.
6566
*
6667
* @param port port to bind to
6768
* @param backlog request backlog

0 commit comments

Comments
 (0)