From 871882c1e51a4c94c4c49535b472306f279bed58 Mon Sep 17 00:00:00 2001 From: Jamie Lennox Date: Thu, 12 Jun 2014 13:15:12 +1000 Subject: [PATCH] Add invalidate doc string to identity plugin This was simply copied and pasted from the abstract method it overrides. Change-Id: Ica349e7302434be43e08fc272e8fce5699553d9a --- keystoneclient/auth/identity/base.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/keystoneclient/auth/identity/base.py b/keystoneclient/auth/identity/base.py index 1f6a3c878..40dcf011e 100644 --- a/keystoneclient/auth/identity/base.py +++ b/keystoneclient/auth/identity/base.py @@ -97,6 +97,18 @@ class BaseIdentityPlugin(base.BaseAuthPlugin): return self.auth_ref def invalidate(self): + """Invalidate the current authentication data. + + This should result in fetching a new token on next call. + + A plugin may be invalidated if an Unauthorized HTTP response is + returned to indicate that the token may have been revoked or is + otherwise now invalid. + + :returns bool: True if there was something that the plugin did to + invalidate. This means that it makes sense to try again. + If nothing happens returns False to indicate give up. + """ self.auth_ref = None return True