Adding the "activate" opperation

kmip/core/messages/payloads/activate.py

@@ -0,0 +1,163 @@
+# Copyright (c) 2015 Hewlett Packard Development Company, L.P.
+# 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.
+
+from kmip.core import attributes
+from kmip.core import enums
+
+from kmip.core.primitives import Struct
+
+from kmip.core.utils import BytearrayStream
+
+
+class ActivateRequestPayload(Struct):
+    """
+    A request payload for the Activate operation.
+
+    The payload contains a UUID of a cryptographic object that that server
+    should activate. See Section 4.19 of the KMIP 1.1 specification for more
+    information.
+
+    Attributes:
+        unique_identifier: The UUID of a managed cryptographic object
+    """
+    def __init__(self,
+                 unique_identifier=None):
+        """
+        Construct a ActivateRequestPayload object.
+        Args:
+            unique_identifier (UniqueIdentifier): The UUID of a managed
+                cryptographic object.
+        """
+        super(ActivateRequestPayload, self).__init__(
+            tag=enums.Tags.REQUEST_PAYLOAD)
+        self.unique_identifier = unique_identifier
+        self.validate()
+
+    def read(self, istream):
+        """
+        Read the data encoding the ActivateRequestPayload object and decode it
+        into its constituent parts.
+        Args:
+            istream (Stream): A data stream containing encoded object data,
+                supporting a read method; usually a BytearrayStream object.
+        """
+        super(ActivateRequestPayload, self).read(istream)
+        tstream = BytearrayStream(istream.read(self.length))
+
+        self.unique_identifier = attributes.UniqueIdentifier()
+        self.unique_identifier.read(tstream)
+
+        self.is_oversized(tstream)
+        self.validate()
+
+    def write(self, ostream):
+        """
+        Write the data encoding the ActivateRequestPayload object to a stream.
+        Args:
+            ostream (Stream): A data stream in which to encode object data,
+                supporting a write method; usually a BytearrayStream object.
+        """
+        tstream = BytearrayStream()
+
+        # Write the contents of the request payload
+        if self.unique_identifier is not None:
+            self.unique_identifier.write(tstream)
+
+        # Write the length and value of the request payload
+        self.length = tstream.length()
+        super(ActivateRequestPayload, self).write(ostream)
+        ostream.write(tstream.buffer)
+
+    def validate(self):
+        """
+        Error check the attributes of the ActivateRequestPayload object.
+        """
+        if self.unique_identifier is not None:
+            if not isinstance(self.unique_identifier,
+                              attributes.UniqueIdentifier):
+                msg = "invalid unique identifier"
+                raise TypeError(msg)
+
+
+class ActivateResponsePayload(Struct):
+    """
+    A response payload for the Activate operation.
+
+    The payload contains the server response to the initial Activate request.
+    See Section 4.19 of the KMIP 1.1 specification for more information.
+
+    Attributes:
+        unique_identifier: The UUID of a managed cryptographic object.
+    """
+    def __init__(self,
+                 unique_identifier=None):
+        """
+        Construct a ActivateResponsePayload object.
+
+        Args:
+            unique_identifier (UniqueIdentifier): The UUID of a managed
+                cryptographic object.
+        """
+        super(ActivateResponsePayload, self).__init__(
+            tag=enums.Tags.RESPONSE_PAYLOAD)
+        if unique_identifier is None:
+            self.unique_identifier = attributes.UniqueIdentifier()
+        else:
+            self.unique_identifier = unique_identifier
+        self.validate()
+
+    def read(self, istream):
+        """
+        Read the data encoding the ActivateResponsePayload object and decode it
+        into its constituent parts.
+
+        Args:
+            istream (Stream): A data stream containing encoded object data,
+                supporting a read method; usually a BytearrayStream object.
+        """
+        super(ActivateResponsePayload, self).read(istream)
+        tstream = BytearrayStream(istream.read(self.length))
+
+        self.unique_identifier = attributes.UniqueIdentifier()
+        self.unique_identifier.read(tstream)
+
+        self.is_oversized(tstream)
+        self.validate()
+
+    def write(self, ostream):
+        """
+        Write the data encoding the ActivateResponsePayload object to a stream.
+
+        Args:
+            ostream (Stream): A data stream in which to encode object data,
+                supporting a write method; usually a BytearrayStream object.
+        """
+        tstream = BytearrayStream()
+
+        # Write the contents of the response payload
+        self.unique_identifier.write(tstream)
+
+        # Write the length and value of the request payload
+        self.length = tstream.length()
+        super(ActivateResponsePayload, self).write(ostream)
+        ostream.write(tstream.buffer)
+
+    def validate(self):
+        """
+        Error check the attributes of the ActivateRequestPayload object.
+        """
+        if not isinstance(self.unique_identifier, attributes.UniqueIdentifier):
+            msg = "invalid unique identifier"
+            raise TypeError(msg)