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

Class CloudPakForDataAuthenticator.Builder

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • build

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

      • url

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

      • username

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

      • password

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

      • apikey

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

      • disableSSLVerification

        public CloudPakForDataAuthenticator.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 CloudPakForData token service
        Returns:
        the Builder

      • headers

        public CloudPakForDataAuthenticator.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 CloudPakForData token service
        Returns:
        the Builder

      • proxy

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

      • proxyAuthenticator

        public CloudPakForDataAuthenticator.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 CloudPakForData token service
        Returns:
        the Builder