Class PluggableAuthHandler

java.lang.Object

com.google.auth.oauth2.PluggableAuthHandler

All Implemented Interfaces:

ExecutableHandler

final class PluggableAuthHandler
extends Object
implements ExecutableHandler

Internal handler for retrieving 3rd party tokens from user defined scripts/executables for workload identity federation.

See PluggableAuthCredentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	PluggableAuthHandler.DefaultProcessBuilder	A default implementation for PluggableAuthHandler.InternalProcessBuilder that wraps ProcessBuilder.
(package private) static class	PluggableAuthHandler.InternalProcessBuilder	An interface for creating and managing a process.

Nested classes/interfaces inherited from interface ExecutableHandler

ExecutableHandler.ExecutableOptions

Field Summary

Fields

Modifier and Type	Field	Description
private final EnvironmentProvider	environmentProvider
private static final int	EXECUTABLE_SUPPORTED_MAX_VERSION
private static final int	EXIT_CODE_SUCCESS
private static final String	GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES
private PluggableAuthHandler.InternalProcessBuilder	internalProcessBuilder

Constructor Summary

Constructors

Constructor	Description
PluggableAuthHandler(EnvironmentProvider environmentProvider)
PluggableAuthHandler(EnvironmentProvider environmentProvider, PluggableAuthHandler.InternalProcessBuilder internalProcessBuilder)

Method Summary

Modifier and Type	Method	Description
(package private) ExecutableResponse	getCachedExecutableResponse(ExecutableHandler.ExecutableOptions options)
(package private) ExecutableResponse	getExecutableResponse(ExecutableHandler.ExecutableOptions options)
(package private) PluggableAuthHandler.InternalProcessBuilder	getProcessBuilder(List<String> commandComponents)
String	retrieveTokenFromExecutable(ExecutableHandler.ExecutableOptions options)	Handles executing the 3rd party script and parsing the token from the response.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXECUTABLE_SUPPORTED_MAX_VERSION

private static final int EXECUTABLE_SUPPORTED_MAX_VERSION

See Also:

• Constant Field Values

GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES

private static final String GOOGLE_EXTERNAL_ACCOUNT_ALLOW_EXECUTABLES

See Also:

• Constant Field Values

EXIT_CODE_SUCCESS

private static final int EXIT_CODE_SUCCESS

See Also:

• Constant Field Values

environmentProvider

private final EnvironmentProvider environmentProvider

internalProcessBuilder

private PluggableAuthHandler.InternalProcessBuilder internalProcessBuilder

Constructor Details

PluggableAuthHandler

PluggableAuthHandler(EnvironmentProvider environmentProvider)

PluggableAuthHandler

PluggableAuthHandler(EnvironmentProvider environmentProvider,
 PluggableAuthHandler.InternalProcessBuilder internalProcessBuilder)

Method Details

retrieveTokenFromExecutable

public String retrieveTokenFromExecutable(ExecutableHandler.ExecutableOptions options)
                                   throws IOException

Description copied from interface: ExecutableHandler

Handles executing the 3rd party script and parsing the token from the response.

Specified by:

retrieveTokenFromExecutable in interface ExecutableHandler

Parameters:

options - A set executable options for handling the executable.

Returns:

A 3rd party token.

Throws:

IOException

getCachedExecutableResponse

@Nullable
ExecutableResponse getCachedExecutableResponse(ExecutableHandler.ExecutableOptions options)
                                        throws PluggableAuthException

Throws:

PluggableAuthException

getExecutableResponse

ExecutableResponse getExecutableResponse(ExecutableHandler.ExecutableOptions options)
                                  throws IOException

Throws:

IOException

getProcessBuilder

PluggableAuthHandler.InternalProcessBuilder getProcessBuilder(List<String> commandComponents)