From a98ac16d26421561110a679edb765d64996a675e Mon Sep 17 00:00:00 2001
From: Ivan Topolnjak <ivantopo@gmail.com>
Date: Fri, 12 Oct 2018 14:29:10 +0200
Subject: reorganize the HttpMessage abstractions

---
 .../scala/kamon/instrumentation/HttpMessage.scala  | 71 +++++++++++++++++-----
 1 file changed, 55 insertions(+), 16 deletions(-)

(limited to 'kamon-core/src/main/scala/kamon/instrumentation/HttpMessage.scala')

diff --git a/kamon-core/src/main/scala/kamon/instrumentation/HttpMessage.scala b/kamon-core/src/main/scala/kamon/instrumentation/HttpMessage.scala
index b0300546..b141331b 100644
--- a/kamon-core/src/main/scala/kamon/instrumentation/HttpMessage.scala
+++ b/kamon-core/src/main/scala/kamon/instrumentation/HttpMessage.scala
@@ -2,26 +2,65 @@ package kamon.instrumentation
 
 import kamon.context.HttpPropagation.{HeaderReader, HeaderWriter}
 
+/**
+  * Base abstractions over HTTP messages.
+  */
+object HttpMessage {
 
-trait HttpRequest extends HeaderReader {
-  def url: String
-  def path: String
-  def method: String
-}
+  /**
+    * Wrapper for HTTP Request messages.
+    */
+  trait Request extends HeaderReader {
+
+    /**
+      * Request URL.
+      */
+    def url: String
+
+    /**
+      * Full request path. Does not include the query.
+      */
+    def path: String
 
-object HttpRequest {
-  trait Writable[T] extends HttpRequest with HeaderWriter {
-    def build(): T
+    /**
+      * HTTP Method.
+      */
+    def method: String
   }
-}
 
-trait HttpResponse {
-  def statusCode: Int
-}
+  /**
+    * Wrapper for HTTP response messages.
+    */
+  trait Response {
 
-object HttpResponse {
-  trait Writable[T] extends HttpResponse with HeaderWriter {
-    def build(): T
+    /**
+      * Status code on the response message.
+      */
+    def statusCode: Int
   }
-}
 
+  /**
+    * A HTTP message builder on which header values can be written and a complete HTTP message can be build from.
+    * Implementations will typically wrap a HTTP message model from an instrumented framework and either accumulate
+    * all header writes until a call to to .build() is made and a new HTTP message is constructed merging the previous
+    * and accumulated headers (on immutable HTTP models) or directly write the headers on the underlying HTTP message
+    * (on mutable HTTP models).
+    */
+  trait Builder[Message] extends HeaderWriter {
+
+    /**
+      * Returns a version a version of the HTTP message container all headers that have been written to the builder.
+      */
+    def build(): Message
+  }
+
+  /**
+    * Builder for HTTP Request messages.
+    */
+  trait RequestBuilder[Message] extends Request with Builder[Message]
+
+  /**
+    * Builder for HTTP Response messages.
+    */
+  trait ResponseBuilder[Message] extends Response with Builder[Message]
+}
-- 
cgit v1.2.3