Package com.google.auth.oauth2

Class PluggableAuthCredentialSource

java.lang.Object

com.google.auth.oauth2.ExternalAccountCredentials.CredentialSource

com.google.auth.oauth2.PluggableAuthCredentialSource

All Implemented Interfaces:

java.io.Serializable

public class PluggableAuthCredentialSource
extends ExternalAccountCredentials.CredentialSource

Encapsulates the credential source portion of the configuration for PluggableAuthCredentials.

Command is the only required field. If timeout_millis is not specified, the library will default to a 30 second timeout.

 Sample credential source for Pluggable Auth credentials:
 {
   ...
   "credential_source": {
     "executable": {
       "command": "/path/to/get/credentials.sh --arg1=value1 --arg2=value2",
       "timeout_millis": 5000,
       "output_file": "/path/to/generated/cached/credentials"
     }
   }
 }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	COMMAND_KEY
(package private) static int	DEFAULT_EXECUTABLE_TIMEOUT_MS
(package private) java.lang.String	executableCommand
(package private) int	executableTimeoutMs
(package private) static int	MAXIMUM_EXECUTABLE_TIMEOUT_MS
(package private) static int	MINIMUM_EXECUTABLE_TIMEOUT_MS
(package private) static java.lang.String	OUTPUT_FILE_KEY
(package private) java.lang.String	outputFilePath
(package private) static java.lang.String	TIMEOUT_MILLIS_KEY

Constructor Summary

Constructors

Constructor	Description
PluggableAuthCredentialSource(java.util.Map<java.lang.String,java.lang.Object> credentialSourceMap)

Method Summary

Modifier and Type	Method	Description
(package private) java.lang.String	getCommand()
(package private) java.lang.String	getOutputFilePath()
(package private) int	getTimeoutMs()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXECUTABLE_TIMEOUT_MS

static final int DEFAULT_EXECUTABLE_TIMEOUT_MS

See Also:

Constant Field Values

MINIMUM_EXECUTABLE_TIMEOUT_MS

static final int MINIMUM_EXECUTABLE_TIMEOUT_MS

See Also:

Constant Field Values

MAXIMUM_EXECUTABLE_TIMEOUT_MS

static final int MAXIMUM_EXECUTABLE_TIMEOUT_MS

See Also:

Constant Field Values

COMMAND_KEY

static final java.lang.String COMMAND_KEY

See Also:

Constant Field Values

TIMEOUT_MILLIS_KEY

static final java.lang.String TIMEOUT_MILLIS_KEY

See Also:

Constant Field Values

OUTPUT_FILE_KEY

static final java.lang.String OUTPUT_FILE_KEY

See Also:

Constant Field Values

executableCommand

final java.lang.String executableCommand

executableTimeoutMs

final int executableTimeoutMs

outputFilePath

@Nullable
final java.lang.String outputFilePath

Constructor Detail

PluggableAuthCredentialSource

public PluggableAuthCredentialSource(java.util.Map<java.lang.String,java.lang.Object> credentialSourceMap)

Method Detail

getCommand

java.lang.String getCommand()

getTimeoutMs

int getTimeoutMs()

getOutputFilePath

@Nullable
java.lang.String getOutputFilePath()