com.vendasta.common.v1

Interface CredentialsManager

All Known Implementing Classes:

GoogleCredentialsManager, VendastaCredentialsManager

public interface CredentialsManager

Method Summary

Modifier and Type	Method and Description
String	getAuthorization() Any implementation must be able to return an authorization string that can be used in an HTTP Authorization header.
void	invalidateAuthorization() The CredentialManager negotiates a credential, but it is not informed if that credential is invalidated for any reason other than expiry.

Method Detail

getAuthorization

String getAuthorization()
                 throws CredentialsException

Any implementation must be able to return an authorization string that can be used in an HTTP Authorization header. Most commonly this will be a Bearer Token.

Returns:

an id token

Throws:

CredentialsException

invalidateAuthorization

void invalidateAuthorization()
                      throws CredentialsException

The CredentialManager negotiates a credential, but it is not informed if that credential is invalidated for any reason other than expiry. This method allows clients to inform the CredentialManager that the token should be refreshed.

Throws:

CredentialsException