code
stringlengths 12
335k
| docstring
stringlengths 20
20.8k
| func_name
stringlengths 1
105
| language
stringclasses 1
value | repo
stringclasses 498
values | path
stringlengths 5
172
| url
stringlengths 43
235
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
func writeServiceError(err ServiceError, req *Request, resp *Response) {
for header, values := range err.Header {
for _, value := range values {
resp.Header().Add(header, value)
}
}
resp.WriteErrorString(err.Code, err.Message)
} | writeServiceError is the default ServiceErrorHandleFunction and is called
when a ServiceError is returned during route selection. Default implementation
calls resp.WriteErrorString(err.Code, err.Message) | writeServiceError | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/container.go | Apache-2.0 |
func (c *Container) Dispatch(httpWriter http.ResponseWriter, httpRequest *http.Request) {
if httpWriter == nil {
panic("httpWriter cannot be nil")
}
if httpRequest == nil {
panic("httpRequest cannot be nil")
}
c.dispatch(httpWriter, httpRequest)
} | Dispatch the incoming Http Request to a matching WebService. | Dispatch | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/container.go | Apache-2.0 |
func (c *Container) dispatch(httpWriter http.ResponseWriter, httpRequest *http.Request) {
// so we can assign a compressing one later
writer := httpWriter
// CompressingResponseWriter should be closed after all operations are done
defer func() {
if compressWriter, ok := writer.(*CompressingResponseWriter); ok {
compressWriter.Close()
}
}()
// Instal panic recovery unless told otherwise
if !c.doNotRecover { // catch all for 500 response
defer func() {
if r := recover(); r != nil {
c.recoverHandleFunc(r, writer)
return
}
}()
}
// Find best match Route ; err is non nil if no match was found
var webService *WebService
var route *Route
var err error
func() {
c.webServicesLock.RLock()
defer c.webServicesLock.RUnlock()
webService, route, err = c.router.SelectRoute(
c.webServices,
httpRequest)
}()
if err != nil {
// a non-200 response (may be compressed) has already been written
// run container filters anyway ; they should not touch the response...
chain := FilterChain{Filters: c.containerFilters, Target: func(req *Request, resp *Response) {
switch err.(type) {
case ServiceError:
ser := err.(ServiceError)
c.serviceErrorHandleFunc(ser, req, resp)
}
// TODO
}}
chain.ProcessFilter(NewRequest(httpRequest), NewResponse(writer))
return
} | Dispatch the incoming Http Request to a matching WebService. | dispatch | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/container.go | Apache-2.0 |
func fixedPrefixPath(pathspec string) string {
varBegin := strings.Index(pathspec, "{")
if -1 == varBegin {
return pathspec
}
return pathspec[:varBegin]
} | fixedPrefixPath returns the fixed part of the partspec ; it may include template vars {} | fixedPrefixPath | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/container.go | Apache-2.0 |
func newBasicRequestResponse(httpWriter http.ResponseWriter, httpRequest *http.Request) (*Request, *Response) {
resp := NewResponse(httpWriter)
resp.requestAccept = httpRequest.Header.Get(HEADER_Accept)
return NewRequest(httpRequest), resp
} | newBasicRequestResponse creates a pair of Request,Response from its http versions.
It is basic because no parameter or (produces) content-type information is given. | newBasicRequestResponse | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/container.go | Apache-2.0 |
func TraceLogger(logger log.StdLogger) {
traceLogger = logger
EnableTracing(logger != nil)
} | TraceLogger enables detailed logging of Http request matching and filter invocation. Default no logger is set.
You may call EnableTracing() directly to enable trace logging to the package-wide logger. | TraceLogger | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/logger.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/logger.go | Apache-2.0 |
func SetLogger(customLogger log.StdLogger) {
log.SetLogger(customLogger)
} | SetLogger exposes the setter for the global logger on the top-level package | SetLogger | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/logger.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/logger.go | Apache-2.0 |
func EnableTracing(enabled bool) {
trace = enabled
} | EnableTracing can be used to Trace logging on and off. | EnableTracing | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/logger.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/logger.go | Apache-2.0 |
func copyMap(m map[string]interface{}) map[string]interface{} {
cp := make(map[string]interface{})
for k, v := range m {
vm, ok := v.(map[string]interface{})
if ok {
cp[k] = copyMap(vm)
} else {
cp[k] = v
}
}
return cp
} | https://stackoverflow.com/questions/23057785/how-to-copy-a-map | copyMap | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_reader.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_reader.go | Apache-2.0 |
func (ep *ExtensionProperties) AddExtension(key string, value interface{}) {
if ep.Extensions == nil {
ep.Extensions = map[string]interface{}{key: value}
} else {
ep.Extensions[key] = value
}
} | AddExtension adds or updates a key=value pair to the extension map. | AddExtension | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/extensions.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/extensions.go | Apache-2.0 |
func Add(service *WebService) {
DefaultContainer.Add(service)
} | Add registers a new WebService add it to the DefaultContainer. | Add | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/web_service_container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/web_service_container.go | Apache-2.0 |
func Filter(filter FilterFunction) {
DefaultContainer.Filter(filter)
} | Filter appends a container FilterFunction from the DefaultContainer.
These are called before dispatching a http.Request to a WebService. | Filter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/web_service_container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/web_service_container.go | Apache-2.0 |
func RegisteredWebServices() []*WebService {
return DefaultContainer.RegisteredWebServices()
} | RegisteredWebServices returns the collections of WebServices from the DefaultContainer | RegisteredWebServices | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/web_service_container.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/web_service_container.go | Apache-2.0 |
func (c *Container) OPTIONSFilter(req *Request, resp *Response, chain *FilterChain) {
if "OPTIONS" != req.Request.Method {
chain.ProcessFilter(req, resp)
return
}
archs := req.Request.Header.Get(HEADER_AccessControlRequestHeaders)
methods := strings.Join(c.computeAllowedMethods(req), ",")
origin := req.Request.Header.Get(HEADER_Origin)
resp.AddHeader(HEADER_Allow, methods)
resp.AddHeader(HEADER_AccessControlAllowOrigin, origin)
resp.AddHeader(HEADER_AccessControlAllowHeaders, archs)
resp.AddHeader(HEADER_AccessControlAllowMethods, methods)
} | OPTIONSFilter is a filter function that inspects the Http Request for the OPTIONS method
and provides the response with a set of allowed methods for the request URL Path.
As for any filter, you can also install it for a particular WebService within a Container.
Note: this filter is not needed when using CrossOriginResourceSharing (for CORS). | OPTIONSFilter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/options_filter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/options_filter.go | Apache-2.0 |
func OPTIONSFilter() FilterFunction {
return DefaultContainer.OPTIONSFilter
} | OPTIONSFilter is a filter function that inspects the Http Request for the OPTIONS method
and provides the response with a set of allowed methods for the request URL Path.
Note: this filter is not needed when using CrossOriginResourceSharing (for CORS). | OPTIONSFilter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/options_filter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/options_filter.go | Apache-2.0 |
func DefaultRequestContentType(mime string) {
defaultRequestContentType = mime
} | If ContentType is missing or */* is given then fall back to this type, otherwise
a "Unable to unmarshal content of type:" response is returned.
Valid values are restful.MIME_JSON and restful.MIME_XML
Example:
restful.DefaultRequestContentType(restful.MIME_JSON) | DefaultRequestContentType | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) PathParameter(name string) string {
return r.pathParameters[name]
} | PathParameter accesses the Path parameter value by its name | PathParameter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) PathParameters() map[string]string {
return r.pathParameters
} | PathParameters accesses the Path parameter values | PathParameters | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) QueryParameter(name string) string {
return r.Request.URL.Query().Get(name)
} | QueryParameter returns the (first) Query parameter value by its name | QueryParameter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) QueryParameters(name string) []string {
return r.Request.URL.Query()[name]
} | QueryParameters returns the all the query parameters values by name | QueryParameters | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) BodyParameter(name string) (string, error) {
err := r.Request.ParseForm()
if err != nil {
return "", err
}
return r.Request.PostFormValue(name), nil
} | BodyParameter parses the body of the request (once for typically a POST or a PUT) and returns the value of the given name or an error. | BodyParameter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) HeaderParameter(name string) string {
return r.Request.Header.Get(name)
} | HeaderParameter returns the HTTP Header value of a Header name or empty if missing | HeaderParameter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) ReadEntity(entityPointer interface{}) (err error) {
contentType := r.Request.Header.Get(HEADER_ContentType)
contentEncoding := r.Request.Header.Get(HEADER_ContentEncoding)
// check if the request body needs decompression
if ENCODING_GZIP == contentEncoding {
gzipReader := currentCompressorProvider.AcquireGzipReader()
defer currentCompressorProvider.ReleaseGzipReader(gzipReader)
gzipReader.Reset(r.Request.Body)
r.Request.Body = gzipReader
} else if ENCODING_DEFLATE == contentEncoding {
zlibReader, err := zlib.NewReader(r.Request.Body)
if err != nil {
return err
}
r.Request.Body = zlibReader
}
// lookup the EntityReader, use defaultRequestContentType if needed and provided
entityReader, ok := entityAccessRegistry.accessorAt(contentType)
if !ok {
if len(defaultRequestContentType) != 0 {
entityReader, ok = entityAccessRegistry.accessorAt(defaultRequestContentType)
}
if !ok {
return NewError(http.StatusBadRequest, "Unable to unmarshal content of type:"+contentType)
}
}
return entityReader.Read(r, entityPointer)
} | ReadEntity checks the Accept header and reads the content into the entityPointer. | ReadEntity | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r *Request) SetAttribute(name string, value interface{}) {
r.attributes[name] = value
} | SetAttribute adds or replaces the attribute with the given value. | SetAttribute | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r Request) Attribute(name string) interface{} {
return r.attributes[name]
} | Attribute returns the value associated to the given name. Returns nil if absent. | Attribute | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r Request) SelectedRoutePath() string {
if r.selectedRoute == nil {
return ""
}
// skip creating an accessor
return r.selectedRoute.Path
} | SelectedRoutePath root path + route path that matched the request, e.g. /meetings/{id}/attendees
If no route was matched then return an empty string. | SelectedRoutePath | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func (r Request) SelectedRoute() RouteReader {
if r.selectedRoute == nil {
return nil
}
return routeAccessor{route: r.selectedRoute}
} | SelectedRoute returns a reader to access the selected Route by the container
Returns nil if no route was matched. | SelectedRoute | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/request.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/request.go | Apache-2.0 |
func NewError(code int, message string) ServiceError {
return ServiceError{Code: code, Message: message}
} | NewError returns a ServiceError using the code and reason | NewError | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/service_error.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/service_error.go | Apache-2.0 |
func NewErrorWithHeader(code int, message string, header http.Header) ServiceError {
return ServiceError{Code: code, Message: message, Header: header}
} | NewErrorWithHeader returns a ServiceError using the code, reason and header | NewErrorWithHeader | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/service_error.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/service_error.go | Apache-2.0 |
func (s ServiceError) Error() string {
return fmt.Sprintf("[ServiceError:%v] %v", s.Code, s.Message)
} | Error returns a text representation of the service error | Error | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/service_error.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/service_error.go | Apache-2.0 |
func CurrentCompressorProvider() CompressorProvider {
return currentCompressorProvider
} | CurrentCompressorProvider returns the current CompressorProvider.
It is initialized using a SyncPoolCompessors. | CurrentCompressorProvider | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressors.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressors.go | Apache-2.0 |
func SetCompressorProvider(p CompressorProvider) {
if p == nil {
panic("cannot set compressor provider to nil")
}
currentCompressorProvider = p
} | SetCompressorProvider sets the actual provider of compressors (zlib or gzip). | SetCompressorProvider | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressors.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressors.go | Apache-2.0 |
func (c *CompressingResponseWriter) Header() http.Header {
return c.writer.Header()
} | Header is part of http.ResponseWriter interface | Header | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func (c *CompressingResponseWriter) WriteHeader(status int) {
c.writer.WriteHeader(status)
} | WriteHeader is part of http.ResponseWriter interface | WriteHeader | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func (c *CompressingResponseWriter) Write(bytes []byte) (int, error) {
if c.isCompressorClosed() {
return -1, errors.New("Compressing error: tried to write data using closed compressor")
}
return c.compressor.Write(bytes)
} | Write is part of http.ResponseWriter interface
It is passed through the compressor | Write | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func (c *CompressingResponseWriter) CloseNotify() <-chan bool {
return c.writer.(http.CloseNotifier).CloseNotify()
} | CloseNotify is part of http.CloseNotifier interface | CloseNotify | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func (c *CompressingResponseWriter) Close() error {
if c.isCompressorClosed() {
return errors.New("Compressing error: tried to close already closed compressor")
}
c.compressor.Close()
if ENCODING_GZIP == c.encoding {
currentCompressorProvider.ReleaseGzipWriter(c.compressor.(*gzip.Writer))
}
if ENCODING_DEFLATE == c.encoding {
currentCompressorProvider.ReleaseZlibWriter(c.compressor.(*zlib.Writer))
}
// gc hint needed?
c.compressor = nil
return nil
} | Close the underlying compressor | Close | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func (c *CompressingResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
hijacker, ok := c.writer.(http.Hijacker)
if !ok {
return nil, nil, errors.New("ResponseWriter doesn't support Hijacker interface")
}
return hijacker.Hijack()
} | Hijack implements the Hijacker interface
This is especially useful when combining Container.EnabledContentEncoding
in combination with websockets (for instance gorilla/websocket) | Hijack | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func wantsCompressedResponse(httpRequest *http.Request, httpWriter http.ResponseWriter) (bool, string) {
if contentEncoding := httpWriter.Header().Get(HEADER_ContentEncoding); contentEncoding != "" {
return false, ""
}
header := httpRequest.Header.Get(HEADER_AcceptEncoding)
gi := strings.Index(header, ENCODING_GZIP)
zi := strings.Index(header, ENCODING_DEFLATE)
// use in order of appearance
if gi == -1 {
return zi != -1, ENCODING_DEFLATE
} else if zi == -1 {
return gi != -1, ENCODING_GZIP
} else {
if gi < zi {
return true, ENCODING_GZIP
}
return true, ENCODING_DEFLATE
}
} | WantsCompressedResponse reads the Accept-Encoding header to see if and which encoding is requested.
It also inspects the httpWriter whether its content-encoding is already set (non-empty). | wantsCompressedResponse | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func NewCompressingResponseWriter(httpWriter http.ResponseWriter, encoding string) (*CompressingResponseWriter, error) {
httpWriter.Header().Set(HEADER_ContentEncoding, encoding)
c := new(CompressingResponseWriter)
c.writer = httpWriter
var err error
if ENCODING_GZIP == encoding {
w := currentCompressorProvider.AcquireGzipWriter()
w.Reset(httpWriter)
c.compressor = w
c.encoding = ENCODING_GZIP
} else if ENCODING_DEFLATE == encoding {
w := currentCompressorProvider.AcquireZlibWriter()
w.Reset(httpWriter)
c.compressor = w
c.encoding = ENCODING_DEFLATE
} else {
return nil, errors.New("Unknown encoding:" + encoding)
}
return c, err
} | NewCompressingResponseWriter create a CompressingResponseWriter for a known encoding = {gzip,deflate} | NewCompressingResponseWriter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compress.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compress.go | Apache-2.0 |
func (d defaultPathProcessor) ExtractParameters(r *Route, _ *WebService, urlPath string) map[string]string {
urlParts := tokenizePath(urlPath)
pathParameters := map[string]string{}
for i, key := range r.pathParts {
var value string
if i >= len(urlParts) {
value = ""
} else {
value = urlParts[i]
}
if r.hasCustomVerb && hasCustomVerb(key) {
key = removeCustomVerb(key)
value = removeCustomVerb(value)
}
if strings.Index(key, "{") > -1 { // path-parameter
if colon := strings.Index(key, ":"); colon != -1 {
// extract by regex
regPart := key[colon+1 : len(key)-1]
keyPart := key[1:colon]
if regPart == "*" {
pathParameters[keyPart] = untokenizePath(i, urlParts)
break
} else {
pathParameters[keyPart] = value
}
} else {
// without enclosing {}
startIndex := strings.Index(key, "{")
endKeyIndex := strings.Index(key, "}")
suffixLength := len(key) - endKeyIndex - 1
endValueIndex := len(value) - suffixLength
pathParameters[key[startIndex+1:endKeyIndex]] = value[startIndex:endValueIndex]
}
}
}
return pathParameters
} | Extract the parameters from the request url path | ExtractParameters | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/path_processor.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/path_processor.go | Apache-2.0 |
func untokenizePath(offset int, parts []string) string {
var buffer bytes.Buffer
for p := offset; p < len(parts); p++ {
buffer.WriteString(parts[p])
// do not end
if p < len(parts)-1 {
buffer.WriteString("/")
}
}
return buffer.String()
} | Untokenize back into an URL path using the slash separator | untokenizePath | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/path_processor.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/path_processor.go | Apache-2.0 |
func (c CrossOriginResourceSharing) Filter(req *Request, resp *Response, chain *FilterChain) {
origin := req.Request.Header.Get(HEADER_Origin)
if len(origin) == 0 {
if trace {
traceLogger.Print("no Http header Origin set")
}
chain.ProcessFilter(req, resp)
return
}
if !c.isOriginAllowed(origin) { // check whether this origin is allowed
if trace {
traceLogger.Printf("HTTP Origin:%s is not part of %v, neither matches any part of %v", origin, c.AllowedDomains, c.allowedOriginPatterns)
}
chain.ProcessFilter(req, resp)
return
}
if req.Request.Method != "OPTIONS" {
c.doActualRequest(req, resp)
chain.ProcessFilter(req, resp)
return
}
if acrm := req.Request.Header.Get(HEADER_AccessControlRequestMethod); acrm != "" {
c.doPreflightRequest(req, resp)
} else {
c.doActualRequest(req, resp)
chain.ProcessFilter(req, resp)
return
}
} | Filter is a filter function that implements the CORS flow as documented on http://enable-cors.org/server.html
and http://www.html5rocks.com/static/images/cors_server_flowchart.png | Filter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/cors_filter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/cors_filter.go | Apache-2.0 |
func NewBoundedCachedCompressors(writersCapacity, readersCapacity int) *BoundedCachedCompressors {
b := &BoundedCachedCompressors{
gzipWriters: make(chan *gzip.Writer, writersCapacity),
gzipReaders: make(chan *gzip.Reader, readersCapacity),
zlibWriters: make(chan *zlib.Writer, writersCapacity),
writersCapacity: writersCapacity,
readersCapacity: readersCapacity,
}
for ix := 0; ix < writersCapacity; ix++ {
b.gzipWriters <- newGzipWriter()
b.zlibWriters <- newZlibWriter()
}
for ix := 0; ix < readersCapacity; ix++ {
b.gzipReaders <- newGzipReader()
}
return b
} | NewBoundedCachedCompressors returns a new, with filled cache, BoundedCachedCompressors. | NewBoundedCachedCompressors | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (b *BoundedCachedCompressors) AcquireGzipWriter() *gzip.Writer {
var writer *gzip.Writer
select {
case writer, _ = <-b.gzipWriters:
default:
// return a new unmanaged one
writer = newGzipWriter()
}
return writer
} | AcquireGzipWriter returns an resettable *gzip.Writer. Needs to be released. | AcquireGzipWriter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (b *BoundedCachedCompressors) ReleaseGzipWriter(w *gzip.Writer) {
// forget the unmanaged ones
if len(b.gzipWriters) < b.writersCapacity {
b.gzipWriters <- w
}
} | ReleaseGzipWriter accepts a writer (does not have to be one that was cached)
only when the cache has room for it. It will ignore it otherwise. | ReleaseGzipWriter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (b *BoundedCachedCompressors) AcquireGzipReader() *gzip.Reader {
var reader *gzip.Reader
select {
case reader, _ = <-b.gzipReaders:
default:
// return a new unmanaged one
reader = newGzipReader()
}
return reader
} | AcquireGzipReader returns a *gzip.Reader. Needs to be released. | AcquireGzipReader | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (b *BoundedCachedCompressors) ReleaseGzipReader(r *gzip.Reader) {
// forget the unmanaged ones
if len(b.gzipReaders) < b.readersCapacity {
b.gzipReaders <- r
}
} | ReleaseGzipReader accepts a reader (does not have to be one that was cached)
only when the cache has room for it. It will ignore it otherwise. | ReleaseGzipReader | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (b *BoundedCachedCompressors) AcquireZlibWriter() *zlib.Writer {
var writer *zlib.Writer
select {
case writer, _ = <-b.zlibWriters:
default:
// return a new unmanaged one
writer = newZlibWriter()
}
return writer
} | AcquireZlibWriter returns an resettable *zlib.Writer. Needs to be released. | AcquireZlibWriter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (b *BoundedCachedCompressors) ReleaseZlibWriter(w *zlib.Writer) {
// forget the unmanaged ones
if len(b.zlibWriters) < b.writersCapacity {
b.zlibWriters <- w
}
} | ReleaseZlibWriter accepts a writer (does not have to be one that was cached)
only when the cache has room for it. It will ignore it otherwise. | ReleaseZlibWriter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/compressor_cache.go | Apache-2.0 |
func (p *Parameter) Data() ParameterData {
return *p.data
} | Data returns the state of the Parameter | Data | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) Kind() int {
return p.data.Kind
} | Kind returns the parameter type indicator (see const for valid values) | Kind | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) Required(required bool) *Parameter {
p.data.Required = required
return p
} | Required sets the required field and returns the receiver | Required | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) AllowMultiple(multiple bool) *Parameter {
p.data.AllowMultiple = multiple
return p
} | AllowMultiple sets the allowMultiple field and returns the receiver | AllowMultiple | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) AddExtension(key string, value interface{}) *Parameter {
p.data.AddExtension(key, value)
return p
} | AddExtension adds or updates a key=value pair to the extension map | AddExtension | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) AllowEmptyValue(multiple bool) *Parameter {
p.data.AllowEmptyValue = multiple
return p
} | AllowEmptyValue sets the AllowEmptyValue field and returns the receiver | AllowEmptyValue | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) AllowableValues(values map[string]string) *Parameter {
p.data.AllowableValues = values
allowableSortedKeys := make([]string, 0, len(values))
for k := range values {
allowableSortedKeys = append(allowableSortedKeys, k)
}
sort.Strings(allowableSortedKeys)
p.data.PossibleValues = make([]string, 0, len(values))
for _, k := range allowableSortedKeys {
p.data.PossibleValues = append(p.data.PossibleValues, values[k])
}
return p
} | AllowableValues is deprecated. Use PossibleValues instead. Both will be set. | AllowableValues | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) PossibleValues(values []string) *Parameter {
p.data.PossibleValues = values
return p
} | PossibleValues sets the possible values field and returns the receiver | PossibleValues | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) DataType(typeName string) *Parameter {
p.data.DataType = typeName
return p
} | DataType sets the dataType field and returns the receiver | DataType | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) DataFormat(formatName string) *Parameter {
p.data.DataFormat = formatName
return p
} | DataFormat sets the dataFormat field for Swagger UI | DataFormat | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) DefaultValue(stringRepresentation string) *Parameter {
p.data.DefaultValue = stringRepresentation
return p
} | DefaultValue sets the default value field and returns the receiver | DefaultValue | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) Description(doc string) *Parameter {
p.data.Description = doc
return p
} | Description sets the description value field and returns the receiver | Description | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) CollectionFormat(format CollectionFormat) *Parameter {
p.data.CollectionFormat = format.String()
return p
} | CollectionFormat sets the collection format for an array type | CollectionFormat | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) Pattern(pattern string) *Parameter {
p.data.Pattern = pattern
return p
} | Pattern sets the pattern field and returns the receiver | Pattern | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) Minimum(minimum float64) *Parameter {
p.data.Minimum = &minimum
return p
} | Minimum sets the minimum field and returns the receiver | Minimum | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) Maximum(maximum float64) *Parameter {
p.data.Maximum = &maximum
return p
} | Maximum sets the maximum field and returns the receiver | Maximum | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) MinLength(minLength int64) *Parameter {
p.data.MinLength = &minLength
return p
} | MinLength sets the minLength field and returns the receiver | MinLength | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) MaxLength(maxLength int64) *Parameter {
p.data.MaxLength = &maxLength
return p
} | MaxLength sets the maxLength field and returns the receiver | MaxLength | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) MinItems(minItems int64) *Parameter {
p.data.MinItems = &minItems
return p
} | MinItems sets the minItems field and returns the receiver | MinItems | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) MaxItems(maxItems int64) *Parameter {
p.data.MaxItems = &maxItems
return p
} | MaxItems sets the maxItems field and returns the receiver | MaxItems | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (p *Parameter) UniqueItems(uniqueItems bool) *Parameter {
p.data.UniqueItems = uniqueItems
return p
} | UniqueItems sets the uniqueItems field and returns the receiver | UniqueItems | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/parameter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/parameter.go | Apache-2.0 |
func (r *Route) postBuild() {
r.pathParts = tokenizePath(r.Path)
r.hasCustomVerb = hasCustomVerb(r.Path)
} | Initialize for Route | postBuild | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route.go | Apache-2.0 |
func (r *Route) wrapRequestResponse(httpWriter http.ResponseWriter, httpRequest *http.Request, pathParams map[string]string) (*Request, *Response) {
wrappedRequest := NewRequest(httpRequest)
wrappedRequest.pathParameters = pathParams
wrappedRequest.selectedRoute = r
wrappedResponse := NewResponse(httpWriter)
wrappedResponse.requestAccept = httpRequest.Header.Get(HEADER_Accept)
wrappedResponse.routeProduces = r.Produces
return wrappedRequest, wrappedResponse
} | Create Request and Response from their http versions | wrapRequestResponse | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route.go | Apache-2.0 |
func (r Route) matchesAccept(mimeTypesWithQuality string) bool {
remaining := mimeTypesWithQuality
for {
var mimeType string
if end := strings.Index(remaining, ","); end == -1 {
mimeType, remaining = remaining, ""
} else {
mimeType, remaining = remaining[:end], remaining[end+1:]
}
if quality := strings.Index(mimeType, ";"); quality != -1 {
mimeType = mimeType[:quality]
}
mimeType = strings.TrimFunc(mimeType, stringTrimSpaceCutset)
if mimeType == "*/*" {
return true
}
for _, producibleType := range r.Produces {
if producibleType == "*/*" || producibleType == mimeType {
return true
}
}
if len(remaining) == 0 {
return false
}
}
} | Return whether the mimeType matches to what this Route can produce. | matchesAccept | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route.go | Apache-2.0 |
func (r Route) matchesContentType(mimeTypes string) bool {
if len(r.Consumes) == 0 {
// did not specify what it can consume ; any media type (“*/*”) is assumed
return true
}
if len(mimeTypes) == 0 {
// idempotent methods with (most-likely or guaranteed) empty content match missing Content-Type
m := r.Method
// if route specifies less or non-idempotent methods then use that
if len(r.allowedMethodsWithoutContentType) > 0 {
for _, each := range r.allowedMethodsWithoutContentType {
if m == each {
return true
}
}
} else {
if m == "GET" || m == "HEAD" || m == "OPTIONS" || m == "DELETE" || m == "TRACE" {
return true
}
}
// proceed with default
mimeTypes = MIME_OCTET
}
remaining := mimeTypes
for {
var mimeType string
if end := strings.Index(remaining, ","); end == -1 {
mimeType, remaining = remaining, ""
} else {
mimeType, remaining = remaining[:end], remaining[end+1:]
}
if quality := strings.Index(mimeType, ";"); quality != -1 {
mimeType = mimeType[:quality]
}
mimeType = strings.TrimFunc(mimeType, stringTrimSpaceCutset)
for _, consumeableType := range r.Consumes {
if consumeableType == "*/*" || consumeableType == mimeType {
return true
}
}
if len(remaining) == 0 {
return false
}
}
} | Return whether this Route can consume content with a type specified by mimeTypes (can be empty). | matchesContentType | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route.go | Apache-2.0 |
func tokenizePath(path string) []string {
if "/" == path {
return nil
}
if TrimRightSlashEnabled {
// 3.9.0
return strings.Split(strings.Trim(path, "/"), "/")
} else {
// 3.10.2
return strings.Split(strings.TrimLeft(path, "/"), "/")
}
} | Tokenize an URL path using the slash separator ; the result does not have empty tokens | tokenizePath | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route.go | Apache-2.0 |
func (r *Route) EnableContentEncoding(enabled bool) {
r.contentEncodingEnabled = &enabled
} | EnableContentEncoding (default=false) allows for GZIP or DEFLATE encoding of responses. Overrides the container.contentEncodingEnabled value. | EnableContentEncoding | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route.go | Apache-2.0 |
func HttpMiddlewareHandlerToFilter(middleware HttpMiddlewareHandler) FilterFunction {
return func(req *Request, resp *Response, chain *FilterChain) {
next := http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
req.Request = r
resp.ResponseWriter = rw
chain.ProcessFilter(req, resp)
})
middleware(next).ServeHTTP(resp.ResponseWriter, req.Request)
}
} | HttpMiddlewareHandlerToFilter converts a HttpMiddlewareHandler to a FilterFunction. | HttpMiddlewareHandlerToFilter | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/filter_adapter.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/filter_adapter.go | Apache-2.0 |
func newPathExpression(path string) (*pathExpression, error) {
expression, literalCount, varNames, varCount, tokens := templateToRegularExpression(path)
compiled, err := regexp.Compile(expression)
if err != nil {
return nil, err
}
return &pathExpression{literalCount, varNames, varCount, compiled, expression, tokens}, nil
} | NewPathExpression creates a PathExpression from the input URL path.
Returns an error if the path is invalid. | newPathExpression | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/path_expression.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/path_expression.go | Apache-2.0 |
func templateToRegularExpression(template string) (expression string, literalCount int, varNames []string, varCount int, tokens []string) {
var buffer bytes.Buffer
buffer.WriteString("^")
//tokens = strings.Split(template, "/")
tokens = tokenizePath(template)
for _, each := range tokens {
if each == "" {
continue
}
buffer.WriteString("/")
if strings.HasPrefix(each, "{") {
// check for regular expression in variable
colon := strings.Index(each, ":")
var varName string
if colon != -1 {
// extract expression
varName = strings.TrimSpace(each[1:colon])
paramExpr := strings.TrimSpace(each[colon+1 : len(each)-1])
if paramExpr == "*" { // special case
buffer.WriteString("(.*)")
} else {
buffer.WriteString(fmt.Sprintf("(%s)", paramExpr)) // between colon and closing moustache
}
} else {
// plain var
varName = strings.TrimSpace(each[1 : len(each)-1])
buffer.WriteString("([^/]+?)")
}
varNames = append(varNames, varName)
varCount += 1
} else {
literalCount += len(each)
encoded := each // TODO URI encode
buffer.WriteString(regexp.QuoteMeta(encoded))
}
}
return strings.TrimRight(buffer.String(), "/") + "(/.*)?$", literalCount, varNames, varCount, tokens
} | http://jsr311.java.net/nonav/releases/1.1/spec/spec3.html#x3-370003.7.3 | templateToRegularExpression | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/path_expression.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/path_expression.go | Apache-2.0 |
func (b *RouteBuilder) Do(oneArgBlocks ...func(*RouteBuilder)) *RouteBuilder {
for _, each := range oneArgBlocks {
each(b)
}
return b
} | Do evaluates each argument with the RouteBuilder itself.
This allows you to follow DRY principles without breaking the fluent programming style.
Example:
ws.Route(ws.DELETE("/{name}").To(t.deletePerson).Do(Returns200, Returns500))
func Returns500(b *RouteBuilder) {
b.Returns(500, "Internal Server Error", restful.ServiceError{})
} | Do | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) To(function RouteFunction) *RouteBuilder {
b.function = function
return b
} | To bind the route to a function.
If this route is matched with the incoming Http Request then call this function with the *Request,*Response pair. Required. | To | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Method(method string) *RouteBuilder {
b.httpMethod = method
return b
} | Method specifies what HTTP method to match. Required. | Method | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Produces(mimeTypes ...string) *RouteBuilder {
b.produces = mimeTypes
return b
} | Produces specifies what MIME types can be produced ; the matched one will appear in the Content-Type Http header. | Produces | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Consumes(mimeTypes ...string) *RouteBuilder {
b.consumes = mimeTypes
return b
} | Consumes specifies what MIME types can be consumes ; the Accept Http header must matched any of these | Consumes | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Path(subPath string) *RouteBuilder {
b.currentPath = subPath
return b
} | Path specifies the relative (w.r.t WebService root path) URL path to match. Default is "/". | Path | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Doc(documentation string) *RouteBuilder {
b.doc = documentation
return b
} | Doc tells what this route is all about. Optional. | Doc | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Reads(sample interface{}, optionalDescription ...string) *RouteBuilder {
fn := b.typeNameHandleFunc
if fn == nil {
fn = reflectTypeName
}
typeAsName := fn(sample)
description := ""
if len(optionalDescription) > 0 {
description = optionalDescription[0]
}
b.readSample = sample
bodyParameter := &Parameter{&ParameterData{Name: "body", Description: description}}
bodyParameter.beBody()
bodyParameter.Required(true)
bodyParameter.DataType(typeAsName)
b.Param(bodyParameter)
return b
} | Reads tells what resource type will be read from the request payload. Optional.
A parameter of type "body" is added ,required is set to true and the dataType is set to the qualified name of the sample's type. | Reads | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b RouteBuilder) ParameterNamed(name string) (p *Parameter) {
for _, each := range b.parameters {
if each.Data().Name == name {
return each
}
}
return p
} | ParameterNamed returns a Parameter already known to the RouteBuilder. Returns nil if not.
Use this to modify or extend information for the Parameter (through its Data()). | ParameterNamed | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Writes(samples ...interface{}) *RouteBuilder {
b.writeSamples = samples // oneof
return b
} | Writes tells which one of the resource types will be written as the response payload. Optional. | Writes | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Param(parameter *Parameter) *RouteBuilder {
if b.parameters == nil {
b.parameters = []*Parameter{}
}
b.parameters = append(b.parameters, parameter)
return b
} | Param allows you to document the parameters of the Route. It adds a new Parameter (does not check for duplicates). | Param | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Operation(name string) *RouteBuilder {
b.operation = name
return b
} | Operation allows you to document what the actual method/function call is of the Route.
Unless called, the operation name is derived from the RouteFunction set using To(..). | Operation | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) ReturnsError(code int, message string, model interface{}) *RouteBuilder {
log.Print("ReturnsError is deprecated, use Returns instead.")
return b.Returns(code, message, model)
} | ReturnsError is deprecated, use Returns instead. | ReturnsError | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Returns(code int, message string, model interface{}) *RouteBuilder {
err := ResponseError{
Code: code,
Message: message,
Model: model,
IsDefault: false, // this field is deprecated, use default response instead.
}
// lazy init because there is no NewRouteBuilder (yet)
if b.errorMap == nil {
b.errorMap = map[int]ResponseError{}
}
b.errorMap[code] = err
return b
} | Returns allows you to document what responses (errors or regular) can be expected.
The model parameter is optional ; either pass a struct instance or use nil if not applicable. | Returns | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) ReturnsWithHeaders(code int, message string, model interface{}, headers map[string]Header) *RouteBuilder {
b.Returns(code, message, model)
err := b.errorMap[code]
err.Headers = headers
b.errorMap[code] = err
return b
} | ReturnsWithHeaders is similar to Returns, but can specify response headers | ReturnsWithHeaders | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) DefaultReturns(message string, model interface{}) *RouteBuilder {
b.defaultResponse = &ResponseError{
Message: message,
Model: model,
}
return b
} | DefaultReturns is a special Returns call that sets the default of the response. | DefaultReturns | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Metadata(key string, value interface{}) *RouteBuilder {
if b.metadata == nil {
b.metadata = map[string]interface{}{}
}
b.metadata[key] = value
return b
} | Metadata adds or updates a key=value pair to the metadata map. | Metadata | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) AddExtension(key string, value interface{}) *RouteBuilder {
if b.extensions == nil {
b.extensions = map[string]interface{}{}
}
b.extensions[key] = value
return b
} | AddExtension adds or updates a key=value pair to the extensions map. | AddExtension | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) Deprecate() *RouteBuilder {
b.deprecated = true
return b
} | Deprecate sets the value of deprecated to true. Deprecated routes have a special UI treatment to warn against use | Deprecate | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
func (b *RouteBuilder) AllowedMethodsWithoutContentType(methods []string) *RouteBuilder {
b.allowedMethodsWithoutContentType = methods
return b
} | AllowedMethodsWithoutContentType overrides the default list GET,HEAD,OPTIONS,DELETE,TRACE
If a request does not include a content-type header then
depending on the method, it may return a 415 Unsupported Media.
Must have uppercase HTTP Method names such as GET,HEAD,OPTIONS,... | AllowedMethodsWithoutContentType | go | k8snetworkplumbingwg/multus-cni | vendor/github.com/emicklei/go-restful/v3/route_builder.go | https://github.com/k8snetworkplumbingwg/multus-cni/blob/master/vendor/github.com/emicklei/go-restful/v3/route_builder.go | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.