Package software.amazon.awssdk.core.warmup

Interface SdkWarmUpProvider

@ThreadSafe @SdkProtectedApi public interface SdkWarmUpProvider
Service Provider Interface for warming up an SDK service's request path before a Coordinated Restore at Checkpoint (CRaC) checkpoint. The SDK discovers implementations on the classpath with ServiceLoader. An implementation registers itself in the META-INF/services/software.amazon.awssdk.core.warmup.SdkWarmUpProvider resource.

Implementations must be thread safe.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    asyncClientClassName()
    The fully qualified name of the async service client this provider warms (for example "software.amazon.awssdk.services.s3.S3AsyncClient"), or null if the service has no async client.
    String
    syncClientClassName()
    The fully qualified name of the sync service client this provider warms (for example "software.amazon.awssdk.services.s3.S3Client"), or null if the service has no sync client.
    default void
    warmUp()
    Exercises the service's request path so the Just-In-Time compiled code is captured in a CRaC snapshot.
    void
    warmUpClient(ClientType clientType)
    Exercises only the request path of the given client type: ClientType.SYNC warms the sync client, ClientType.ASYNC the async client.

  • Method Details

    • warmUp

      default void warmUp()
      Exercises the service's request path so the Just-In-Time compiled code is captured in a CRaC snapshot. The sync and async clients are warmed independently: a failure warming one is logged at warn and does not stop the other.

    • syncClientClassName

      String syncClientClassName()
      The fully qualified name of the sync service client this provider warms (for example "software.amazon.awssdk.services.s3.S3Client"), or null if the service has no sync client.

    • asyncClientClassName

      String asyncClientClassName()
      The fully qualified name of the async service client this provider warms (for example "software.amazon.awssdk.services.s3.S3AsyncClient"), or null if the service has no async client.

    • warmUpClient

      void warmUpClient(ClientType clientType)
      Exercises only the request path of the given client type: ClientType.SYNC warms the sync client, ClientType.ASYNC the async client. Any other value is a no-op.