CVS changes for osdf placment api
[optf/osdf.git] / osdf / operation / responses.py
old mode 100644 (file)
new mode 100755 (executable)
index 84bb2cc..a3623ba
@@ -1,43 +1,64 @@
-# -------------------------------------------------------------------------
-#   Copyright (c) 2015-2017 AT&T Intellectual Property
-#
-#   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.
-#
-# -------------------------------------------------------------------------
-#
-
-from flask import Response
-
-from osdf import ACCEPTED_MESSAGE_TEMPLATE
-
-
-def osdf_response_for_request_accept(request_id="", transaction_id="", request_status="", status_message="",
-                                     response_code=202, as_http=True):
-    """Helper method to create a response object for request acceptance, so that the object can be sent to a client
-    :param request_id: request ID provided by the caller
-    :param transaction_id: transaction ID provided by the caller
-    :param request_status: the status of a request
-    :param status_message: details on the status of a request
-    :param response_code: the HTTP status code to send -- default is 202 (accepted)
-    :param as_http: whether to send response as HTTP response object or as a string
-    :return: if as_http is True, return a HTTP Response object. Otherwise, return json-encoded-message
-    """
-    response_message = ACCEPTED_MESSAGE_TEMPLATE.render(request_id=request_id, transaction_id=transaction_id,
-                                                        request_status=request_status, status_message=status_message)
-    if not as_http:
-        return response_message
-
-    response = Response(response_message, content_type='application/json; charset=utf-8')
-    response.headers.add('content-length', len(response_message))
-    response.status_code = response_code
-    return response
+# -------------------------------------------------------------------------\r
+#   Copyright (c) 2015-2017 AT&T Intellectual Property\r
+#\r
+#   Licensed under the Apache License, Version 2.0 (the "License");\r
+#   you may not use this file except in compliance with the License.\r
+#   You may obtain a copy of the License at\r
+#\r
+#       http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+#   Unless required by applicable law or agreed to in writing, software\r
+#   distributed under the License is distributed on an "AS IS" BASIS,\r
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+#   See the License for the specific language governing permissions and\r
+#   limitations under the License.\r
+#\r
+# -------------------------------------------------------------------------\r
+#\r
+\r
+from flask import Response\r
+\r
+from osdf import ACCEPTED_MESSAGE_TEMPLATE\r
+from osdf.logging.osdf_logging import debug_log\r
+\r
+def osdf_response_for_request_accept(request_id="", transaction_id="", request_status="", status_message="",\r
+                                     version_info = {\r
+                                          'placementVersioningEnabled': False,\r
+                                          'placementMajorVersion': '1',\r
+                                          'placementMinorVersion': '0',\r
+                                          'placementPatchVersion': '0'\r
+                                      },\r
+                                     response_code=202, as_http=True):\r
+    """Helper method to create a response object for request acceptance, so that the object can be sent to a client\r
+    :param request_id: request ID provided by the caller\r
+    :param transaction_id: transaction ID provided by the caller\r
+    :param request_status: the status of a request\r
+    :param status_message: details on the status of a request\r
+    :param response_code: the HTTP status code to send -- default is 202 (accepted)\r
+    :param as_http: whether to send response as HTTP response object or as a string\r
+    :return: if as_http is True, return a HTTP Response object. Otherwise, return json-encoded-message\r
+    """\r
+    response_message = ACCEPTED_MESSAGE_TEMPLATE.render(request_id=request_id, transaction_id=transaction_id,\r
+                                                        request_status=request_status, status_message=status_message)\r
+    if not as_http:\r
+        return response_message\r
+\r
+    response = Response(response_message, content_type='application/json; charset=utf-8')\r
+    response.headers.add('content-length', len(response_message))\r
+    \r
+    placement_ver_enabled = version_info['placementVersioningEnabled']\r
+    \r
+    if placement_ver_enabled:\r
+        placement_minor_version = version_info['placementMinorVersion']\r
+        placement_patch_version = version_info['placementPatchVersion']\r
+        placement_major_version = version_info['placementMajorVersion']\r
+        x_latest_version = placement_major_version+'.'+placement_minor_version+'.'+placement_patch_version\r
+        response.headers.add('X-MinorVersion', placement_minor_version)\r
+        response.headers.add('X-PatchVersion', placement_patch_version)\r
+        response.headers.add('X-LatestVersion', x_latest_version)\r
+        \r
+        debug_log.debug("Versions set in HTTP header for synchronous response: X-MinorVersion: {}  X-PatchVersion: {}  X-LatestVersion: {}"\r
+                        .format(placement_minor_version, placement_patch_version, x_latest_version))\r
+    \r
+    response.status_code = response_code\r
+    return response\r