Package co.ankatech.ankasecure.sdk.client

Class StreamingApiClient

java.lang.Object
co.ankatech.secure.client.invoker.ApiClient
co.ankatech.ankasecure.sdk.client.StreamingApiClient
public class StreamingApiClient extends co.ankatech.secure.client.invoker.ApiClient
Extended ApiClient with streaming optimizations. This class wraps the generated ApiClient to add streaming-specific configurations without modifying the generated code.
Since:
3.1.0
Author:
AnkaSecure Team

  • Constructor Summary

    Constructors
    Constructor
    Description
    StreamingApiClient()
    Creates a new StreamingApiClient with default configuration.
    StreamingApiClient(co.ankatech.secure.client.invoker.ApiClient baseClient)
    Creates a new StreamingApiClient based on an existing ApiClient.

  • Method Summary

    Modifier and Type
    Method
    Description
    static StreamingApiClient
    create(String basePath, int connectTimeoutSec, int readTimeoutMin, int writeTimeoutMin)
    Creates a new streaming-optimized API client with custom configuration.
    StreamingApiClient
    enableStreaming()
    Enables streaming mode with optimized timeouts and configuration.
    StreamingApiClient
    enableStreaming(int connectTimeoutSeconds, int readTimeoutMinutes, int writeTimeoutMinutes)
    Enables streaming mode with custom timeouts.
    static StreamingApiClient
    fromStandard(co.ankatech.secure.client.invoker.ApiClient standardClient)
    Creates a new streaming-optimized API client from a standard one.
    boolean
    isStreamingMode()
    Checks if streaming mode is enabled.

    Methods inherited from class co.ankatech.secure.client.invoker.ApiClient

    addDefaultCookie, addDefaultHeader, buildCall, buildRequest, buildRequestBodyFormEncoding, buildRequestBodyMultipart, buildUrl, collectionPathParameterToString, deserialize, downloadFileFromResponse, escapeString, execute, execute, executeAsync, executeAsync, freeFormParameterToPairs, getAuthentication, getAuthentications, getBasePath, getConnectTimeout, getDateFormat, getHttpClient, getJSON, getKeyManagers, getReadTimeout, getServerIndex, getServers, getServerVariables, getSslCaCert, getTempFolderPath, getWriteTimeout, guessContentTypeFromFile, handleResponse, isDebugging, isJsonMime, isVerifyingSsl, parameterToPair, parameterToPairs, parameterToString, prepareDownloadFile, processCookieParams, processHeaderParams, sanitizeFilename, selectHeaderAccept, selectHeaderContentType, serialize, setAccessToken, setApiKey, setApiKeyPrefix, setAWS4Configuration, setAWS4Configuration, setBasePath, setBearerToken, setBearerToken, setConnectTimeout, setDateFormat, setDebugging, setHttpClient, setJSON, setKeyManagers, setLenientOnJson, setLocalDateFormat, setOffsetDateTimeFormat, setPassword, setReadTimeout, setServerIndex, setServers, setServerVariables, setSqlDateFormat, setSslCaCert, setTempFolderPath, setUserAgent, setUsername, setVerifyingSsl, setWriteTimeout, updateParamsForAuth

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StreamingApiClient

      public StreamingApiClient()
      Creates a new StreamingApiClient with default configuration.

    • StreamingApiClient

      public StreamingApiClient(co.ankatech.secure.client.invoker.ApiClient baseClient)
      Creates a new StreamingApiClient based on an existing ApiClient.
      Parameters:
      baseClient - the base ApiClient to copy configuration from

  • Method Details

    • enableStreaming

      public StreamingApiClient enableStreaming()
      Enables streaming mode with optimized timeouts and configuration.
      Returns:
      this instance for method chaining

    • enableStreaming

      public StreamingApiClient enableStreaming(int connectTimeoutSeconds, int readTimeoutMinutes, int writeTimeoutMinutes)
      Enables streaming mode with custom timeouts.
      Parameters:
      connectTimeoutSeconds - connection timeout in seconds
      readTimeoutMinutes - read timeout in minutes
      writeTimeoutMinutes - write timeout in minutes
      Returns:
      this instance for method chaining

    • isStreamingMode

      public boolean isStreamingMode()
      Checks if streaming mode is enabled.
      Returns:
      true if streaming mode is enabled

    • fromStandard

      public static StreamingApiClient fromStandard(co.ankatech.secure.client.invoker.ApiClient standardClient)
      Creates a new streaming-optimized API client from a standard one.
      Parameters:
      standardClient - the standard ApiClient
      Returns:
      a new StreamingApiClient with optimizations enabled

    • create

      public static StreamingApiClient create(String basePath, int connectTimeoutSec, int readTimeoutMin, int writeTimeoutMin)
      Creates a new streaming-optimized API client with custom configuration.
      Parameters:
      basePath - the base API path
      connectTimeoutSec - connection timeout in seconds
      readTimeoutMin - read timeout in minutes
      writeTimeoutMin - write timeout in minutes
      Returns:
      a configured StreamingApiClient