Java SDK errors, retries, and timeouts

​

Error handling

• TelnyxServiceException: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:

  Status	Exception
  400	BadRequestException
  401	UnauthorizedException
  403	PermissionDeniedException
  404	NotFoundException
  422	UnprocessableEntityException
  429	RateLimitException
  5xx	InternalServerException
  others	UnexpectedStatusCodeException

• TelnyxIoException: I/O networking errors.
• TelnyxRetryableException: Generic error indicating a failure that could be retried by the client.
• TelnyxInvalidDataException: Failure to interpret successfully parsed data. For example, when accessing a property that’s supposed to be required, but the API unexpectedly omitted it from the response.
• TelnyxException: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.

​

Network options

​

Retries

• Connection errors (for example, due to a network connectivity problem)
• 408 Request Timeout
• 409 Conflict
• 429 Rate Limit
• 5xx Internal

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.builder()
    .fromEnv()
    .maxRetries(4)
    .build();

​

Timeouts

import com.telnyx.sdk.models.calls.CallDialResponse;

CallDialResponse response = client.calls().dial(
  params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
);

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import java.time.Duration;

TelnyxClient client = TelnyxOkHttpClient.builder()
    .fromEnv()
    .timeout(Duration.ofSeconds(30))
    .build();

​

Proxies

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import java.net.InetSocketAddress;
import java.net.Proxy;

TelnyxClient client = TelnyxOkHttpClient.builder()
    .fromEnv()
    .proxy(new Proxy(
      Proxy.Type.HTTP, new InetSocketAddress(
        "https://example.com", 8080
      )
    ))
    .build();

​

HTTPS

[!NOTE] Most applications should not call these methods, and instead use the system defaults. The defaults include special optimizations that can be lost if the implementations are modified.

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

TelnyxClient client = TelnyxOkHttpClient.builder()
    .fromEnv()
    // If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.
    .sslSocketFactory(yourSSLSocketFactory)
    .trustManager(yourTrustManager)
    .hostnameVerifier(yourHostnameVerifier)
    .build();

​

Custom HTTP client

• telnyx-java-core
  • Contains core SDK logic
  • Does not depend on OkHttp
  • Exposes TelnyxClient, TelnyxClientAsync, TelnyxClientImpl, and TelnyxClientAsyncImpl, all of which can work with any HTTP client
• telnyx-java-client-okhttp
  • Depends on OkHttp
  • Exposes TelnyxOkHttpClient and TelnyxOkHttpClientAsync, which provide a way to construct TelnyxClientImpl and TelnyxClientAsyncImpl, respectively, using OkHttp
• telnyx-java
  • Depends on and exposes the APIs of both telnyx-java-core and telnyx-java-client-okhttp
  • Does not have its own logic

​

Customized OkHttpClient

[!TIP] Try the available network options before replacing the default client.

1. Replace your telnyx-java dependency with telnyx-java-core
2. Copy telnyx-java-client-okhttp’s OkHttpClient class into your code and customize it
3. Construct TelnyxClientImpl or TelnyxClientAsyncImpl, similarly to TelnyxOkHttpClient or TelnyxOkHttpClientAsync, using your customized client

​

Completely custom HTTP client

1. Replace your telnyx-java dependency with telnyx-java-core
2. Write a class that implements the HttpClient interface
3. Construct TelnyxClientImpl or TelnyxClientAsyncImpl, similarly to TelnyxOkHttpClient or TelnyxOkHttpClientAsync, using your new client class