-
Notifications
You must be signed in to change notification settings - Fork 910
/
ServerBuilder.java
2352 lines (2167 loc) · 104 KB
/
ServerBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2015 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package com.linecorp.armeria.server;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.linecorp.armeria.common.SessionProtocol.HTTP;
import static com.linecorp.armeria.common.SessionProtocol.HTTPS;
import static com.linecorp.armeria.common.SessionProtocol.PROXY;
import static com.linecorp.armeria.server.DefaultServerConfig.validateGreaterThanOrEqual;
import static com.linecorp.armeria.server.DefaultServerConfig.validateIdleTimeoutMillis;
import static com.linecorp.armeria.server.DefaultServerConfig.validateMaxNumConnections;
import static com.linecorp.armeria.server.DefaultServerConfig.validateNonNegative;
import static io.netty.handler.codec.http2.Http2CodecUtil.MAX_FRAME_SIZE_LOWER_BOUND;
import static io.netty.handler.codec.http2.Http2CodecUtil.MAX_FRAME_SIZE_UPPER_BOUND;
import static java.util.Objects.requireNonNull;
import java.io.File;
import java.io.InputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.nio.file.Path;
import java.security.PrivateKey;
import java.security.cert.X509Certificate;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import javax.net.ssl.KeyManagerFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.common.net.HostAndPort;
import com.linecorp.armeria.common.CommonPools;
import com.linecorp.armeria.common.DependencyInjector;
import com.linecorp.armeria.common.Flags;
import com.linecorp.armeria.common.Http1HeaderNaming;
import com.linecorp.armeria.common.HttpHeaderNames;
import com.linecorp.armeria.common.HttpRequest;
import com.linecorp.armeria.common.HttpResponse;
import com.linecorp.armeria.common.Request;
import com.linecorp.armeria.common.RequestContext;
import com.linecorp.armeria.common.RequestContextStorage;
import com.linecorp.armeria.common.RequestId;
import com.linecorp.armeria.common.ResponseHeaders;
import com.linecorp.armeria.common.SessionProtocol;
import com.linecorp.armeria.common.SuccessFunction;
import com.linecorp.armeria.common.TlsSetters;
import com.linecorp.armeria.common.annotation.Nullable;
import com.linecorp.armeria.common.annotation.UnstableApi;
import com.linecorp.armeria.common.logging.RequestOnlyLog;
import com.linecorp.armeria.common.util.BlockingTaskExecutor;
import com.linecorp.armeria.common.util.DomainSocketAddress;
import com.linecorp.armeria.common.util.EventLoopGroups;
import com.linecorp.armeria.common.util.SystemInfo;
import com.linecorp.armeria.common.util.ThreadFactories;
import com.linecorp.armeria.internal.common.BuiltInDependencyInjector;
import com.linecorp.armeria.internal.common.ReflectiveDependencyInjector;
import com.linecorp.armeria.internal.common.RequestContextUtil;
import com.linecorp.armeria.internal.common.util.ChannelUtil;
import com.linecorp.armeria.internal.server.RouteDecoratingService;
import com.linecorp.armeria.internal.server.annotation.AnnotatedServiceExtensions;
import com.linecorp.armeria.server.annotation.ExceptionHandlerFunction;
import com.linecorp.armeria.server.annotation.RequestConverterFunction;
import com.linecorp.armeria.server.annotation.ResponseConverterFunction;
import com.linecorp.armeria.server.logging.AccessLogWriter;
import com.linecorp.armeria.server.logging.LoggingService;
import io.micrometer.core.instrument.MeterRegistry;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelOption;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.EventLoopGroup;
import io.netty.handler.ssl.SslContext;
import io.netty.handler.ssl.SslContextBuilder;
import io.netty.util.Mapping;
import io.netty.util.NetUtil;
import it.unimi.dsi.fastutil.objects.Object2ObjectArrayMap;
/**
* Builds a new {@link Server} and its {@link ServerConfig}.
* <h2>Example</h2>
* <pre>{@code
* ServerBuilder sb = Server.builder();
* // Add a port to listen
* sb.http(8080);
* // Add services to the default virtual host.
* sb.service(...);
* sb.serviceUnder(...);
* // Build a server.
* Server s = sb.build();
* }</pre>
*
* <h2>Example 2</h2>
* <pre>{@code
* ServerBuilder sb = Server.builder();
* Server server =
* sb.http(8080) // Add a port to listen
* .defaultVirtualHost() // Add services to the default virtual host.
* .service(...)
* .serviceUnder(...)
* .and().virtualHost("*.foo.com") // Add a another virtual host.
* .service(...)
* .serviceUnder(...)
* .and().build(); // Build a server.
* }</pre>
*
* <h2 id="no_port_specified">What happens if no HTTP(S) port is specified?</h2>
*
* <p>When no TCP/IP port number or local address is specified, {@link ServerBuilder} will automatically bind
* to a random TCP/IP port assigned by the OS. It will serve HTTPS if you configured TLS (or HTTP otherwise),
* e.g.
*
* <pre>{@code
* // Build an HTTP server that runs on an ephemeral TCP/IP port.
* Server httpServer = Server.builder()
* .service(...)
* .build();
*
* // Build an HTTPS server that runs on an ephemeral TCP/IP port.
* Server httpsServer = Server.builder()
* .tls(...)
* .service(...)
* .build();
* }</pre>
*
* @see VirtualHostBuilder
*/
public final class ServerBuilder implements TlsSetters, ServiceConfigsBuilder {
private static final Logger logger = LoggerFactory.getLogger(ServerBuilder.class);
// Defaults to no graceful shutdown.
private static final Duration DEFAULT_GRACEFUL_SHUTDOWN_QUIET_PERIOD = Duration.ZERO;
private static final Duration DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT = Duration.ZERO;
private static final int PROXY_PROTOCOL_DEFAULT_MAX_TLV_SIZE = 65535 - 216;
private static final String DEFAULT_ACCESS_LOGGER_PREFIX = "com.linecorp.armeria.logging.access";
private static final Consumer<ChannelPipeline> DEFAULT_CHILD_CHANNEL_PIPELINE_CUSTOMIZER =
v -> { /* no-op */ };
@VisibleForTesting
static final long MIN_PING_INTERVAL_MILLIS = 1000L;
private static final long MIN_MAX_CONNECTION_AGE_MILLIS = 1_000L;
private static final ExecutorService START_STOP_EXECUTOR = Executors.newSingleThreadExecutor(
ThreadFactories.newThreadFactory("startstop-support", true));
static {
RequestContextUtil.init();
}
private final List<ServerPort> ports = new ArrayList<>();
private final List<ServerListener> serverListeners = new ArrayList<>();
@VisibleForTesting
final VirtualHostBuilder virtualHostTemplate = new VirtualHostBuilder(this, false);
private final VirtualHostBuilder defaultVirtualHostBuilder = new VirtualHostBuilder(this, true);
private final List<VirtualHostBuilder> virtualHostBuilders = new ArrayList<>();
EventLoopGroup workerGroup = CommonPools.workerGroup();
private boolean shutdownWorkerGroupOnStop;
private Executor startStopExecutor = START_STOP_EXECUTOR;
private final Map<ChannelOption<?>, Object> channelOptions = new Object2ObjectArrayMap<>();
private final Map<ChannelOption<?>, Object> childChannelOptions = new Object2ObjectArrayMap<>();
private Consumer<ChannelPipeline> childChannelPipelineCustomizer =
DEFAULT_CHILD_CHANNEL_PIPELINE_CUSTOMIZER;
private int maxNumConnections = Flags.maxNumConnections();
private long idleTimeoutMillis = Flags.defaultServerIdleTimeoutMillis();
private boolean keepAliveOnPing = Flags.defaultServerKeepAliveOnPing();
private long pingIntervalMillis = Flags.defaultPingIntervalMillis();
private long maxConnectionAgeMillis = Flags.defaultMaxServerConnectionAgeMillis();
private long connectionDrainDurationMicros = Flags.defaultServerConnectionDrainDurationMicros();
private int maxNumRequestsPerConnection = Flags.defaultMaxServerNumRequestsPerConnection();
private int http2InitialConnectionWindowSize = Flags.defaultHttp2InitialConnectionWindowSize();
private int http2InitialStreamWindowSize = Flags.defaultHttp2InitialStreamWindowSize();
private long http2MaxStreamsPerConnection = Flags.defaultHttp2MaxStreamsPerConnection();
private int http2MaxFrameSize = Flags.defaultHttp2MaxFrameSize();
private long http2MaxHeaderListSize = Flags.defaultHttp2MaxHeaderListSize();
private int http1MaxInitialLineLength = Flags.defaultHttp1MaxInitialLineLength();
private int http1MaxHeaderSize = Flags.defaultHttp1MaxHeaderSize();
private int http1MaxChunkSize = Flags.defaultHttp1MaxChunkSize();
private int proxyProtocolMaxTlvSize = PROXY_PROTOCOL_DEFAULT_MAX_TLV_SIZE;
private Duration gracefulShutdownQuietPeriod = DEFAULT_GRACEFUL_SHUTDOWN_QUIET_PERIOD;
private Duration gracefulShutdownTimeout = DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT;
private MeterRegistry meterRegistry = Flags.meterRegistry();
@Nullable
private ServerErrorHandler errorHandler;
private List<ClientAddressSource> clientAddressSources = ClientAddressSource.DEFAULT_SOURCES;
private Predicate<? super InetAddress> clientAddressTrustedProxyFilter = address -> false;
private Predicate<? super InetAddress> clientAddressFilter = address -> true;
private Function<? super ProxiedAddresses, ? extends InetSocketAddress> clientAddressMapper =
ProxiedAddresses::sourceAddress;
private boolean enableServerHeader = true;
private boolean enableDateHeader = true;
private Http1HeaderNaming http1HeaderNaming = Http1HeaderNaming.ofDefault();
@Nullable
private DependencyInjector dependencyInjector;
private Function<? super String, String> absoluteUriTransformer = Function.identity();
private long unhandledExceptionsReportIntervalMillis =
Flags.defaultUnhandledExceptionsReportIntervalMillis();
private final List<ShutdownSupport> shutdownSupports = new ArrayList<>();
private int http2MaxResetFramesPerWindow = Flags.defaultServerHttp2MaxResetFramesPerMinute();
private int http2MaxResetFramesWindowSeconds = 60;
ServerBuilder() {
// Set the default host-level properties.
virtualHostTemplate.rejectedRouteHandler(RejectedRouteHandler.WARN);
virtualHostTemplate.defaultServiceNaming(ServiceNaming.fullTypeName());
virtualHostTemplate.requestTimeoutMillis(Flags.defaultRequestTimeoutMillis());
virtualHostTemplate.maxRequestLength(Flags.defaultMaxRequestLength());
virtualHostTemplate.verboseResponses(Flags.verboseResponses());
virtualHostTemplate.accessLogger(
host -> LoggerFactory.getLogger(defaultAccessLoggerName(host.hostnamePattern())));
virtualHostTemplate.tlsSelfSigned(false);
virtualHostTemplate.tlsAllowUnsafeCiphers(false);
virtualHostTemplate.annotatedServiceExtensions(ImmutableList.of(), ImmutableList.of(),
ImmutableList.of());
virtualHostTemplate.blockingTaskExecutor(CommonPools.blockingTaskExecutor(), false);
virtualHostTemplate.successFunction(SuccessFunction.ofDefault());
virtualHostTemplate.requestAutoAbortDelayMillis(0);
virtualHostTemplate.multipartUploadsLocation(Flags.defaultMultipartUploadsLocation());
virtualHostTemplate.requestIdGenerator(routingContext -> RequestId.random());
}
private static String defaultAccessLoggerName(String hostnamePattern) {
requireNonNull(hostnamePattern, "hostnamePattern");
final HostAndPort hostAndPort = HostAndPort.fromString(hostnamePattern);
hostnamePattern = hostAndPort.getHost();
final String[] elements = hostnamePattern.split("\\.");
final StringBuilder name = new StringBuilder(
DEFAULT_ACCESS_LOGGER_PREFIX.length() + hostnamePattern.length() + 1);
name.append(DEFAULT_ACCESS_LOGGER_PREFIX);
for (int i = elements.length - 1; i >= 0; i--) {
final String element = elements[i];
if (element.isEmpty() || "*".equals(element)) {
continue;
}
name.append('.');
name.append(element);
}
if (hostAndPort.hasPort()) {
name.append(':');
name.append(hostAndPort.getPort());
}
return name.toString();
}
/**
* Adds an HTTP port that listens on all available network interfaces.
*
* @param port the HTTP port number.
*
* @see #http(InetSocketAddress)
* @see <a href="#no_port_specified">What happens if no HTTP(S) port is specified?</a>
*/
public ServerBuilder http(int port) {
return port(new ServerPort(port, HTTP));
}
/**
* Adds an HTTP port that listens to the specified {@code localAddress}.
*
* @param localAddress the local address to bind
*
* @see #http(int)
* @see <a href="#no_port_specified">What happens if no HTTP(S) port is specified?</a>
*/
public ServerBuilder http(InetSocketAddress localAddress) {
return port(new ServerPort(requireNonNull(localAddress, "localAddress"), HTTP));
}
/**
* Adds an HTTPS port that listens on all available network interfaces.
*
* @param port the HTTPS port number.
*
* @see #https(InetSocketAddress)
* @see <a href="#no_port_specified">What happens if no HTTP(S) port is specified?</a>
*/
public ServerBuilder https(int port) {
return port(new ServerPort(port, HTTPS));
}
/**
* Adds an HTTPS port that listens to the specified {@code localAddress}.
*
* @param localAddress the local address to bind
*
* @see #http(int)
* @see <a href="#no_port_specified">What happens if no HTTP(S) port is specified?</a>
*/
public ServerBuilder https(InetSocketAddress localAddress) {
return port(new ServerPort(requireNonNull(localAddress, "localAddress"), HTTPS));
}
/**
* Adds a new {@link ServerPort} that listens to the specified {@code port} of all available network
* interfaces using the specified {@link SessionProtocol}s. Specify multiple protocols to serve more than
* one protocol on the same port:
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* // Serve both HTTP and HTTPS at port 8080.
* sb.port(8080,
* SessionProtocol.HTTP,
* SessionProtocol.HTTPS);
* // Enable HTTPS with PROXY protocol support at port 8443.
* sb.port(8443,
* SessionProtocol.PROXY,
* SessionProtocol.HTTPS);
* }</pre>
*/
public ServerBuilder port(int port, SessionProtocol... protocols) {
return port(new ServerPort(port, protocols));
}
/**
* Adds a new {@link ServerPort} that listens to the specified {@code port} of all available network
* interfaces using the specified {@link SessionProtocol}s. Specify multiple protocols to serve more than
* one protocol on the same port:
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* // Serve both HTTP and HTTPS at port 8080.
* sb.port(8080,
* Arrays.asList(SessionProtocol.HTTP,
* SessionProtocol.HTTPS));
* // Enable HTTPS with PROXY protocol support at port 8443.
* sb.port(8443,
* Arrays.asList(SessionProtocol.PROXY,
* SessionProtocol.HTTPS));
* }</pre>
*/
public ServerBuilder port(int port, Iterable<SessionProtocol> protocols) {
return port(new ServerPort(port, protocols));
}
/**
* Adds a new {@link ServerPort} that listens to the specified {@code localAddress} using the specified
* {@link SessionProtocol}s. Specify multiple protocols to serve more than one protocol on the same port:
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* // Serve both HTTP and HTTPS at port 8080.
* sb.port(new InetSocketAddress(8080),
* SessionProtocol.HTTP,
* SessionProtocol.HTTPS);
* // Enable HTTPS with PROXY protocol support at port 8443.
* sb.port(new InetSocketAddress(8443),
* SessionProtocol.PROXY,
* SessionProtocol.HTTPS);
* }</pre>
*/
public ServerBuilder port(InetSocketAddress localAddress, SessionProtocol... protocols) {
return port(new ServerPort(localAddress, protocols));
}
/**
* Adds a new {@link ServerPort} that listens to the specified {@code localAddress} using the specified
* {@link SessionProtocol}s. Specify multiple protocols to serve more than one protocol on the same port:
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* // Serve both HTTP and HTTPS at port 8080.
* sb.port(new InetSocketAddress(8080),
* Arrays.asList(SessionProtocol.HTTP,
* SessionProtocol.HTTPS));
* // Enable HTTPS with PROXY protocol support at port 8443.
* sb.port(new InetSocketAddress(8443),
* Arrays.asList(SessionProtocol.PROXY,
* SessionProtocol.HTTPS));
* }</pre>
*/
public ServerBuilder port(InetSocketAddress localAddress, Iterable<SessionProtocol> protocols) {
return port(new ServerPort(localAddress, protocols));
}
/**
* Adds the specified {@link ServerPort}.
*
* @see <a href="#no_port_specified">What happens if no HTTP(S) port is specified?</a>
*/
public ServerBuilder port(ServerPort port) {
ports.add(requireNonNull(port, "port"));
return this;
}
/**
* Adds a new {@link ServerPort} that listens to the loopback {@code localAddress} using the specified
* {@link SessionProtocol}s. Specify multiple protocols to serve more than one protocol on the same port:
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* sb.localPort(8080, SessionProtocol.HTTP, SessionProtocol.HTTPS);
* }</pre>
*/
public ServerBuilder localPort(int port, SessionProtocol... protocols) {
requireNonNull(protocols, "protocols");
return localPort(port, ImmutableList.copyOf(protocols));
}
/**
* Adds a new {@link ServerPort} that listens to the loopback {@code localAddress} using the specified
* {@link SessionProtocol}s. Specify multiple protocols to serve more than one protocol on the same port:
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* sb.localPort(8080, Arrays.asList(SessionProtocol.HTTP, SessionProtocol.HTTPS));
* }</pre>
*/
public ServerBuilder localPort(int port, Iterable<SessionProtocol> protocols) {
final long portGroup = ServerPort.nextPortGroup();
port(new ServerPort(new InetSocketAddress(NetUtil.LOCALHOST4, port), protocols, portGroup));
if (SystemInfo.hasIpV6()) {
port(new ServerPort(new InetSocketAddress(NetUtil.LOCALHOST6, port), protocols, portGroup));
}
return this;
}
/**
* Sets the {@link ChannelOption} of the server socket bound by {@link Server}.
* Note that the previously added option will be overridden if the same option is set again.
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* sb.channelOption(ChannelOption.BACKLOG, 1024);
* }</pre>
*/
public <T> ServerBuilder channelOption(ChannelOption<T> option, T value) {
requireNonNull(option, "option");
checkArgument(!ChannelUtil.prohibitedOptions().contains(option),
"prohibited socket option: %s", option);
option.validate(value);
channelOptions.put(option, value);
return this;
}
/**
* Sets the {@link ChannelOption} of sockets accepted by {@link Server}.
* Note that the previously added option will be overridden if the same option is set again.
*
* <pre>{@code
* ServerBuilder sb = Server.builder();
* sb.childChannelOption(ChannelOption.SO_REUSEADDR, true)
* .childChannelOption(ChannelOption.SO_KEEPALIVE, true);
* }</pre>
*/
public <T> ServerBuilder childChannelOption(ChannelOption<T> option, T value) {
requireNonNull(option, "option");
checkArgument(!ChannelUtil.prohibitedOptions().contains(option),
"prohibited socket option: %s", option);
option.validate(value);
childChannelOptions.put(option, value);
return this;
}
/**
* (Advanced users only) Adds the {@link Consumer} that customizes the Netty {@link ChannelPipeline}.
* This customizer is run right after the initial set of {@link ChannelHandler}s are configured.
* This customizer is no-op by default.
*
* <p>Note that usage of this customizer is an advanced feature and may produce unintended side effects,
* including complete breakdown. It is not recommended if you are not familiar with Armeria and Netty
* internals.
*/
@UnstableApi
public ServerBuilder childChannelPipelineCustomizer(
Consumer<? super ChannelPipeline> childChannelPipelineCustomizer) {
requireNonNull(childChannelPipelineCustomizer, "childChannelPipelineCustomizer");
this.childChannelPipelineCustomizer =
this.childChannelPipelineCustomizer.andThen(childChannelPipelineCustomizer);
return this;
}
/**
* Sets the worker {@link EventLoopGroup} which is responsible for performing socket I/O and running
* {@link Service#serve(ServiceRequestContext, Request)}.
* If not set, {@linkplain CommonPools#workerGroup() the common worker group} is used.
*
* @param shutdownOnStop whether to shut down the worker {@link EventLoopGroup}
* when the {@link Server} stops
*/
public ServerBuilder workerGroup(EventLoopGroup workerGroup, boolean shutdownOnStop) {
this.workerGroup = requireNonNull(workerGroup, "workerGroup");
// We don't use ShutdownSupport to shutdown with other instances because we shut down workerGroup first.
shutdownWorkerGroupOnStop = shutdownOnStop;
return this;
}
/**
* Uses a newly created {@link EventLoopGroup} with the specified number of threads for
* performing socket I/O and running {@link Service#serve(ServiceRequestContext, Request)}.
* The worker {@link EventLoopGroup} will be shut down when the {@link Server} stops.
*
* @param numThreads the number of event loop threads
*/
public ServerBuilder workerGroup(int numThreads) {
checkArgument(numThreads >= 0, "numThreads: %s (expected: >= 0)", numThreads);
workerGroup(EventLoopGroups.newEventLoopGroup(numThreads), true);
return this;
}
/**
* Sets the worker {@link EventLoopGroup} which is responsible for running
* {@link Service#serve(ServiceRequestContext, Request)}.
* If not set, the value set via {@linkplain #workerGroup(EventLoopGroup, boolean)}
* or {@linkplain #workerGroup(int)} is used.
*
* @param shutdownOnStop whether to shut down the worker {@link EventLoopGroup}
* when the {@link Server} stops
*/
@UnstableApi
public ServerBuilder serviceWorkerGroup(EventLoopGroup serviceWorkerGroup, boolean shutdownOnStop) {
virtualHostTemplate.serviceWorkerGroup(serviceWorkerGroup, shutdownOnStop);
return this;
}
/**
* Uses a newly created {@link EventLoopGroup} with the specified number of threads for
* running {@link Service#serve(ServiceRequestContext, Request)}.
* The worker {@link EventLoopGroup} will be shut down when the {@link Server} stops.
*
* @param numThreads the number of event loop threads
*/
@UnstableApi
public ServerBuilder serviceWorkerGroup(int numThreads) {
virtualHostTemplate.serviceWorkerGroup(EventLoopGroups.newEventLoopGroup(numThreads), true);
return this;
}
/**
* Sets the {@link Executor} which will invoke the callbacks of {@link Server#start()},
* {@link Server#stop()} and {@link ServerListener}.
*/
public ServerBuilder startStopExecutor(Executor startStopExecutor) {
this.startStopExecutor = requireNonNull(startStopExecutor, "startStopExecutor");
return this;
}
/**
* Sets the maximum allowed number of open connections.
*/
public ServerBuilder maxNumConnections(int maxNumConnections) {
this.maxNumConnections = validateMaxNumConnections(maxNumConnections);
return this;
}
@VisibleForTesting
int maxNumConnections() {
return maxNumConnections;
}
/**
* Sets the idle timeout of a connection in milliseconds for keep-alive.
*
* @param idleTimeoutMillis the timeout in milliseconds. {@code 0} disables the timeout.
*/
public ServerBuilder idleTimeoutMillis(long idleTimeoutMillis) {
return idleTimeout(Duration.ofMillis(idleTimeoutMillis));
}
/**
* Sets the idle timeout of a connection in milliseconds for keep-alive and whether to prevent
* connection going idle when an HTTP/2 PING frame or {@code "OPTIONS * HTTP/1.1"} request is received.
*
* @param idleTimeoutMillis the timeout in milliseconds. {@code 0} disables the timeout.
* @param keepAliveOnPing whether to reset idle timeout on HTTP/2 PING frame, OPTIONS * request or not.
*/
@UnstableApi
public ServerBuilder idleTimeoutMillis(long idleTimeoutMillis, boolean keepAliveOnPing) {
return idleTimeout(Duration.ofMillis(idleTimeoutMillis), keepAliveOnPing);
}
/**
* Sets the idle timeout of a connection for keep-alive.
*
* @param idleTimeout the timeout. {@code 0} disables the timeout.
*/
public ServerBuilder idleTimeout(Duration idleTimeout) {
requireNonNull(idleTimeout, "idleTimeout");
idleTimeoutMillis = validateIdleTimeoutMillis(idleTimeout.toMillis());
return this;
}
/**
* Sets the idle timeout of a connection for keep-alive and whether to prevent connection
* connection going idle when an HTTP/2 PING frame or {@code "OPTIONS * HTTP/1.1"} request is received.
*
* @param idleTimeout the timeout. {@code 0} disables the timeout.
* @param keepAliveOnPing whether to reset idle timeout on HTTP/2 PING frame, OPTIONS * request or not.
*/
@UnstableApi
public ServerBuilder idleTimeout(Duration idleTimeout, boolean keepAliveOnPing) {
requireNonNull(idleTimeout, "idleTimeout");
idleTimeoutMillis = validateIdleTimeoutMillis(idleTimeout.toMillis());
this.keepAliveOnPing = keepAliveOnPing;
return this;
}
/**
* Sets the HTTP/2 <a href="https://datatracker.ietf.org/doc/html/rfc7540#section-6.7">PING</a> interval.
*
* <p>Note that this settings is only in effect when {@link #idleTimeoutMillis(long)}} or
* {@link #idleTimeout(Duration)} is greater than the specified PING interval.
*
* <p>The minimum allowed PING interval is {@value #MIN_PING_INTERVAL_MILLIS} milliseconds.
* {@code 0} means the server will not send PING frames on an HTTP/2 connection.
*
* @throws IllegalArgumentException if the specified {@code pingIntervalMillis} is smaller than
* {@value #MIN_PING_INTERVAL_MILLIS} milliseconds.
*/
public ServerBuilder pingIntervalMillis(long pingIntervalMillis) {
checkArgument(pingIntervalMillis == 0 || pingIntervalMillis >= MIN_PING_INTERVAL_MILLIS,
"pingIntervalMillis: %s (expected: >= %s or == 0)", pingIntervalMillis,
MIN_PING_INTERVAL_MILLIS);
this.pingIntervalMillis = pingIntervalMillis;
return this;
}
/**
* Sets the HTTP/2 <a href="https://datatracker.ietf.org/doc/html/rfc7540#section-6.7">PING</a> interval.
*
* <p>Note that this settings is only in effect when {@link #idleTimeoutMillis(long)}} or
* {@link #idleTimeout(Duration)} is greater than the specified PING interval.
*
* <p>The minimum allowed PING interval is {@value #MIN_PING_INTERVAL_MILLIS} milliseconds.
* {@code 0} means the server will not send PING frames on an HTTP/2 connection.
*
* @throws IllegalArgumentException if the specified {@code pingInterval} is smaller than
* {@value #MIN_PING_INTERVAL_MILLIS} milliseconds.
*/
public ServerBuilder pingInterval(Duration pingInterval) {
pingIntervalMillis(requireNonNull(pingInterval, "pingInterval").toMillis());
return this;
}
/**
* Sets the maximum allowed age of a connection in millis for keep-alive. A connection is disconnected
* after the specified {@code maxConnectionAgeMillis} since the connection was established.
* This option is disabled by default, which means unlimited.
*
* @param maxConnectionAgeMillis the maximum connection age in millis. {@code 0} disables the limit.
* @throws IllegalArgumentException if the specified {@code maxConnectionAgeMillis} is smaller than
* {@value #MIN_MAX_CONNECTION_AGE_MILLIS} milliseconds.
*/
public ServerBuilder maxConnectionAgeMillis(long maxConnectionAgeMillis) {
checkArgument(maxConnectionAgeMillis >= MIN_MAX_CONNECTION_AGE_MILLIS || maxConnectionAgeMillis == 0,
"maxConnectionAgeMillis: %s (expected: >= %s or == 0)",
maxConnectionAgeMillis, MIN_MAX_CONNECTION_AGE_MILLIS);
this.maxConnectionAgeMillis = maxConnectionAgeMillis;
return this;
}
/**
* Sets the maximum allowed age of a connection for keep-alive. A connection is disconnected
* after the specified {@code maxConnectionAge} since the connection was established.
* This option is disabled by default, which means unlimited.
*
* @param maxConnectionAge the maximum connection age. {@code 0} disables the limit.
* @throws IllegalArgumentException if the specified {@code maxConnectionAge} is smaller than
* {@value #MIN_MAX_CONNECTION_AGE_MILLIS} milliseconds.
*/
public ServerBuilder maxConnectionAge(Duration maxConnectionAge) {
return maxConnectionAgeMillis(requireNonNull(maxConnectionAge, "maxConnectionAge").toMillis());
}
/**
* Sets the connection drain duration in micros for the connection shutdown.
* At the beginning of the connection drain server signals the clients that the connection shutdown is
* imminent but still accepts in flight requests.
* After the connection drain end server stops accepting new requests.
* Also, see {@link ServerBuilder#connectionDrainDuration(Duration)}.
*
* <p>
* Note that HTTP/1 doesn't support draining as described here, so for HTTP/1 drain duration
* is always {@code 0}, which means the connection will be closed immediately as soon as
* the current in-progress request is handled.
* </p>
*
* @param durationMicros the drain duration. {@code 0} disables the drain.
*/
public ServerBuilder connectionDrainDurationMicros(long durationMicros) {
checkArgument(connectionDrainDurationMicros >= 0,
"connectionDrainDurationMicros: %s (expected: >= 0)",
connectionDrainDurationMicros);
connectionDrainDurationMicros = durationMicros;
return this;
}
/**
* Sets the connection drain duration in micros for the connection shutdown.
* At the beginning of the connection drain server signals the clients that the connection shutdown is
* imminent but still accepts in flight requests.
* After the connection drain end server stops accepting new requests.
* Also, see {@link ServerBuilder#connectionDrainDurationMicros(long)}.
*
* <p>
* Note that HTTP/1 doesn't support draining as described here, so for HTTP/1 drain duration
* is always {@code 0}.
* </p>
*
* @param duration the drain period. {@code Duration.ZERO} or negative value disables the drain period.
*/
public ServerBuilder connectionDrainDuration(Duration duration) {
requireNonNull(duration, "duration");
return connectionDrainDurationMicros(TimeUnit.NANOSECONDS.toMicros(duration.toNanos()));
}
/**
* Sets the maximum allowed number of requests that can be served through one connection.
* This option is disabled by default, which means unlimited.
*
* @param maxNumRequestsPerConnection the maximum number of requests per connection.
* {@code 0} disables the limit.
*/
public ServerBuilder maxNumRequestsPerConnection(int maxNumRequestsPerConnection) {
this.maxNumRequestsPerConnection =
validateNonNegative(maxNumRequestsPerConnection, "maxNumRequestsPerConnection");
return this;
}
/**
* Sets the initial connection-level HTTP/2 flow control window size. Larger values can lower stream
* warmup time at the expense of being easier to overload the server. Defaults to
* {@link Flags#defaultHttp2InitialConnectionWindowSize()}.
* Note that this setting affects the connection-level window size, not the window size of streams.
*
* @see #http2InitialStreamWindowSize(int)
*/
public ServerBuilder http2InitialConnectionWindowSize(int http2InitialConnectionWindowSize) {
checkArgument(http2InitialConnectionWindowSize > 0,
"http2InitialConnectionWindowSize: %s (expected: > 0)",
http2InitialConnectionWindowSize);
this.http2InitialConnectionWindowSize = http2InitialConnectionWindowSize;
return this;
}
/**
* Sets the initial stream-level HTTP/2 flow control window size. Larger values can lower stream
* warmup time at the expense of being easier to overload the server. Defaults to
* {@link Flags#defaultHttp2InitialStreamWindowSize()}.
* Note that this setting affects the stream-level window size, not the window size of connections.
*
* @see #http2InitialConnectionWindowSize(int)
*/
public ServerBuilder http2InitialStreamWindowSize(int http2InitialStreamWindowSize) {
checkArgument(http2InitialStreamWindowSize > 0,
"http2InitialStreamWindowSize: %s (expected: > 0)",
http2InitialStreamWindowSize);
this.http2InitialStreamWindowSize = http2InitialStreamWindowSize;
return this;
}
/**
* Sets the maximum number of concurrent streams per HTTP/2 connection. Unset means there is
* no limit on the number of concurrent streams. Note, this differs from {@link #maxNumConnections()},
* which is the maximum number of HTTP/2 connections themselves, not the streams that are
* multiplexed over each.
*/
public ServerBuilder http2MaxStreamsPerConnection(long http2MaxStreamsPerConnection) {
checkArgument(http2MaxStreamsPerConnection > 0 &&
http2MaxStreamsPerConnection <= 0xFFFFFFFFL,
"http2MaxStreamsPerConnection: %s (expected: a positive 32-bit unsigned integer)",
http2MaxStreamsPerConnection);
this.http2MaxStreamsPerConnection = http2MaxStreamsPerConnection;
return this;
}
/**
* Sets the maximum number of RST frames that are allowed per window before the connection is closed. This
* allows to protect against the remote peer flooding us with such frames and using up a lot of CPU.
* Defaults to {@link Flags#defaultServerHttp2MaxResetFramesPerMinute()}.
*
* <p>Note that {@code 0} for any of the parameters means no protection should be applied.
*/
@UnstableApi
public ServerBuilder http2MaxResetFramesPerWindow(int http2MaxResetFramesPerWindow,
int http2MaxResetFramesWindowSeconds) {
checkArgument(http2MaxResetFramesPerWindow >= 0, "http2MaxResetFramesPerWindow: %s (expected: >= 0)",
http2MaxResetFramesPerWindow);
checkArgument(http2MaxResetFramesWindowSeconds >= 0,
"http2MaxResetFramesWindowSeconds: %s (expected: >= 0)",
http2MaxResetFramesWindowSeconds);
this.http2MaxResetFramesPerWindow = http2MaxResetFramesPerWindow;
this.http2MaxResetFramesWindowSeconds = http2MaxResetFramesWindowSeconds;
return this;
}
/**
* Sets the maximum size of HTTP/2 frame that can be received. Defaults to
* {@link Flags#defaultHttp2MaxFrameSize()}.
*/
public ServerBuilder http2MaxFrameSize(int http2MaxFrameSize) {
checkArgument(http2MaxFrameSize >= MAX_FRAME_SIZE_LOWER_BOUND &&
http2MaxFrameSize <= MAX_FRAME_SIZE_UPPER_BOUND,
"http2MaxFrameSize: %s (expected: >= %s and <= %s)",
http2MaxFrameSize, MAX_FRAME_SIZE_LOWER_BOUND, MAX_FRAME_SIZE_UPPER_BOUND);
this.http2MaxFrameSize = http2MaxFrameSize;
return this;
}
/**
* Sets the maximum size of headers that can be received. Defaults to
* {@link Flags#defaultHttp2MaxHeaderListSize()}.
*/
public ServerBuilder http2MaxHeaderListSize(long http2MaxHeaderListSize) {
checkArgument(http2MaxHeaderListSize > 0 &&
http2MaxHeaderListSize <= 0xFFFFFFFFL,
"http2MaxHeaderListSize: %s (expected: a positive 32-bit unsigned integer)",
http2MaxHeaderListSize);
this.http2MaxHeaderListSize = http2MaxHeaderListSize;
return this;
}
/**
* Sets the maximum length of an HTTP/1 response initial line.
*/
public ServerBuilder http1MaxInitialLineLength(int http1MaxInitialLineLength) {
this.http1MaxInitialLineLength = validateNonNegative(
http1MaxInitialLineLength, "http1MaxInitialLineLength");
return this;
}
/**
* Sets the maximum length of all headers in an HTTP/1 response.
*/
public ServerBuilder http1MaxHeaderSize(int http1MaxHeaderSize) {
this.http1MaxHeaderSize = validateNonNegative(http1MaxHeaderSize, "http1MaxHeaderSize");
return this;
}
/**
* Sets the maximum length of each chunk in an HTTP/1 response content.
* The content or a chunk longer than this value will be split into smaller chunks
* so that their lengths never exceed it.
*/
public ServerBuilder http1MaxChunkSize(int http1MaxChunkSize) {
this.http1MaxChunkSize = validateNonNegative(http1MaxChunkSize, "http1MaxChunkSize");
return this;
}
/**
* Sets the amount of time to wait after calling {@link Server#stop()} for
* requests to go away before actually shutting down.
*
* @param quietPeriodMillis the number of milliseconds to wait for active
* requests to go end before shutting down. 0 means the server will
* stop right away without waiting.
* @param timeoutMillis the number of milliseconds to wait before shutting down the server regardless of
* active requests. This should be set to a time greater than {@code quietPeriodMillis}
* to ensure the server shuts down even if there is a stuck request.
*/
public ServerBuilder gracefulShutdownTimeoutMillis(long quietPeriodMillis, long timeoutMillis) {
return gracefulShutdownTimeout(
Duration.ofMillis(quietPeriodMillis), Duration.ofMillis(timeoutMillis));
}
/**
* Sets the amount of time to wait after calling {@link Server#stop()} for
* requests to go away before actually shutting down.
*
* @param quietPeriod the number of milliseconds to wait for active
* requests to go end before shutting down. {@link Duration#ZERO} means
* the server will stop right away without waiting.
* @param timeout the amount of time to wait before shutting down the server regardless of active requests.
* This should be set to a time greater than {@code quietPeriod} to ensure the server
* shuts down even if there is a stuck request.
*/
public ServerBuilder gracefulShutdownTimeout(Duration quietPeriod, Duration timeout) {
requireNonNull(quietPeriod, "quietPeriod");
requireNonNull(timeout, "timeout");
gracefulShutdownQuietPeriod = validateNonNegative(quietPeriod, "quietPeriod");
gracefulShutdownTimeout = validateNonNegative(timeout, "timeout");
validateGreaterThanOrEqual(gracefulShutdownTimeout, "quietPeriod",
gracefulShutdownQuietPeriod, "timeout");
return this;
}
/**
* Sets the amount of time to wait before aborting an {@link HttpRequest} when
* its corresponding {@link HttpResponse} is complete.
* This may be useful when you want to receive additional data even after closing the response.
* Specify {@link Duration#ZERO} to abort the {@link HttpRequest} immediately. Any negative value will not
* abort the request automatically. There is no delay by default.
*/
@UnstableApi
public ServerBuilder requestAutoAbortDelay(Duration delay) {
return requestAutoAbortDelayMillis(requireNonNull(delay, "delay").toMillis());
}
/**
* Sets the amount of time in millis to wait before aborting an {@link HttpRequest} when
* its corresponding {@link HttpResponse} is complete.
* This may be useful when you want to receive additional data even after closing the response.
* Specify {@code 0} to abort the {@link HttpRequest} immediately. Any negative value will not
* abort the request automatically. There is no delay by default.
*/
@UnstableApi
public ServerBuilder requestAutoAbortDelayMillis(long delayMillis) {
virtualHostTemplate.requestAutoAbortDelayMillis(delayMillis);
return this;
}
/**
* Sets the {@link Path} for storing upload file through multipart/form-data.
*
* @param path the path of the directory stores the file.
*/
@UnstableApi
public ServerBuilder multipartUploadsLocation(Path path) {
requireNonNull(path, "path");
virtualHostTemplate.multipartUploadsLocation(path);
return this;
}
/**
* Sets the {@link ScheduledExecutorService} dedicated to the execution of blocking tasks or invocations.
* If not set, {@linkplain CommonPools#blockingTaskExecutor() the common pool} is used.
*
* @param shutdownOnStop whether to shut down the {@link ScheduledExecutorService} when the
* {@link Server} stops
*/
public ServerBuilder blockingTaskExecutor(ScheduledExecutorService blockingTaskExecutor,
boolean shutdownOnStop) {
requireNonNull(blockingTaskExecutor, "blockingTaskExecutor");
virtualHostTemplate.blockingTaskExecutor(blockingTaskExecutor, shutdownOnStop);
return this;
}
/**
* Sets the {@link BlockingTaskExecutor} dedicated to the execution of blocking tasks or invocations.
* If not set, {@linkplain CommonPools#blockingTaskExecutor() the common pool} is used.
*
* @param shutdownOnStop whether to shut down the {@link BlockingTaskExecutor} when the
* {@link Server} stops
*/
public ServerBuilder blockingTaskExecutor(BlockingTaskExecutor blockingTaskExecutor,
boolean shutdownOnStop) {
requireNonNull(blockingTaskExecutor, "blockingTaskExecutor");
virtualHostTemplate.blockingTaskExecutor(blockingTaskExecutor, shutdownOnStop);
return this;
}
/**
* Uses a newly created {@link BlockingTaskExecutor} with the specified number of threads dedicated to
* the execution of blocking tasks or invocations.
* The {@link BlockingTaskExecutor} will be shut down when the {@link Server} stops.
*
* @param numThreads the number of threads in the executor
*/
public ServerBuilder blockingTaskExecutor(int numThreads) {
checkArgument(numThreads >= 0, "numThreads: %s (expected: >= 0)", numThreads);
final BlockingTaskExecutor executor = BlockingTaskExecutor.builder()
.numThreads(numThreads)
.build();
return blockingTaskExecutor(executor, true);
}
/**
* Sets a {@link SuccessFunction} that determines whether a request was handled successfully or not.
* If unspecified, {@link SuccessFunction#ofDefault()} is used.
*/
@UnstableApi