-
Notifications
You must be signed in to change notification settings - Fork 595
/
headers.scala
1187 lines (1048 loc) · 52.2 KB
/
headers.scala
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 (C) 2009-2023 Lightbend Inc. <https://www.lightbend.com>
*/
package akka.http.scaladsl.model.headers
import java.lang.Iterable
import java.net.InetSocketAddress
import java.security.MessageDigest
import java.util
import javax.net.ssl.SSLSession
import akka.annotation.{ ApiMayChange, InternalApi }
import akka.stream.scaladsl.ScalaSessionAPI
import scala.collection.immutable.TreeMap
import scala.reflect.ClassTag
import scala.util.{ Failure, Success, Try }
import scala.annotation.tailrec
import scala.collection.immutable
import akka.parboiled2.util.Base64
import akka.event.Logging
import akka.http.ccompat.{ pre213, since213 }
import akka.http.impl.util._
import akka.http.impl.model.parser.CharacterClasses.`attr-char`
import akka.http.javadsl.{ model => jm }
import akka.http.scaladsl.model._
sealed abstract class ModeledCompanion[T: ClassTag] extends Renderable {
val name = ModeledCompanion.nameFromClass(getClass)
val lowercaseName = name.toRootLowerCase
private[this] val nameAndColonSpaceBytes = (name + ": ").asciiBytes
final def render[R <: Rendering](r: R): r.type = r ~~ nameAndColonSpaceBytes
/**
* Parses the given value into a header of this type. Returns `Right[T]` if parsing
* was successful and `Left(errors)` otherwise.
*/
def parseFromValueString(value: String): Either[List[ErrorInfo], T] =
HttpHeader.parse(name, value) match {
case HttpHeader.ParsingResult.Ok(header: T, Nil) => Right(header)
case res => Left(res.errors)
}
}
/** INTERNAL API */
@InternalApi
private[akka] object ModeledCompanion {
def nameFromClass[T](clazz: Class[T]): String = {
val name = {
val n = Logging.simpleName(clazz).replace("$minus", "-")
if (n.last == '$') n.dropRight(1) // drop trailing $
else n
}
val dollarIndex = name.indexOf('$')
if (dollarIndex != -1) name.drop(dollarIndex + 1)
else name
}
}
sealed trait ModeledHeader extends HttpHeader with Serializable {
def renderInRequests: Boolean = false // default implementation
def renderInResponses: Boolean = false // default implementation
def name: String = companion.name
private[this] var _value: String = _
def value: String = {
if (_value eq null) _value = renderValue(new StringRendering).get
_value
}
def lowercaseName: String = companion.lowercaseName
final def render[R <: Rendering](r: R): r.type = renderValue(companion.render(r))
protected[http] def renderValue[R <: Rendering](r: R): r.type
protected def companion: ModeledCompanion[_]
}
private[headers] sealed trait RequestHeader extends ModeledHeader { override def renderInRequests = true }
private[headers] sealed trait ResponseHeader extends ModeledHeader { override def renderInResponses = true }
private[headers] sealed trait RequestResponseHeader extends RequestHeader with ResponseHeader
private[headers] sealed trait SyntheticHeader extends ModeledHeader
/**
* Superclass for user-defined custom headers defined by implementing `name` and `value`.
*
* Prefer to extend [[ModeledCustomHeader]] and [[ModeledCustomHeaderCompanion]] instead if
* planning to use the defined header in match clauses (e.g. in the routing layer of Akka HTTP),
* as they allow the custom header to be matched from [[RawHeader]] and vice-versa.
*/
abstract class CustomHeader extends jm.headers.CustomHeader {
def lowercaseName: String = name.toRootLowerCase
final def render[R <: Rendering](r: R): r.type = r ~~ name ~~ ':' ~~ ' ' ~~ value
}
/**
* To be extended by companion object of a custom header extending [[ModeledCustomHeader]].
* Implements necessary apply and unapply methods to make the such defined header feel "native".
*/
abstract class ModeledCustomHeaderCompanion[H <: ModeledCustomHeader[H]] {
def name: String
private var _lowercaseName: String = _
def lowercaseName: String = {
if (_lowercaseName eq null) _lowercaseName = name.toRootLowerCase
_lowercaseName
}
def parse(value: String): Try[H]
def apply(value: String): H =
parse(value) match {
case Success(parsed) => parsed
case Failure(ex) => throw new IllegalArgumentException(s"Unable to construct custom header by parsing: '$value'", ex)
}
def unapply(h: HttpHeader): Option[String] = h match {
case _: RawHeader => if (h.lowercaseName == lowercaseName) Some(h.value) else None
case _: CustomHeader => if (h.lowercaseName == lowercaseName) Some(h.value) else None
case _ => None
}
final implicit val implicitlyLocatableCompanion: ModeledCustomHeaderCompanion[H] = this
}
/**
* Support class for building user-defined custom headers defined by implementing `name` and `value`.
* By implementing a [[ModeledCustomHeader]] instead of [[CustomHeader]] directly, all needed unapply
* methods are provided for this class, such that it can be pattern matched on from [[RawHeader]] and
* the other way around as well.
*/
abstract class ModeledCustomHeader[H <: ModeledCustomHeader[H]] extends CustomHeader { this: H =>
def companion: ModeledCustomHeaderCompanion[H]
final override def name = companion.name
final override def lowercaseName = companion.lowercaseName
}
import akka.http.impl.util.JavaMapping.Implicits._
// https://tools.ietf.org/html/rfc7231#section-5.3.2
object Accept extends ModeledCompanion[Accept] {
@pre213
def apply(mediaRanges: MediaRange*): Accept =
apply(immutable.Seq(mediaRanges: _*))
@since213
def apply(firstMediaRange: MediaRange, otherMediaRanges: MediaRange*): Accept =
apply(firstMediaRange +: otherMediaRanges)
implicit val mediaRangesRenderer: Renderer[immutable.Iterable[MediaRange]] = Renderer.defaultSeqRenderer[MediaRange] // cache
}
final case class Accept(mediaRanges: immutable.Seq[MediaRange]) extends jm.headers.Accept with RequestHeader {
import Accept.mediaRangesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ mediaRanges
protected def companion = Accept
def acceptsAll = mediaRanges.exists(mr => mr.isWildcard && mr.qValue > 0f)
/** Java API */
def getMediaRanges: Iterable[jm.MediaRange] = mediaRanges.asJava
}
// https://tools.ietf.org/html/rfc7231#section-5.3.3
object `Accept-Charset` extends ModeledCompanion[`Accept-Charset`] {
def apply(first: HttpCharsetRange, more: HttpCharsetRange*): `Accept-Charset` = apply(immutable.Seq(first +: more: _*))
implicit val charsetRangesRenderer: Renderer[immutable.Iterable[HttpCharsetRange]] = Renderer.defaultSeqRenderer[HttpCharsetRange] // cache
}
final case class `Accept-Charset`(charsetRanges: immutable.Seq[HttpCharsetRange]) extends jm.headers.AcceptCharset
with RequestHeader {
require(charsetRanges.nonEmpty, "charsetRanges must not be empty")
import `Accept-Charset`.charsetRangesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ charsetRanges
protected def companion = `Accept-Charset`
/** Java API */
def getCharsetRanges: Iterable[jm.HttpCharsetRange] = charsetRanges.asJava
}
// https://tools.ietf.org/html/rfc7231#section-5.3.4
object `Accept-Encoding` extends ModeledCompanion[`Accept-Encoding`] {
@pre213
def apply(encodings: HttpEncodingRange*): `Accept-Encoding` =
apply(immutable.Seq(encodings: _*))
@since213
def apply(): `Accept-Encoding` =
apply(immutable.Seq.empty)
@since213
def apply(firstEncoding: HttpEncodingRange, otherEncodings: HttpEncodingRange*): `Accept-Encoding` =
apply(firstEncoding +: otherEncodings)
implicit val encodingsRenderer: Renderer[immutable.Iterable[HttpEncodingRange]] = Renderer.defaultSeqRenderer[HttpEncodingRange] // cache
}
final case class `Accept-Encoding`(encodings: immutable.Seq[HttpEncodingRange]) extends jm.headers.AcceptEncoding
with RequestHeader {
import `Accept-Encoding`.encodingsRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ encodings
protected def companion = `Accept-Encoding`
/** Java API */
def getEncodings: Iterable[jm.headers.HttpEncodingRange] = encodings.asJava
}
// https://tools.ietf.org/html/rfc7231#section-5.3.5
object `Accept-Language` extends ModeledCompanion[`Accept-Language`] {
def apply(first: LanguageRange, more: LanguageRange*): `Accept-Language` = apply(immutable.Seq(first +: more: _*))
implicit val languagesRenderer: Renderer[immutable.Iterable[LanguageRange]] = Renderer.defaultSeqRenderer[LanguageRange] // cache
}
final case class `Accept-Language`(languages: immutable.Seq[LanguageRange]) extends jm.headers.AcceptLanguage
with RequestHeader {
require(languages.nonEmpty, "languages must not be empty")
import `Accept-Language`.languagesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ languages
protected def companion = `Accept-Language`
/** Java API */
def getLanguages: Iterable[jm.headers.LanguageRange] = languages.asJava
}
// https://tools.ietf.org/html/rfc7233#section-2.3
object `Accept-Ranges` extends ModeledCompanion[`Accept-Ranges`] {
@pre213
def apply(rangeUnits: RangeUnit*): `Accept-Ranges` =
apply(immutable.Seq(rangeUnits: _*))
@since213
def apply(): `Accept-Ranges` =
apply(immutable.Seq.empty)
@since213
def apply(firstRangeUnit: RangeUnit, otherRangeUnits: RangeUnit*): `Accept-Ranges` =
apply(firstRangeUnit +: otherRangeUnits)
implicit val rangeUnitsRenderer: Renderer[immutable.Iterable[RangeUnit]] = Renderer.defaultSeqRenderer[RangeUnit] // cache
}
final case class `Accept-Ranges`(rangeUnits: immutable.Seq[RangeUnit]) extends jm.headers.AcceptRanges
with ResponseHeader {
import `Accept-Ranges`.rangeUnitsRenderer
def renderValue[R <: Rendering](r: R): r.type = if (rangeUnits.isEmpty) r ~~ "none" else r ~~ rangeUnits
protected def companion = `Accept-Ranges`
/** Java API */
def getRangeUnits: Iterable[jm.headers.RangeUnit] = rangeUnits.asJava
}
// https://www.w3.org/TR/cors/#access-control-allow-credentials-response-header
object `Access-Control-Allow-Credentials` extends ModeledCompanion[`Access-Control-Allow-Credentials`]
final case class `Access-Control-Allow-Credentials`(allow: Boolean)
extends jm.headers.AccessControlAllowCredentials with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ allow.toString
protected def companion = `Access-Control-Allow-Credentials`
}
// https://www.w3.org/TR/cors/#access-control-allow-headers-response-header
object `Access-Control-Allow-Headers` extends ModeledCompanion[`Access-Control-Allow-Headers`] {
@pre213
def apply(headers: String*): `Access-Control-Allow-Headers` =
apply(immutable.Seq(headers: _*))
@since213
def apply(firstHeader: String, otherHeaders: String*): `Access-Control-Allow-Headers` =
apply(firstHeader +: otherHeaders)
implicit val headersRenderer: Renderer[immutable.Iterable[String]] = Renderer.defaultSeqRenderer[String] // cache
}
final case class `Access-Control-Allow-Headers`(headers: immutable.Seq[String])
extends jm.headers.AccessControlAllowHeaders with ResponseHeader {
import `Access-Control-Allow-Headers`.headersRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ headers
protected def companion = `Access-Control-Allow-Headers`
/** Java API */
def getHeaders: Iterable[String] = headers.asJava
}
// https://www.w3.org/TR/cors/#access-control-allow-methods-response-header
object `Access-Control-Allow-Methods` extends ModeledCompanion[`Access-Control-Allow-Methods`] {
@pre213
def apply(methods: HttpMethod*): `Access-Control-Allow-Methods` =
apply(immutable.Seq(methods: _*))
@since213
def apply(firstMethod: HttpMethod, otherMethods: HttpMethod*): `Access-Control-Allow-Methods` =
apply(firstMethod +: otherMethods)
implicit val methodsRenderer: Renderer[immutable.Iterable[HttpMethod]] = Renderer.defaultSeqRenderer[HttpMethod] // cache
}
final case class `Access-Control-Allow-Methods`(methods: immutable.Seq[HttpMethod])
extends jm.headers.AccessControlAllowMethods with ResponseHeader {
import `Access-Control-Allow-Methods`.methodsRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ methods
protected def companion = `Access-Control-Allow-Methods`
/** Java API */
def getMethods: Iterable[jm.HttpMethod] = methods.asJava
}
// https://www.w3.org/TR/cors/#access-control-allow-origin-response-header
object `Access-Control-Allow-Origin` extends ModeledCompanion[`Access-Control-Allow-Origin`] {
val `*`: `Access-Control-Allow-Origin` = forRange(HttpOriginRange.`*`)
val `null`: `Access-Control-Allow-Origin` = forRange(HttpOriginRange())
def apply(origin: HttpOrigin) = forRange(HttpOriginRange(origin))
/**
* Creates an `Access-Control-Allow-Origin` header for the given origin range.
*
* CAUTION: Even though allowed by the spec (https://www.w3.org/TR/cors/#access-control-allow-origin-response-header)
* `Access-Control-Allow-Origin` headers with more than a single origin appear to be largely unsupported in the field.
* Make sure to thoroughly test such usages with all expected clients!
*/
def forRange(range: HttpOriginRange) = new `Access-Control-Allow-Origin`(range)
}
final case class `Access-Control-Allow-Origin` private (range: HttpOriginRange)
extends jm.headers.AccessControlAllowOrigin with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ range
protected def companion = `Access-Control-Allow-Origin`
}
// https://www.w3.org/TR/cors/#access-control-expose-headers-response-header
object `Access-Control-Expose-Headers` extends ModeledCompanion[`Access-Control-Expose-Headers`] {
@pre213
def apply(headers: String*): `Access-Control-Expose-Headers` =
apply(immutable.Seq(headers: _*))
@since213
def apply(firstHeader: String, otherHeaders: String*): `Access-Control-Expose-Headers` =
apply(firstHeader +: otherHeaders)
implicit val headersRenderer: Renderer[immutable.Iterable[String]] = Renderer.defaultSeqRenderer[String] // cache
}
final case class `Access-Control-Expose-Headers`(headers: immutable.Seq[String])
extends jm.headers.AccessControlExposeHeaders with ResponseHeader {
import `Access-Control-Expose-Headers`.headersRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ headers
protected def companion = `Access-Control-Expose-Headers`
/** Java API */
def getHeaders: Iterable[String] = headers.asJava
}
// https://www.w3.org/TR/cors/#access-control-max-age-response-header
object `Access-Control-Max-Age` extends ModeledCompanion[`Access-Control-Max-Age`]
final case class `Access-Control-Max-Age`(deltaSeconds: Long) extends jm.headers.AccessControlMaxAge
with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ deltaSeconds
protected def companion = `Access-Control-Max-Age`
}
// https://www.w3.org/TR/cors/#access-control-request-headers-request-header
object `Access-Control-Request-Headers` extends ModeledCompanion[`Access-Control-Request-Headers`] {
@pre213
def apply(headers: String*): `Access-Control-Request-Headers` =
apply(immutable.Seq(headers: _*))
@since213
def apply(firstHeader: String, otherHeaders: String*): `Access-Control-Request-Headers` =
apply(firstHeader +: otherHeaders)
implicit val headersRenderer: Renderer[immutable.Iterable[String]] = Renderer.defaultSeqRenderer[String] // cache
}
final case class `Access-Control-Request-Headers`(headers: immutable.Seq[String])
extends jm.headers.AccessControlRequestHeaders with RequestHeader {
import `Access-Control-Request-Headers`.headersRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ headers
protected def companion = `Access-Control-Request-Headers`
/** Java API */
def getHeaders: Iterable[String] = headers.asJava
}
// https://www.w3.org/TR/cors/#access-control-request-method-request-header
object `Access-Control-Request-Method` extends ModeledCompanion[`Access-Control-Request-Method`]
final case class `Access-Control-Request-Method`(method: HttpMethod) extends jm.headers.AccessControlRequestMethod
with RequestHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ method
protected def companion = `Access-Control-Request-Method`
}
// https://tools.ietf.org/html/rfc7234#section-5.1
object Age extends ModeledCompanion[Age]
final case class Age(deltaSeconds: Long) extends jm.headers.Age with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ deltaSeconds
protected def companion = Age
}
// https://tools.ietf.org/html/rfc7231#section-7.4.1
object Allow extends ModeledCompanion[Allow] {
@pre213
def apply(methods: HttpMethod*): Allow =
apply(immutable.Seq(methods: _*))
@since213
def apply(): `Allow` =
apply(immutable.Seq.empty)
@since213
def apply(firstMethod: HttpMethod, otherMethods: HttpMethod*): Allow =
apply(firstMethod +: otherMethods)
implicit val methodsRenderer: Renderer[immutable.Iterable[HttpMethod]] = Renderer.defaultSeqRenderer[HttpMethod] // cache
}
final case class Allow(methods: immutable.Seq[HttpMethod]) extends jm.headers.Allow with ResponseHeader {
import Allow.methodsRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ methods
protected def companion = Allow
/** Java API */
def getMethods: Iterable[jm.HttpMethod] = methods.asJava
}
// https://tools.ietf.org/html/rfc7235#section-4.2
object Authorization extends ModeledCompanion[Authorization]
final case class Authorization(credentials: HttpCredentials) extends jm.headers.Authorization with RequestHeader
with SensitiveHttpHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ credentials
protected def companion = Authorization
}
// https://tools.ietf.org/html/rfc7234#section-5.2
object `Cache-Control` extends ModeledCompanion[`Cache-Control`] {
def apply(first: CacheDirective, more: CacheDirective*): `Cache-Control` = apply(immutable.Seq(first +: more: _*))
implicit val directivesRenderer: Renderer[immutable.Iterable[CacheDirective]] = Renderer.defaultSeqRenderer[CacheDirective] // cache
}
final case class `Cache-Control`(directives: immutable.Seq[CacheDirective]) extends jm.headers.CacheControl
with RequestResponseHeader {
require(directives.nonEmpty, "directives must not be empty")
import `Cache-Control`.directivesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ directives
protected def companion = `Cache-Control`
/** Java API */
def getDirectives: Iterable[jm.headers.CacheDirective] = directives.asJava
}
// https://tools.ietf.org/html/rfc7230#section-6.1
object Connection extends ModeledCompanion[Connection] {
def apply(first: String, more: String*): Connection = apply(immutable.Seq(first +: more: _*))
implicit val tokensRenderer: Renderer[immutable.Iterable[String]] = Renderer.defaultSeqRenderer[String] // cache
}
final case class Connection(tokens: immutable.Seq[String]) extends jm.headers.Connection
with RequestResponseHeader {
require(tokens.nonEmpty, "tokens must not be empty")
import Connection.tokensRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ tokens
def hasClose = has("close")
def hasKeepAlive = has("keep-alive")
def hasUpgrade = has("upgrade")
def append(tokens: immutable.Seq[String]) = Connection(this.tokens ++ tokens)
@tailrec private def has(item: String, ix: Int = 0): Boolean =
if (ix < tokens.length)
if (tokens(ix) equalsIgnoreCase item) true
else has(item, ix + 1)
else false
protected def companion = Connection
/** Java API */
def getTokens: Iterable[String] = tokens.asJava
}
// https://tools.ietf.org/html/rfc7230#section-3.3.2
object `Content-Length` extends ModeledCompanion[`Content-Length`]
/**
* Instances of this class will only be created transiently during header parsing and will never appear
* in HttpMessage.header. To access the Content-Length, see subclasses of HttpEntity.
*/
final case class `Content-Length` private[http] (length: Long) extends jm.headers.ContentLength
with RequestResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ length
protected def companion = `Content-Length`
}
// https://tools.ietf.org/html/rfc7231#section-3.1.4.2
object `Content-Location` extends ModeledCompanion[`Content-Location`]
final case class `Content-Location`(uri: Uri) extends jm.headers.ContentLocation with ResponseHeader {
require(uri.fragment.isEmpty, "Content-Location header URI must not contain a fragment")
require(uri.authority.userinfo.isEmpty, "Content-Location header URI must not contain a userinfo component")
def renderValue[R <: Rendering](r: R): r.type = { import UriRendering.UriRenderer; r ~~ uri }
protected def companion = `Content-Location`
/** Java API */
def getUri: akka.http.javadsl.model.Uri = uri.asJava
}
/**
* Document https://tools.ietf.org/html/rfc6266 updates document https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html . Between these
* two there is slight but important difference regarding how parameter values are formatted. In RFC6266 parameters values are without quotes and
* in RFC2616 they are quoted. Since common practice among http servers is to understand quoted values, we use older document
* as reference here.
* Extended (i.e. encoded) parameter values are not quoted, see ext-parameter - https://tools.ietf.org/html/rfc5987#section-3.2.1
*
* Note: Akka HTTP uses "filename" key to store filename and handles encoding/decoding automatically.
* To output customized ASCII fallback version of filename provide "filename*" for unicode and "filename" for ASCII.
*/
object `Content-Disposition` extends ModeledCompanion[`Content-Disposition`]
final case class `Content-Disposition`(dispositionType: ContentDispositionType, params: Map[String, String] = Map.empty)
extends jm.headers.ContentDisposition with RequestResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = {
import Rendering.{ contentDispositionFilenameSafeChars => safeChars }
r ~~ dispositionType
val renderExtFilename =
params.get("filename").exists(!safeChars.matchesAll(_))
val withExtParams =
if (renderExtFilename && !params.contains("filename*"))
params + ("filename*" -> params("filename"))
else params
// it is advised that "filename" should occur first - https://tools.ietf.org/html/rfc6266#appendix-D
val withExtParamsSorted =
if (withExtParams.contains("filename") && withExtParams.contains("filename*"))
TreeMap[String, String]() ++ withExtParams
else withExtParams
withExtParamsSorted foreach {
case (k, v) if k == "filename" =>
r ~~ "; " ~~ k ~~ '=' ~~ '"'
r.putReplaced(v, keep = safeChars, placeholder = '?') ~~ '"'
case (k, v) if k endsWith "*" =>
r ~~ "; " ~~ k ~~ '=' ~~ "UTF-8''"
UriRendering.encode(r, v, UTF8, keep = `attr-char`, replaceSpaces = false)
case (k, v) => r ~~ "; " ~~ k ~~ '=' ~~#! v
}
r
}
protected def companion = `Content-Disposition`
/** Java API */
def getParams: util.Map[String, String] = params.asJava
}
// https://tools.ietf.org/html/rfc7231#section-3.1.2.2
object `Content-Encoding` extends ModeledCompanion[`Content-Encoding`] {
def apply(first: HttpEncoding, more: HttpEncoding*): `Content-Encoding` = apply(immutable.Seq(first +: more: _*))
implicit val encodingsRenderer: Renderer[immutable.Iterable[HttpEncoding]] = Renderer.defaultSeqRenderer[HttpEncoding] // cache
}
final case class `Content-Encoding`(encodings: immutable.Seq[HttpEncoding]) extends jm.headers.ContentEncoding
with RequestResponseHeader {
require(encodings.nonEmpty, "encodings must not be empty")
import `Content-Encoding`.encodingsRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ encodings
protected def companion = `Content-Encoding`
/** Java API */
def getEncodings: Iterable[jm.headers.HttpEncoding] = encodings.asJava
}
// https://tools.ietf.org/html/rfc7233#section-4.2
object `Content-Range` extends ModeledCompanion[`Content-Range`] {
def apply(byteContentRange: ByteContentRange): `Content-Range` = apply(RangeUnits.Bytes, byteContentRange)
}
final case class `Content-Range`(rangeUnit: RangeUnit, contentRange: ContentRange) extends jm.headers.ContentRange
with RequestResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ rangeUnit ~~ ' ' ~~ contentRange
protected def companion = `Content-Range`
}
// https://tools.ietf.org/html/rfc7231#section-3.1.1.5
object `Content-Type` extends ModeledCompanion[`Content-Type`]
/**
* Instances of this class will only be created transiently during header parsing and will never appear
* in HttpMessage.header. To access the Content-Type, see subclasses of HttpEntity.
*/
final case class `Content-Type` private[http] (contentType: ContentType) extends jm.headers.ContentType
with RequestResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ contentType
protected def companion = `Content-Type`
}
// https://tools.ietf.org/html/rfc6265#section-4.2
object Cookie extends ModeledCompanion[Cookie] {
def apply(first: HttpCookiePair, more: HttpCookiePair*): Cookie = apply(immutable.Seq(first +: more: _*))
def apply(name: String, value: String): Cookie = apply(HttpCookiePair(name, value))
@pre213
def apply(values: (String, String)*): Cookie = apply(values.map(HttpCookiePair(_)).toList)
@since213
def apply(first: (String, String), more: (String, String)*): Cookie = apply((first +: more).map(HttpCookiePair(_)))
implicit val cookiePairsRenderer: Renderer[immutable.Iterable[HttpCookiePair]] = Renderer.seqRenderer[HttpCookiePair](separator = "; ") // cache
}
final case class Cookie(cookies: immutable.Seq[HttpCookiePair]) extends jm.headers.Cookie with RequestHeader
with SensitiveHttpHeader {
require(cookies.nonEmpty, "cookies must not be empty")
import Cookie.cookiePairsRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ cookies
protected def companion = Cookie
/** Java API */
def getCookies: Iterable[jm.headers.HttpCookiePair] = cookies.asJava
}
// https://tools.ietf.org/html/rfc7231#section-7.1.1.2
object Date extends ModeledCompanion[Date]
final case class Date(date: DateTime) extends jm.headers.Date with RequestResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = date.renderRfc1123DateTimeString(r)
protected def companion = Date
}
/**
* INTERNAL API
*/
@InternalApi
private[headers] object EmptyCompanion extends ModeledCompanion[EmptyHeader.type]
/**
* INTERNAL API
*/
@InternalApi
private[http] object EmptyHeader extends SyntheticHeader {
def renderValue[R <: Rendering](r: R): r.type = r
protected def companion: ModeledCompanion[EmptyHeader.type] = EmptyCompanion
}
// https://tools.ietf.org/html/rfc7232#section-2.3
object ETag extends ModeledCompanion[ETag] {
def apply(tag: String, weak: Boolean = false): ETag = ETag(EntityTag(tag, weak))
}
final case class ETag(etag: EntityTag) extends jm.headers.ETag with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ etag
protected def companion = ETag
}
// https://tools.ietf.org/html/rfc7231#section-5.1.1
object Expect extends ModeledCompanion[Expect] {
val `100-continue` = new Expect() {}
}
sealed abstract case class Expect private () extends RequestHeader {
final def renderValue[R <: Rendering](r: R): r.type = r ~~ "100-continue"
protected def companion = Expect
}
// https://tools.ietf.org/html/rfc7234#section-5.3
object Expires extends ModeledCompanion[Expires]
final case class Expires(date: DateTime) extends jm.headers.Expires with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = date.renderRfc1123DateTimeString(r)
protected def companion = Expires
}
// https://tools.ietf.org/html/rfc7230#section-5.4
object Host extends ModeledCompanion[Host] {
def apply(authority: Uri.Authority): Host = apply(authority.host, authority.port)
def apply(address: InetSocketAddress): Host = apply(address.getHostString, address.getPort)
def apply(host: String): Host = apply(host, 0)
def apply(host: String, port: Int): Host = apply(Uri.Host(host), port)
val empty = Host("")
}
final case class Host(host: Uri.Host, port: Int = 0) extends jm.headers.Host with RequestHeader
with SensitiveHttpHeader {
import UriRendering.HostRenderer
require((port >> 16) == 0, "Illegal port: " + port)
def isEmpty = host.isEmpty
def renderValue[R <: Rendering](r: R): r.type = if (port > 0) r ~~ host ~~ ':' ~~ port else r ~~ host
protected def companion = Host
def equalsIgnoreCase(other: Host): Boolean = host.equalsIgnoreCase(other.host) && port == other.port
}
// https://tools.ietf.org/html/rfc7232#section-3.1
object `If-Match` extends ModeledCompanion[`If-Match`] {
val `*` = `If-Match`(EntityTagRange.`*`)
def apply(first: EntityTag, more: EntityTag*): `If-Match` =
`If-Match`(EntityTagRange(first +: more: _*))
}
final case class `If-Match`(m: EntityTagRange) extends jm.headers.IfMatch with RequestHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ m
protected def companion = `If-Match`
}
// https://tools.ietf.org/html/rfc7232#section-3.3
object `If-Modified-Since` extends ModeledCompanion[`If-Modified-Since`]
final case class `If-Modified-Since`(date: DateTime) extends jm.headers.IfModifiedSince with RequestHeader {
def renderValue[R <: Rendering](r: R): r.type = date.renderRfc1123DateTimeString(r)
protected def companion = `If-Modified-Since`
}
// https://tools.ietf.org/html/rfc7232#section-3.2
object `If-None-Match` extends ModeledCompanion[`If-None-Match`] {
val `*` = `If-None-Match`(EntityTagRange.`*`)
def apply(first: EntityTag, more: EntityTag*): `If-None-Match` =
`If-None-Match`(EntityTagRange(first +: more: _*))
}
final case class `If-None-Match`(m: EntityTagRange) extends jm.headers.IfNoneMatch with RequestHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ m
protected def companion = `If-None-Match`
}
// https://tools.ietf.org/html/rfc7233#section-3.2
object `If-Range` extends ModeledCompanion[`If-Range`] {
def apply(tag: EntityTag): `If-Range` = apply(Left(tag))
def apply(timestamp: DateTime): `If-Range` = apply(Right(timestamp))
}
final case class `If-Range`(entityTagOrDateTime: Either[EntityTag, DateTime]) extends RequestHeader {
def renderValue[R <: Rendering](r: R): r.type =
entityTagOrDateTime match {
case Left(tag) => r ~~ tag
case Right(dateTime) => dateTime.renderRfc1123DateTimeString(r)
}
protected def companion = `If-Range`
}
// https://tools.ietf.org/html/rfc7232#section-3.4
object `If-Unmodified-Since` extends ModeledCompanion[`If-Unmodified-Since`]
final case class `If-Unmodified-Since`(date: DateTime) extends jm.headers.IfUnmodifiedSince with RequestHeader {
def renderValue[R <: Rendering](r: R): r.type = date.renderRfc1123DateTimeString(r)
protected def companion = `If-Unmodified-Since`
}
// https://www.w3.org/TR/eventsource/#last-event-id
object `Last-Event-ID` extends ModeledCompanion[`Last-Event-ID`]
final case class `Last-Event-ID`(id: String) extends jm.headers.LastEventId with RequestHeader {
override protected[http] def renderValue[R <: Rendering](r: R): r.type = r ~~ id
override protected def companion = `Last-Event-ID`
}
// https://tools.ietf.org/html/rfc7232#section-2.2
object `Last-Modified` extends ModeledCompanion[`Last-Modified`]
final case class `Last-Modified`(date: DateTime) extends jm.headers.LastModified with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = date.renderRfc1123DateTimeString(r)
protected def companion = `Last-Modified`
}
// https://tools.ietf.org/html/rfc5988#section-5
object Link extends ModeledCompanion[Link] {
def apply(uri: Uri, first: LinkParam, more: LinkParam*): Link = apply(immutable.Seq(LinkValue(uri, first +: more.toList)))
@pre213
def apply(values: LinkValue*): Link = apply(immutable.Seq(values: _*))
@since213
def apply(firstValue: LinkValue, otherValues: LinkValue*): Link = apply(firstValue +: otherValues)
implicit val valuesRenderer: Renderer[immutable.Iterable[LinkValue]] = Renderer.defaultSeqRenderer[LinkValue] // cache
}
final case class Link(values: immutable.Seq[LinkValue]) extends jm.headers.Link with RequestResponseHeader {
import Link.valuesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ values
protected def companion = Link
/** Java API */
def getValues: Iterable[jm.headers.LinkValue] = values.asJava
}
// https://tools.ietf.org/html/rfc7231#section-7.1.2
object Location extends ModeledCompanion[Location]
final case class Location(uri: Uri) extends jm.headers.Location with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = { import UriRendering.UriRenderer; r ~~ uri }
protected def companion = Location
/** Java API */
def getUri: akka.http.javadsl.model.Uri = uri.asJava
}
// https://tools.ietf.org/html/rfc6454#section-7
object Origin extends ModeledCompanion[Origin] {
@pre213
def apply(origins: HttpOrigin*): Origin = apply(immutable.Seq(origins: _*))
@since213
def apply(firstOrigin: HttpOrigin, otherOrigins: HttpOrigin*): Origin = apply(firstOrigin +: otherOrigins)
}
final case class Origin(origins: immutable.Seq[HttpOrigin]) extends jm.headers.Origin with RequestHeader
with SensitiveHttpHeader {
def renderValue[R <: Rendering](r: R): r.type = if (origins.isEmpty) r ~~ "null" else r ~~ origins
protected def companion = Origin
/** Java API */
def getOrigins: Iterable[jm.headers.HttpOrigin] = origins.asJava
}
// https://tools.ietf.org/html/rfc7235#section-4.3
object `Proxy-Authenticate` extends ModeledCompanion[`Proxy-Authenticate`] {
def apply(first: HttpChallenge, more: HttpChallenge*): `Proxy-Authenticate` = apply(immutable.Seq(first +: more: _*))
implicit val challengesRenderer: Renderer[immutable.Iterable[HttpChallenge]] = Renderer.defaultSeqRenderer[HttpChallenge] // cache
}
final case class `Proxy-Authenticate`(challenges: immutable.Seq[HttpChallenge]) extends jm.headers.ProxyAuthenticate
with ResponseHeader {
require(challenges.nonEmpty, "challenges must not be empty")
import `Proxy-Authenticate`.challengesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ challenges
protected def companion = `Proxy-Authenticate`
/** Java API */
def getChallenges: Iterable[jm.headers.HttpChallenge] = challenges.asJava
}
// https://tools.ietf.org/html/rfc7235#section-4.4
object `Proxy-Authorization` extends ModeledCompanion[`Proxy-Authorization`]
final case class `Proxy-Authorization`(credentials: HttpCredentials) extends jm.headers.ProxyAuthorization
with RequestHeader with SensitiveHttpHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ credentials
protected def companion = `Proxy-Authorization`
}
// https://tools.ietf.org/html/rfc7233#section-3.1
object Range extends ModeledCompanion[Range] {
def apply(first: ByteRange, more: ByteRange*): Range = apply(immutable.Seq(first +: more: _*))
def apply(ranges: immutable.Seq[ByteRange]): Range = Range(RangeUnits.Bytes, ranges)
implicit val rangesRenderer: Renderer[immutable.Iterable[ByteRange]] = Renderer.defaultSeqRenderer[ByteRange] // cache
}
final case class Range(rangeUnit: RangeUnit, ranges: immutable.Seq[ByteRange]) extends jm.headers.Range
with RequestHeader {
require(ranges.nonEmpty, "ranges must not be empty")
import Range.rangesRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ rangeUnit ~~ '=' ~~ ranges
protected def companion = Range
/** Java API */
def getRanges: Iterable[jm.headers.ByteRange] = ranges.asJava
}
final case class RawHeader(name: String, value: String) extends jm.headers.RawHeader {
if (name == null) throw new IllegalArgumentException("name must not be null")
if (value == null) throw new IllegalArgumentException("value must not be null")
def renderInRequests = true
def renderInResponses = true
val lowercaseName = name.toRootLowerCase
def render[R <: Rendering](r: R): r.type = r ~~ name ~~ ':' ~~ ' ' ~~ value
}
object RawHeader {
def unapply[H <: HttpHeader](customHeader: H): Option[(String, String)] =
Some(customHeader.name -> customHeader.value)
}
object `Raw-Request-URI` extends ModeledCompanion[`Raw-Request-URI`]
final case class `Raw-Request-URI`(uri: String) extends jm.headers.RawRequestURI with SyntheticHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ uri
protected def companion = `Raw-Request-URI`
}
@deprecated("use remote-address-attribute instead", since = "10.2.0")
object `Remote-Address` extends ModeledCompanion[`Remote-Address`]
@deprecated("use remote-address-attribute instead", since = "10.2.0")
final case class `Remote-Address`(address: RemoteAddress) extends jm.headers.RemoteAddress with SyntheticHeader
with SensitiveHttpHeader {
def renderValue[R <: Rendering](r: R): r.type = r ~~ address
protected def companion = `Remote-Address`
}
// https://tools.ietf.org/html/rfc7231#section-5.5.2
object Referer extends ModeledCompanion[Referer]
final case class Referer(uri: Uri) extends jm.headers.Referer with RequestHeader with SensitiveHttpHeader {
require(uri.fragment.isEmpty, "Referer header URI must not contain a fragment")
require(uri.authority.userinfo.isEmpty, "Referer header URI must not contain a userinfo component")
def renderValue[R <: Rendering](r: R): r.type = { import UriRendering.UriRenderer; r ~~ uri }
protected def companion = Referer
/** Java API */
def getUri: akka.http.javadsl.model.Uri = uri.asJava
}
object `Retry-After` extends ModeledCompanion[`Retry-After`] {
def apply(delaySeconds: Long): `Retry-After` = apply(RetryAfterDuration(delaySeconds))
def apply(timestamp: DateTime): `Retry-After` = apply(RetryAfterDateTime(timestamp))
}
final case class `Retry-After`(delaySecondsOrDateTime: RetryAfterParameter) extends jm.headers.RetryAfter with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = delaySecondsOrDateTime match {
case RetryAfterDuration(delay) => r ~~ delay
case RetryAfterDateTime(dateTime) => dateTime.renderRfc1123DateTimeString(r)
}
protected def companion = `Retry-After`
/** Java API suppport */
override protected def delaySeconds(): Option[java.lang.Long] = PartialFunction.condOpt(delaySecondsOrDateTime) {
case RetryAfterDuration(delay) => Long.box(delay)
}
override protected def dateTime(): Option[DateTime] = PartialFunction.condOpt(delaySecondsOrDateTime) {
case RetryAfterDateTime(dateTime) => dateTime
}
}
/**
* INTERNAL API
*/
// https://tools.ietf.org/html/rfc6455#section-4.3
@InternalApi
private[http] object `Sec-WebSocket-Accept` extends ModeledCompanion[`Sec-WebSocket-Accept`] {
// Defined at https://tools.ietf.org/html/rfc6455#section-4.2.2
val MagicGuid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
/** Generates the matching accept header for this key */
def forKey(key: `Sec-WebSocket-Key`): `Sec-WebSocket-Accept` = {
val sha1 = MessageDigest.getInstance("sha1")
val salted = key.key + MagicGuid
val hash = sha1.digest(salted.asciiBytes)
val acceptKey = Base64.rfc2045().encodeToString(hash, false)
`Sec-WebSocket-Accept`(acceptKey)
}
}
/**
* INTERNAL API
*/
@InternalApi
private[http] final case class `Sec-WebSocket-Accept`(key: String) extends ResponseHeader {
protected[http] def renderValue[R <: Rendering](r: R): r.type = r ~~ key
protected def companion = `Sec-WebSocket-Accept`
}
/**
* INTERNAL API
*/
// https://tools.ietf.org/html/rfc6455#section-4.3
@InternalApi
private[http] object `Sec-WebSocket-Extensions` extends ModeledCompanion[`Sec-WebSocket-Extensions`] {
implicit val extensionsRenderer: Renderer[immutable.Iterable[WebSocketExtension]] = Renderer.defaultSeqRenderer[WebSocketExtension]
}
/**
* INTERNAL API
*/
@InternalApi
private[http] final case class `Sec-WebSocket-Extensions`(extensions: immutable.Seq[WebSocketExtension])
extends RequestResponseHeader {
require(extensions.nonEmpty, "Sec-WebSocket-Extensions.extensions must not be empty")
import `Sec-WebSocket-Extensions`.extensionsRenderer
protected[http] def renderValue[R <: Rendering](r: R): r.type = r ~~ extensions
protected def companion = `Sec-WebSocket-Extensions`
}
// https://tools.ietf.org/html/rfc6455#section-4.3
/**
* INTERNAL API
*/
@InternalApi
private[http] object `Sec-WebSocket-Key` extends ModeledCompanion[`Sec-WebSocket-Key`] {
def apply(keyBytes: Array[Byte]): `Sec-WebSocket-Key` = {
require(keyBytes.length == 16, s"Sec-WebSocket-Key keyBytes must have length 16 but had ${keyBytes.length}")
`Sec-WebSocket-Key`(Base64.rfc2045().encodeToString(keyBytes, false))
}
}
/**
* INTERNAL API
*/
@InternalApi
private[http] final case class `Sec-WebSocket-Key`(key: String) extends RequestHeader {
protected[http] def renderValue[R <: Rendering](r: R): r.type = r ~~ key
protected def companion = `Sec-WebSocket-Key`
/**
* Checks if the key value is valid according to the WebSocket specification, i.e.
* if the String is a Base64 representation of 16 bytes.
*/
def isValid: Boolean = Try(Base64.rfc2045().decode(key)).toOption.exists(_.length == 16)
}
// https://tools.ietf.org/html/rfc6455#section-4.3
/**
* INTERNAL API
*/
@InternalApi
private[http] object `Sec-WebSocket-Protocol` extends ModeledCompanion[`Sec-WebSocket-Protocol`] {
implicit val protocolsRenderer: Renderer[immutable.Iterable[String]] = Renderer.defaultSeqRenderer[String]
}
/**
* INTERNAL API
*/
@InternalApi
private[http] final case class `Sec-WebSocket-Protocol`(protocols: immutable.Seq[String])
extends jm.headers.SecWebSocketProtocol with RequestResponseHeader {
require(protocols.nonEmpty, "Sec-WebSocket-Protocol.protocols must not be empty")
import `Sec-WebSocket-Protocol`.protocolsRenderer
protected[http] def renderValue[R <: Rendering](r: R): r.type = r ~~ protocols
protected def companion = `Sec-WebSocket-Protocol`
/** Java API */
override def getProtocols: Iterable[String] = protocols.asJava
}
// https://tools.ietf.org/html/rfc6455#section-4.3
/**
* INTERNAL API
*/
@InternalApi
private[http] object `Sec-WebSocket-Version` extends ModeledCompanion[`Sec-WebSocket-Version`] {
implicit val versionsRenderer: Renderer[immutable.Iterable[Int]] = Renderer.defaultSeqRenderer[Int]
}
/**
* INTERNAL API
*/
@InternalApi
private[http] final case class `Sec-WebSocket-Version`(versions: immutable.Seq[Int])
extends RequestResponseHeader {
require(versions.nonEmpty, "Sec-WebSocket-Version.versions must not be empty")
require(versions.forall(v => v >= 0 && v <= 255), s"Sec-WebSocket-Version.versions must be in the range 0 <= version <= 255 but were $versions")
import `Sec-WebSocket-Version`.versionsRenderer
protected[http] def renderValue[R <: Rendering](r: R): r.type = r ~~ versions
def hasVersion(versionNumber: Int): Boolean = versions contains versionNumber
protected def companion = `Sec-WebSocket-Version`
}
// https://tools.ietf.org/html/rfc7231#section-7.4.2
object Server extends ModeledCompanion[Server] {
def apply(products: String): Server = apply(ProductVersion.parseMultiple(products))
def apply(first: ProductVersion, more: ProductVersion*): Server = apply(immutable.Seq(first +: more: _*))
implicit val productsRenderer: Renderer[immutable.Iterable[ProductVersion]] = Renderer.seqRenderer[ProductVersion](separator = " ") // cache
}
final case class Server(products: immutable.Seq[ProductVersion]) extends jm.headers.Server with ResponseHeader {
require(products.nonEmpty, "products must not be empty")
import Server.productsRenderer
def renderValue[R <: Rendering](r: R): r.type = r ~~ products
protected def companion = Server
/** Java API */
def getProducts: Iterable[jm.headers.ProductVersion] = products.asJava
}
// https://tools.ietf.org/html/rfc6797
object `Strict-Transport-Security` extends ModeledCompanion[`Strict-Transport-Security`] {
def apply(maxAge: Long, includeSubDomains: Option[Boolean]) = new `Strict-Transport-Security`(maxAge, includeSubDomains.getOrElse(false))
private val maxAges: PartialFunction[StrictTransportSecurityDirective, MaxAge] = { case m: MaxAge => m }
private val isIncludeSubDomains: StrictTransportSecurityDirective => Boolean = { _ eq IncludeSubDomains }
def fromDirectives(directives: StrictTransportSecurityDirective*) = {
val maxAgeDirectives = directives.collect(maxAges)
if (maxAgeDirectives.size != 1) throw new IllegalArgumentException("exactly one 'max-age' directive required")
val includeSubDomainsDirectivesCount = directives.count(isIncludeSubDomains)
if (includeSubDomainsDirectivesCount > 1) throw new IllegalArgumentException("at most one 'includeSubDomains' directive allowed")
new `Strict-Transport-Security`(maxAgeDirectives.head.value, includeSubDomainsDirectivesCount == 1)
}
}
final case class `Strict-Transport-Security`(maxAge: Long, includeSubDomains: Boolean = false) extends jm.headers.StrictTransportSecurity with ResponseHeader {
def renderValue[R <: Rendering](r: R): r.type = {
r ~~ "max-age=" ~~ maxAge