Package org.nuxeo.runtime.aws

Interface AWSConfigurationService

All Known Implementing Classes:
AWSConfigurationServiceImpl
public interface AWSConfigurationService
The service providing AWS configuration.
Since:
10.3

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    configureProxy(software.amazon.awssdk.http.apache.ApacheHttpClient.Builder builder)
    Enriches the given ApacheHttpClient.Builder with default proxy configuration.
    void
    configureSSL(String id, software.amazon.awssdk.http.apache.ApacheHttpClient.Builder builder)
    Enriches the given client builder with an SSL socket factory from the given configuration.
    default void
    configureSSL(software.amazon.awssdk.http.apache.ApacheHttpClient.Builder builder)
    Enriches the given client builder with an SSL socket factory from the default configuration.
    default software.amazon.awssdk.auth.credentials.AwsCredentials
    getAwsCredentials()
    Gets the AWS Credentials for the default configuration.
    software.amazon.awssdk.auth.credentials.AwsCredentials
    getAwsCredentials(String id)
    Gets the AWS Credentials for the given configuration.
    default software.amazon.awssdk.regions.Region
    getAwsRegion()
    Gets the Aws Region for the default configuration.
    software.amazon.awssdk.regions.Region
    getAwsRegion(String id)
    Gets the AWS Region for the given configuration.

  • Method Details

    • getAwsCredentials

      default software.amazon.awssdk.auth.credentials.AwsCredentials getAwsCredentials()
      Gets the AWS Credentials for the default configuration.
      Returns:
      the AWS credentials, or null if not defined

    • getAwsCredentials

      software.amazon.awssdk.auth.credentials.AwsCredentials getAwsCredentials(String id)
      Gets the AWS Credentials for the given configuration.
      Parameters:
      id - the configuration id, or null for the default
      Returns:
      the AWS credentials, or null if not defined
      Since:
      11.1

    • configureSSL

      default void configureSSL(software.amazon.awssdk.http.apache.ApacheHttpClient.Builder builder)
      Enriches the given client builder with an SSL socket factory from the default configuration.
      Parameters:
      builder - the http client builder
      Since:
      2025.0

    • configureSSL

      void configureSSL(String id, software.amazon.awssdk.http.apache.ApacheHttpClient.Builder builder)
      Enriches the given client builder with an SSL socket factory from the given configuration.
      Parameters:
      id - the custom configuration id
      builder - the http client builder
      Since:
      2025.0

    • configureProxy

      default void configureProxy(software.amazon.awssdk.http.apache.ApacheHttpClient.Builder builder)
      Enriches the given ApacheHttpClient.Builder with default proxy configuration.
      Parameters:
      builder - the http client builder
      Since:
      2025.0

    • getAwsRegion

      default software.amazon.awssdk.regions.Region getAwsRegion()
      Gets the Aws Region for the default configuration.
      Returns:
      the Aws Region, or null if not defined
      Since:
      2023.1

    • getAwsRegion

      software.amazon.awssdk.regions.Region getAwsRegion(String id)
      Gets the AWS Region for the given configuration.
      Parameters:
      id - the configuration id, or null for the default
      Returns:
      the AWS Region, or null if not defined
      Since:
      2023.1