Package com.ibm.cloud.sdk.core.security

Class ContainerAuthenticator.Builder

  • Enclosing class:
    ContainerAuthenticator
    public static class ContainerAuthenticator.Builder
extends java.lang.Object
    This Builder class is used to construct ContainerAuthenticator instances.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • build

        public ContainerAuthenticator build()
        Constructs a new instance of ContainerAuthenticator from the builder's configuration.
        Returns:
        the ContainerAuthenticator instance

      • crTokenFilename

        public ContainerAuthenticator.Builder crTokenFilename​(java.lang.String crTokenFilename)
        Sets the crTokenFilename property.
        Parameters:
        crTokenFilename - the name of the file to use when retrieving the compute resource token from the local compute resource
        Returns:
        the Builder

      • iamProfileName

        public ContainerAuthenticator.Builder iamProfileName​(java.lang.String iamProfileName)
        Sets the iamProfileName property.
        Parameters:
        iamProfileName - the name of the linked trusted IAM profile to use when interacting with the IAM token service to obtain the IAM access token. One of 'iamProfileName' or 'iamProfileId' must be specified.
        Returns:
        the Builder

      • iamProfileId

        public ContainerAuthenticator.Builder iamProfileId​(java.lang.String iamProfileId)
        Sets the iamProfileId property.
        Parameters:
        iamProfileId - the id of the linked trusted IAM profile to use when interacting with the IAM token service to obtain the IAM access token. One of 'iamProfileName' or 'iamProfileId' must be specified.
        Returns:
        the Builder

      • url

        public ContainerAuthenticator.Builder url​(java.lang.String url)
        Sets the url property.
        Parameters:
        url - the base url to use with the IAM token service
        Returns:
        the Builder

      • clientId

        public ContainerAuthenticator.Builder clientId​(java.lang.String clientId)
        Sets the clientId property.
        Parameters:
        clientId - the clientId to use when retrieving an access token
        Returns:
        the Builder

      • clientSecret

        public ContainerAuthenticator.Builder clientSecret​(java.lang.String clientSecret)
        Sets the clientSecret property.
        Parameters:
        clientSecret - the clientSecret to use when retrieving an access token
        Returns:
        the Builder

      • scope

        public ContainerAuthenticator.Builder scope​(java.lang.String scope)
        Sets the scope property.
        Parameters:
        scope - the scope to use when retrieving an access token
        Returns:
        the Builder

      • disableSSLVerification

        public ContainerAuthenticator.Builder disableSSLVerification​(boolean disableSSLVerification)
        Sets the disableSSLVerification property.
        Parameters:
        disableSSLVerification - a boolean flag indicating whether or not SSL verification should be disabled when interacting with the IAM token service
        Returns:
        the Builder

      • headers

        public ContainerAuthenticator.Builder headers​(java.util.Map<java.lang.String,​java.lang.String> headers)
        Sets the headers property.
        Parameters:
        headers - the set of custom headers to include in requests sent to the IAM token service
        Returns:
        the Builder

      • proxy

        public ContainerAuthenticator.Builder proxy​(java.net.Proxy proxy)
        Sets the proxy property.
        Parameters:
        proxy - the java.net.Proxy instance to be used when interacting with the IAM token server
        Returns:
        the Builder

      • proxyAuthenticator

        public ContainerAuthenticator.Builder proxyAuthenticator​(okhttp3.Authenticator proxyAuthenticator)
        Sets the proxyAuthenticator property.
        Parameters:
        proxyAuthenticator - the okhttp3.Authenticator instance to be used with the proxy when interacting with the IAM token service
        Returns:
        the Builder