diff options
author | Doug Hellmann <doug@doughellmann.com> | 2015-01-06 12:04:31 -0500 |
---|---|---|
committer | Doug Hellmann <doug@doughellmann.com> | 2015-01-06 13:44:01 -0500 |
commit | 8e06ca5bd02660eb0b0980593f440ec7e46a00ac (patch) | |
tree | 072424b05294281e4aa70130b5289c0b37d74cd2 /oslo_middleware/base.py | |
parent | 860cdee514e32cbad121a9d8b7076b8931ed22c1 (diff) | |
download | oslo-middleware-0.3.0.tar.gz |
Move files out of the namespace package0.3.0
Move the public API out of oslo.middleware to oslo_middleware. Retain
the ability to import from the old namespace package for backwards
compatibility for this release cycle.
bp/drop-namespace-packages
Change-Id: If88c65c82b64f096a02f7ec62e019aea4de2f9d3
Diffstat (limited to 'oslo_middleware/base.py')
-rw-r--r-- | oslo_middleware/base.py | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/oslo_middleware/base.py b/oslo_middleware/base.py new file mode 100644 index 0000000..464a1cc --- /dev/null +++ b/oslo_middleware/base.py @@ -0,0 +1,56 @@ +# Copyright 2011 OpenStack Foundation. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""Base class(es) for WSGI Middleware.""" + +import webob.dec + + +class Middleware(object): + """Base WSGI middleware wrapper. + + These classes require an application to be initialized that will be called + next. By default the middleware will simply call its wrapped app, or you + can override __call__ to customize its behavior. + """ + + @classmethod + def factory(cls, global_conf, **local_conf): + """Factory method for paste.deploy.""" + return cls + + def __init__(self, application): + self.application = application + + def process_request(self, req): + """Called on each request. + + If this returns None, the next application down the stack will be + executed. If it returns a response then that response will be returned + and execution will stop here. + """ + return None + + def process_response(self, response): + """Do whatever you'd like to the response.""" + return response + + @webob.dec.wsgify + def __call__(self, req): + response = self.process_request(req) + if response: + return response + response = req.get_response(self.application) + return self.process_response(response) |