Merge from trunk

[plcapi.git] / trunk / PLC / Methods / BlacklistKey.py

diff --git a/trunk/PLC/Methods/BlacklistKey.py b/trunk/PLC/Methods/BlacklistKey.py
new file mode 100644 (file)
index 0000000..7953e7a
--- /dev/null
+++ b/trunk/PLC/Methods/BlacklistKey.py
@@ -0,0 +1,42 @@
+from PLC.Faults import *
+from PLC.Method import Method
+from PLC.Parameter import Parameter, Mixed
+from PLC.Keys import Key, Keys
+from PLC.Auth import Auth
+
+class BlacklistKey(Method):
+    """
+    Blacklists a key, disassociating it and all others identical to it
+    from all accounts and preventing it from ever being added again.
+
+    WARNING: Identical keys associated with other accounts with also
+    be blacklisted.
+
+    Returns 1 if successful, faults otherwise.
+    """
+
+    roles = ['admin']
+
+    accepts = [
+        Auth(),
+        Key.fields['key_id'],
+        ]
+
+    returns = Parameter(int, '1 if successful')
+   
+    def call(self, auth, key_id):
+        # Get associated key details
+        keys = Keys(self.api, [key_id])
+        if not keys:
+            raise PLCInvalidArgument, "No such key"
+        key = keys[0]
+
+        # N.B.: Can blacklist any key, even foreign ones
+
+        key.blacklist()
+       
+       # Logging variables
+       self.event_objects = {'Key': [key['key_id']]}
+       self.message = 'Key %d blacklisted' % key['key_id']
+
+        return 1