Add invalidate doc string to identity plugin

This was simply copied and pasted from the abstract method it overrides.

Change-Id: Ica349e7302434be43e08fc272e8fce5699553d9a
This commit is contained in:
Jamie Lennox
2014-06-12 13:15:12 +10:00
parent 2927a754c4
commit 871882c1e5

View File

@@ -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