summaryrefslogtreecommitdiff
path: root/modules/caddyhttp/caddyhttp.go
diff options
context:
space:
mode:
authorMatthew Holt <mholt@users.noreply.github.com>2020-06-04 12:06:38 -0600
committerMatthew Holt <mholt@users.noreply.github.com>2020-06-04 12:06:38 -0600
commit7a99835dab64f7864186185761bbf5194216f8b6 (patch)
tree90845df820a57ac032cf7156e45d8859ebcf30eb /modules/caddyhttp/caddyhttp.go
parent7b0962ba4df7e1dd7ab3f193fba394a4b899c431 (diff)
reverseproxy: Enable changing only the status code (close #2920)
Diffstat (limited to 'modules/caddyhttp/caddyhttp.go')
-rw-r--r--modules/caddyhttp/caddyhttp.go39
1 files changed, 39 insertions, 0 deletions
diff --git a/modules/caddyhttp/caddyhttp.go b/modules/caddyhttp/caddyhttp.go
index fda7a92..a7ac889 100644
--- a/modules/caddyhttp/caddyhttp.go
+++ b/modules/caddyhttp/caddyhttp.go
@@ -92,6 +92,45 @@ var errorEmptyHandler Handler = HandlerFunc(func(w http.ResponseWriter, r *http.
return nil
})
+// ResponseHandler pairs a response matcher with custom handling
+// logic. Either the status code can be changed to something else
+// while using the original response body, or, if a status code
+// is not set, it can execute a custom route list; this is useful
+// for executing handler routes based on the properties of an HTTP
+// response that has not been written out to the client yet.
+//
+// To use this type, provision it at module load time, then when
+// ready to use, match the response against its matcher; if it
+// matches (or doesn't have a matcher), change the status code on
+// the response if configured; otherwise invoke the routes by
+// calling `rh.Routes.Compile(next).ServeHTTP(rw, req)` (or similar).
+type ResponseHandler struct {
+ // The response matcher for this handler. If empty/nil,
+ // it always matches.
+ Match *ResponseMatcher `json:"match,omitempty"`
+
+ // To write the original response body but with a different
+ // status code, set this field to the desired status code.
+ // If set, this takes priority over routes.
+ StatusCode WeakString `json:"status_code,omitempty"`
+
+ // The list of HTTP routes to execute if no status code is
+ // specified. If evaluated, the original response body
+ // will not be written.
+ Routes RouteList `json:"routes,omitempty"`
+}
+
+// Provision sets up the routse in rh.
+func (rh *ResponseHandler) Provision(ctx caddy.Context) error {
+ if rh.Routes != nil {
+ err := rh.Routes.Provision(ctx)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
// WeakString is a type that unmarshals any JSON value
// as a string literal, with the following exceptions:
//