1 # -------------------------------------------------------------------------
\r
2 # Copyright (c) 2015-2017 AT&T Intellectual Property
\r
4 # Licensed under the Apache License, Version 2.0 (the "License");
\r
5 # you may not use this file except in compliance with the License.
\r
6 # You may obtain a copy of the License at
\r
8 # http://www.apache.org/licenses/LICENSE-2.0
\r
10 # Unless required by applicable law or agreed to in writing, software
\r
11 # distributed under the License is distributed on an "AS IS" BASIS,
\r
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
13 # See the License for the specific language governing permissions and
\r
14 # limitations under the License.
\r
16 # -------------------------------------------------------------------------
\r
19 from flask import Response
\r
21 from osdf import ACCEPTED_MESSAGE_TEMPLATE
\r
22 from osdf.logging.osdf_logging import debug_log
\r
24 def osdf_response_for_request_accept(request_id="", transaction_id="", request_status="", status_message="",
\r
26 'placementVersioningEnabled': False,
\r
27 'placementMajorVersion': '1',
\r
28 'placementMinorVersion': '0',
\r
29 'placementPatchVersion': '0'
\r
31 response_code=202, as_http=True):
\r
32 """Helper method to create a response object for request acceptance, so that the object can be sent to a client
\r
33 :param request_id: request ID provided by the caller
\r
34 :param transaction_id: transaction ID provided by the caller
\r
35 :param request_status: the status of a request
\r
36 :param status_message: details on the status of a request
\r
37 :param response_code: the HTTP status code to send -- default is 202 (accepted)
\r
38 :param as_http: whether to send response as HTTP response object or as a string
\r
39 :return: if as_http is True, return a HTTP Response object. Otherwise, return json-encoded-message
\r
41 response_message = ACCEPTED_MESSAGE_TEMPLATE.render(request_id=request_id, transaction_id=transaction_id,
\r
42 request_status=request_status, status_message=status_message)
\r
44 return response_message
\r
46 response = Response(response_message, content_type='application/json; charset=utf-8')
\r
47 response.headers.add('content-length', len(response_message))
\r
49 placement_ver_enabled = version_info['placementVersioningEnabled']
\r
51 if placement_ver_enabled:
\r
52 placement_minor_version = version_info['placementMinorVersion']
\r
53 placement_patch_version = version_info['placementPatchVersion']
\r
54 placement_major_version = version_info['placementMajorVersion']
\r
55 x_latest_version = placement_major_version+'.'+placement_minor_version+'.'+placement_patch_version
\r
56 response.headers.add('X-MinorVersion', placement_minor_version)
\r
57 response.headers.add('X-PatchVersion', placement_patch_version)
\r
58 response.headers.add('X-LatestVersion', x_latest_version)
\r
60 debug_log.debug("Versions set in HTTP header for synchronous response: X-MinorVersion: {} X-PatchVersion: {} X-LatestVersion: {}"
\r
61 .format(placement_minor_version, placement_patch_version, x_latest_version))
\r
63 response.status_code = response_code
\r