not_implemented.go

Documentation: github.com/go-openapi/runtime/middleware

     1  // Copyright 2015 go-swagger maintainers
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //    http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package middleware
    16  
    17  import (
    18  	"net/http"
    19  
    20  	"github.com/go-openapi/runtime"
    21  )
    22  
    23  type errorResp struct {
    24  	code     int
    25  	response interface{}
    26  	headers  http.Header
    27  }
    28  
    29  func (e *errorResp) WriteResponse(rw http.ResponseWriter, producer runtime.Producer) {
    30  	for k, v := range e.headers {
    31  		for _, val := range v {
    32  			rw.Header().Add(k, val)
    33  		}
    34  	}
    35  	if e.code > 0 {
    36  		rw.WriteHeader(e.code)
    37  	} else {
    38  		rw.WriteHeader(http.StatusInternalServerError)
    39  	}
    40  	if err := producer.Produce(rw, e.response); err != nil {
    41  		Logger.Printf("failed to write error response: %v", err)
    42  	}
    43  }
    44  
    45  // NotImplemented the error response when the response is not implemented
    46  func NotImplemented(message string) Responder {
    47  	return Error(http.StatusNotImplemented, message)
    48  }
    49  
    50  // Error creates a generic responder for returning errors, the data will be serialized
    51  // with the matching producer for the request
    52  func Error(code int, data interface{}, headers ...http.Header) Responder {
    53  	var hdr http.Header
    54  	for _, h := range headers {
    55  		for k, v := range h {
    56  			if hdr == nil {
    57  				hdr = make(http.Header)
    58  			}
    59  			hdr[k] = v
    60  		}
    61  	}
    62  	return &errorResp{
    63  		code:     code,
    64  		response: data,
    65  		headers:  hdr,
    66  	}
    67  }
    68
View as plain text