cinder/cinder/api/v3/volume_metadata.py

82 lines
2.9 KiB
Python

# Copyright 2016 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.
"""The volume metadata V3 api."""
import hashlib
from oslo_serialization import jsonutils
import six
from six.moves import http_client
import webob
from cinder.api.openstack import wsgi
from cinder.api.v2 import volume_metadata as volume_meta_v2
from cinder import exception
METADATA_MICRO_VERSION = '3.15'
class Controller(volume_meta_v2.Controller):
"""The volume metadata API controller for the OpenStack API."""
def _validate_etag(self, req, volume_id):
if not req.if_match:
return True
context = req.environ['cinder.context']
metadata = self._get_metadata(context, volume_id)
data = jsonutils.dumps({"metadata": metadata})
if six.PY3:
data = data.encode('utf-8')
checksum = hashlib.md5(data).hexdigest()
return checksum in req.if_match.etags
def _ensure_min_version(self, req, allowed_version):
version = req.api_version_request
if not version.matches(allowed_version, None):
raise exception.VersionNotFoundForAPIMethod(version=version)
@wsgi.extends
def index(self, req, volume_id):
self._ensure_min_version(req, METADATA_MICRO_VERSION)
metadata = super(Controller, self).index(req, volume_id)
resp = webob.Response()
data = jsonutils.dumps(metadata)
if six.PY3:
data = data.encode('utf-8')
resp.headers['Etag'] = hashlib.md5(data).hexdigest()
resp.body = data
return resp
@wsgi.extends
def update(self, req, volume_id, id, body):
self._ensure_min_version(req, METADATA_MICRO_VERSION)
if not self._validate_etag(req, volume_id):
return webob.Response(status_int=http_client.PRECONDITION_FAILED)
return super(Controller, self).update(req, volume_id,
id, body)
@wsgi.extends
def update_all(self, req, volume_id, body):
self._ensure_min_version(req, METADATA_MICRO_VERSION)
if not self._validate_etag(req, volume_id):
return webob.Response(status_int=http_client.PRECONDITION_FAILED)
return super(Controller, self).update_all(req, volume_id,
body)
def create_resource():
return wsgi.Resource(Controller())