io.kubernetes.client.util.authenticators

Interface Authenticator

All Known Implementing Classes:

AzureActiveDirectoryAuthenticator, GCPAuthenticator

public interface Authenticator

The Authenticator interface represents a plugin that can handle a specific type of authentication information (e.g. 'gcp')

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Return the name of this authenticator, this should be the value that is also in a kubeconfig file.
java.lang.String	getToken(java.util.Map<java.lang.String,java.lang.Object> config) Get a token from this authenticator.
boolean	isExpired(java.util.Map<java.lang.String,java.lang.Object> config) Determine if this config is expired
java.util.Map<java.lang.String,java.lang.Object>	refresh(java.util.Map<java.lang.String,java.lang.Object> config) Refresh an expired token with a new fresh one.

Method Detail

getName

java.lang.String getName()

Return the name of this authenticator, this should be the value that is also in a kubeconfig file.

getToken

java.lang.String getToken(java.util.Map<java.lang.String,java.lang.Object> config)

Get a token from this authenticator.

Parameters:

config - The configuration information for this authenticator

Returns:

The new token, null of no such token can be found/generated

isExpired

boolean isExpired(java.util.Map<java.lang.String,java.lang.Object> config)

Determine if this config is expired

refresh

java.util.Map<java.lang.String,java.lang.Object> refresh(java.util.Map<java.lang.String,java.lang.Object> config)

Refresh an expired token with a new fresh one.