Package com.stripe

Class Stripe

  • public abstract class Stripe
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Stripe()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getApiBase()  
      static java.util.Map<java.lang.String,​java.lang.String> getAppInfo()  
      static java.lang.String getConnectBase()  
      static java.net.Proxy getConnectionProxy()  
      static int getConnectTimeout()
      Returns the connection timeout.
      static int getMaxNetworkRetries()
      Returns the maximum number of times requests will be retried.
      static java.net.PasswordAuthentication getProxyCredential()  
      static int getReadTimeout()
      Returns the read timeout.
      static java.lang.String getUploadBase()  
      static void overrideApiBase​(java.lang.String overriddenApiBase)
      (FOR TESTING ONLY) If you'd like your API requests to hit your own (mocked) server, you can set this up here by overriding the base api URL.
      static void overrideConnectBase​(java.lang.String overriddenConnectBase)
      (FOR TESTING ONLY) If you'd like your OAuth requests to hit your own (mocked) server, you can set this up here by overriding the base Connect URL.
      static void overrideUploadBase​(java.lang.String overriddenUploadBase)
      (FOR TESTING ONLY) If you'd like your upload requests to hit your own (mocked) server, you can set this up here by overriding the base api URL.
      static void setAppInfo​(java.lang.String name)  
      static void setAppInfo​(java.lang.String name, java.lang.String version)  
      static void setAppInfo​(java.lang.String name, java.lang.String version, java.lang.String url)  
      static void setAppInfo​(java.lang.String name, java.lang.String version, java.lang.String url, java.lang.String partnerId)
      Sets information about your application.
      static void setConnectionProxy​(java.net.Proxy proxy)
      Set proxy to tunnel all Stripe connections.
      static void setConnectTimeout​(int timeout)
      Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).
      static void setMaxNetworkRetries​(int numRetries)
      Sets the maximum number of times requests will be retried.
      static void setProxyCredential​(java.net.PasswordAuthentication auth)
      Provide credential for proxy authorization if required.
      static void setReadTimeout​(int timeout)
      Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_CONNECT_TIMEOUT

        public static final int DEFAULT_CONNECT_TIMEOUT
        See Also:
        Constant Field Values

      • CONNECT_API_BASE

        public static final java.lang.String CONNECT_API_BASE
        See Also:
        Constant Field Values

      • apiKey

        public static volatile java.lang.String apiKey

      • clientId

        public static volatile java.lang.String clientId

      • enableTelemetry

        public static volatile boolean enableTelemetry

      • partnerId

        public static volatile java.lang.String partnerId

    • Constructor Detail

      • Stripe

        public Stripe()

    • Method Detail

      • overrideApiBase

        public static void overrideApiBase​(java.lang.String overriddenApiBase)
        (FOR TESTING ONLY) If you'd like your API requests to hit your own (mocked) server, you can set this up here by overriding the base api URL.

      • getApiBase

        public static java.lang.String getApiBase()

      • overrideConnectBase

        public static void overrideConnectBase​(java.lang.String overriddenConnectBase)
        (FOR TESTING ONLY) If you'd like your OAuth requests to hit your own (mocked) server, you can set this up here by overriding the base Connect URL.

      • getConnectBase

        public static java.lang.String getConnectBase()

      • overrideUploadBase

        public static void overrideUploadBase​(java.lang.String overriddenUploadBase)
        (FOR TESTING ONLY) If you'd like your upload requests to hit your own (mocked) server, you can set this up here by overriding the base api URL.

      • getUploadBase

        public static java.lang.String getUploadBase()

      • setConnectionProxy

        public static void setConnectionProxy​(java.net.Proxy proxy)
        Set proxy to tunnel all Stripe connections.
        Parameters:
        proxy - proxy host and port setting

      • getConnectionProxy

        public static java.net.Proxy getConnectionProxy()

      • getConnectTimeout

        public static int getConnectTimeout()
        Returns the connection timeout.
        Returns:
        timeout value in milliseconds

      • setConnectTimeout

        public static void setConnectTimeout​(int timeout)
        Sets the timeout value that will be used for making new connections to the Stripe API (in milliseconds).
        Parameters:
        timeout - timeout value in milliseconds

      • getReadTimeout

        public static int getReadTimeout()
        Returns the read timeout.
        Returns:
        timeout value in milliseconds

      • setReadTimeout

        public static void setReadTimeout​(int timeout)
        Sets the timeout value that will be used when reading data from an established connection to the Stripe API (in milliseconds).

        Note that this value should be set conservatively because some API requests can take time and a short timeout increases the likelihood of causing a problem in the backend.

        Parameters:
        timeout - timeout value in milliseconds

      • getMaxNetworkRetries

        public static int getMaxNetworkRetries()
        Returns the maximum number of times requests will be retried.
        Returns:
        the maximum number of times requests will be retried

      • setMaxNetworkRetries

        public static void setMaxNetworkRetries​(int numRetries)
        Sets the maximum number of times requests will be retried.
        Parameters:
        numRetries - the maximum number of times requests will be retried

      • setProxyCredential

        public static void setProxyCredential​(java.net.PasswordAuthentication auth)
        Provide credential for proxy authorization if required.
        Parameters:
        auth - proxy required userName and password

      • getProxyCredential

        public static java.net.PasswordAuthentication getProxyCredential()

      • setAppInfo

        public static void setAppInfo​(java.lang.String name)

      • setAppInfo

        public static void setAppInfo​(java.lang.String name,
                              java.lang.String version)

      • setAppInfo

        public static void setAppInfo​(java.lang.String name,
                              java.lang.String version,
                              java.lang.String url)

      • setAppInfo

        public static void setAppInfo​(java.lang.String name,
                              java.lang.String version,
                              java.lang.String url,
                              java.lang.String partnerId)
        Sets information about your application. The information is passed along to Stripe.
        Parameters:
        name - Name of your application (e.g. "MyAwesomeApp")
        version - Version of your application (e.g. "1.2.34")
        url - Website for your application (e.g. "https://myawesomeapp.info")
        partnerId - Your Stripe Partner ID (e.g. "pp_partner_1234")

      • getAppInfo

        public static java.util.Map<java.lang.String,​java.lang.String> getAppInfo()