All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.oracle.bmc.apigateway.ApiGatewayClient Maven / Gradle / Ivy

There is a newer version: 3.55.1
Show newest version
/**
 * Copyright (c) 2016, 2020, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.apigateway;

import java.util.Locale;
import com.oracle.bmc.apigateway.internal.http.*;
import com.oracle.bmc.apigateway.requests.*;
import com.oracle.bmc.apigateway.responses.*;

@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501")
@lombok.extern.slf4j.Slf4j
public class ApiGatewayClient implements ApiGateway {
    /**
     * Service instance for ApiGateway.
     */
    public static final com.oracle.bmc.Service SERVICE =
            com.oracle.bmc.Services.serviceBuilder()
                    .serviceName("APIGATEWAY")
                    .serviceEndpointPrefix("")
                    .serviceEndpointTemplate("https://apigateway.{region}.oci.{secondLevelDomain}")
                    .build();
    // attempt twice if it's instance principals, immediately failures will try to refresh the token
    private static final int MAX_IMMEDIATE_RETRIES_IF_USING_INSTANCE_PRINCIPALS = 2;

    private final ApiGatewayWaiters waiters;

    private final ApiGatewayPaginators paginators;

    @lombok.Getter(value = lombok.AccessLevel.PACKAGE)
    private final com.oracle.bmc.http.internal.RestClient client;

    private final com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
            authenticationDetailsProvider;
    private final com.oracle.bmc.retrier.RetryConfiguration retryConfiguration;

    /**
     * Creates a new service instance using the given authentication provider.
     * @param authenticationDetailsProvider The authentication details provider, required.
     */
    public ApiGatewayClient(
            com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider) {
        this(authenticationDetailsProvider, null);
    }

    /**
     * Creates a new service instance using the given authentication provider and client configuration.
     * @param authenticationDetailsProvider The authentication details provider, required.
     * @param configuration The client configuration, optional.
     */
    public ApiGatewayClient(
            com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
            com.oracle.bmc.ClientConfiguration configuration) {
        this(authenticationDetailsProvider, configuration, null);
    }

    /**
     * Creates a new service instance using the given authentication provider and client configuration.  Additionally,
     * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
     * @param authenticationDetailsProvider The authentication details provider, required.
     * @param configuration The client configuration, optional.
     * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
     */
    public ApiGatewayClient(
            com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
            com.oracle.bmc.ClientConfiguration configuration,
            com.oracle.bmc.http.ClientConfigurator clientConfigurator) {
        this(
                authenticationDetailsProvider,
                configuration,
                clientConfigurator,
                new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory(
                        com.oracle.bmc.http.signing.SigningStrategy.STANDARD));
    }

    /**
     * Creates a new service instance using the given authentication provider and client configuration.  Additionally,
     * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
     * 

* This is an advanced constructor for clients that want to take control over how requests are signed. * @param authenticationDetailsProvider The authentication details provider, required. * @param configuration The client configuration, optional. * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional. * @param defaultRequestSignerFactory The request signer factory used to create the request signer for this service. */ public ApiGatewayClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory) { this( authenticationDetailsProvider, configuration, clientConfigurator, defaultRequestSignerFactory, new java.util.ArrayList()); } /** * Creates a new service instance using the given authentication provider and client configuration. Additionally, * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization. *

* This is an advanced constructor for clients that want to take control over how requests are signed. * @param authenticationDetailsProvider The authentication details provider, required. * @param configuration The client configuration, optional. * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional. * @param defaultRequestSignerFactory The request signer factory used to create the request signer for this service. * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator. */ public ApiGatewayClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.List additionalClientConfigurators) { this( authenticationDetailsProvider, configuration, clientConfigurator, defaultRequestSignerFactory, additionalClientConfigurators, null); } /** * Creates a new service instance using the given authentication provider and client configuration. Additionally, * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization. *

* This is an advanced constructor for clients that want to take control over how requests are signed. * @param authenticationDetailsProvider The authentication details provider, required. * @param configuration The client configuration, optional. * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional. * @param defaultRequestSignerFactory The request signer factory used to create the request signer for this service. * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator. * @param endpoint Endpoint, or null to leave unset (note, may be overridden by {@code authenticationDetailsProvider}) */ public ApiGatewayClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.List additionalClientConfigurators, String endpoint) { this( authenticationDetailsProvider, configuration, clientConfigurator, defaultRequestSignerFactory, com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory .createDefaultRequestSignerFactories(), additionalClientConfigurators, endpoint); } /** * Creates a new service instance using the given authentication provider and client configuration. Additionally, * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization. *

* This is an advanced constructor for clients that want to take control over how requests are signed. * @param authenticationDetailsProvider The authentication details provider, required. * @param configuration The client configuration, optional. * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional. * @param defaultRequestSignerFactory The request signer factory used to create the request signer for this service. * @param signingStrategyRequestSignerFactories The request signer factories for each signing strategy used to create the request signer * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator. * @param endpoint Endpoint, or null to leave unset (note, may be overridden by {@code authenticationDetailsProvider}) */ public ApiGatewayClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.Map< com.oracle.bmc.http.signing.SigningStrategy, com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories, java.util.List additionalClientConfigurators, String endpoint) { this( authenticationDetailsProvider, configuration, clientConfigurator, defaultRequestSignerFactory, signingStrategyRequestSignerFactories, additionalClientConfigurators, endpoint, null); } /** * Creates a new service instance using the given authentication provider and client configuration. Additionally, * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization. *

* This is an advanced constructor for clients that want to take control over how requests are signed. * @param authenticationDetailsProvider The authentication details provider, required. * @param configuration The client configuration, optional. * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional. * @param defaultRequestSignerFactory The request signer factory used to create the request signer for this service. * @param signingStrategyRequestSignerFactories The request signer factories for each signing strategy used to create the request signer * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator. * @param endpoint Endpoint, or null to leave unset (note, may be overridden by {@code authenticationDetailsProvider}) * @param executorService ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor */ public ApiGatewayClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.Map< com.oracle.bmc.http.signing.SigningStrategy, com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories, java.util.List additionalClientConfigurators, String endpoint, java.util.concurrent.ExecutorService executorService) { this( authenticationDetailsProvider, configuration, clientConfigurator, defaultRequestSignerFactory, signingStrategyRequestSignerFactories, additionalClientConfigurators, endpoint, executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder.builder()); } /** * Creates a new service instance using the given authentication provider and client configuration. Additionally, * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization. *

* This is an advanced constructor for clients that want to take control over how requests are signed. * Use the {@link Builder} to get access to all these parameters. * * @param authenticationDetailsProvider The authentication details provider, required. * @param configuration The client configuration, optional. * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional. * @param defaultRequestSignerFactory The request signer factory used to create the request signer for this service. * @param signingStrategyRequestSignerFactories The request signer factories for each signing strategy used to create the request signer * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator. * @param endpoint Endpoint, or null to leave unset (note, may be overridden by {@code authenticationDetailsProvider}) * @param executorService ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor * @param restClientFactoryBuilder the builder for the {@link com.oracle.bmc.http.internal.RestClientFactory} */ protected ApiGatewayClient( com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider, com.oracle.bmc.ClientConfiguration configuration, com.oracle.bmc.http.ClientConfigurator clientConfigurator, com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory, java.util.Map< com.oracle.bmc.http.signing.SigningStrategy, com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories, java.util.List additionalClientConfigurators, String endpoint, java.util.concurrent.ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder) { this.authenticationDetailsProvider = authenticationDetailsProvider; java.util.List authenticationDetailsConfigurators = new java.util.ArrayList<>(); if (this.authenticationDetailsProvider instanceof com.oracle.bmc.auth.ProvidesClientConfigurators) { authenticationDetailsConfigurators.addAll( ((com.oracle.bmc.auth.ProvidesClientConfigurators) this.authenticationDetailsProvider) .getClientConfigurators()); } additionalClientConfigurators.addAll(authenticationDetailsConfigurators); com.oracle.bmc.http.internal.RestClientFactory restClientFactory = restClientFactoryBuilder .clientConfigurator(clientConfigurator) .additionalClientConfigurators(additionalClientConfigurators) .build(); com.oracle.bmc.http.signing.RequestSigner defaultRequestSigner = defaultRequestSignerFactory.createRequestSigner( SERVICE, this.authenticationDetailsProvider); java.util.Map< com.oracle.bmc.http.signing.SigningStrategy, com.oracle.bmc.http.signing.RequestSigner> requestSigners = new java.util.HashMap<>(); if (this.authenticationDetailsProvider instanceof com.oracle.bmc.auth.BasicAuthenticationDetailsProvider) { for (com.oracle.bmc.http.signing.SigningStrategy s : com.oracle.bmc.http.signing.SigningStrategy.values()) { requestSigners.put( s, signingStrategyRequestSignerFactories .get(s) .createRequestSigner(SERVICE, authenticationDetailsProvider)); } } final com.oracle.bmc.ClientConfiguration clientConfigurationToUse = (configuration != null) ? configuration : com.oracle.bmc.ClientConfiguration.builder().build(); this.retryConfiguration = clientConfigurationToUse.getRetryConfiguration(); this.client = restClientFactory.create( defaultRequestSigner, requestSigners, clientConfigurationToUse); if (executorService == null) { // up to 50 (core) threads, time out after 60s idle, all daemon java.util.concurrent.ThreadPoolExecutor threadPoolExecutor = new java.util.concurrent.ThreadPoolExecutor( 50, 50, 60L, java.util.concurrent.TimeUnit.SECONDS, new java.util.concurrent.LinkedBlockingQueue(), new com.google.common.util.concurrent.ThreadFactoryBuilder() .setDaemon(true) .setNameFormat("ApiGateway-waiters-%d") .build()); threadPoolExecutor.allowCoreThreadTimeOut(true); executorService = threadPoolExecutor; } this.waiters = new ApiGatewayWaiters(executorService, this); this.paginators = new ApiGatewayPaginators(this); if (this.authenticationDetailsProvider instanceof com.oracle.bmc.auth.RegionProvider) { com.oracle.bmc.auth.RegionProvider provider = (com.oracle.bmc.auth.RegionProvider) this.authenticationDetailsProvider; if (provider.getRegion() != null) { this.setRegion(provider.getRegion()); if (endpoint != null) { LOG.info( "Authentication details provider configured for region '{}', but endpoint specifically set to '{}'. Using endpoint setting instead of region.", provider.getRegion(), endpoint); } } } if (endpoint != null) { setEndpoint(endpoint); } } /** * Create a builder for this client. * @return builder */ public static Builder builder() { return new Builder(SERVICE); } /** * Builder class for this client. The "authenticationDetailsProvider" is required and must be passed to the * {@link #build(AbstractAuthenticationDetailsProvider)} method. */ public static class Builder extends com.oracle.bmc.common.RegionalClientBuilder { private java.util.concurrent.ExecutorService executorService; private Builder(com.oracle.bmc.Service service) { super(service); requestSignerFactory = new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory( com.oracle.bmc.http.signing.SigningStrategy.STANDARD); } /** * Set the ExecutorService for the client to be created. * @param executorService executorService * @return this builder */ public Builder executorService(java.util.concurrent.ExecutorService executorService) { this.executorService = executorService; return this; } /** * Build the client. * @param authenticationDetailsProvider authentication details provider * @return the client */ public ApiGatewayClient build( @lombok.NonNull com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider) { return new ApiGatewayClient( authenticationDetailsProvider, configuration, clientConfigurator, requestSignerFactory, signingStrategyRequestSignerFactories, additionalClientConfigurators, endpoint, executorService); } } @Override public void setEndpoint(String endpoint) { LOG.info("Setting endpoint to {}", endpoint); client.setEndpoint(endpoint); } @Override public String getEndpoint() { String endpoint = null; java.net.URI uri = client.getBaseTarget().getUri(); if (uri != null) { endpoint = uri.toString(); } return endpoint; } @Override public void setRegion(com.oracle.bmc.Region region) { com.google.common.base.Optional endpoint = region.getEndpoint(SERVICE); if (endpoint.isPresent()) { setEndpoint(endpoint.get()); } else { throw new IllegalArgumentException( "Endpoint for " + SERVICE + " is not known in region " + region); } } @Override public void setRegion(String regionId) { regionId = regionId.toLowerCase(Locale.ENGLISH); try { com.oracle.bmc.Region region = com.oracle.bmc.Region.fromRegionId(regionId); setRegion(region); } catch (IllegalArgumentException e) { LOG.info("Unknown regionId '{}', falling back to default endpoint format", regionId); String endpoint = com.oracle.bmc.Region.formatDefaultRegionEndpoint(SERVICE, regionId); setEndpoint(endpoint); } } @Override public void close() { client.close(); } @Override public ChangeCertificateCompartmentResponse changeCertificateCompartment( ChangeCertificateCompartmentRequest request) { LOG.trace("Called changeCertificateCompartment"); final ChangeCertificateCompartmentRequest interceptedRequest = ChangeCertificateCompartmentConverter.interceptRequest(request); com.oracle.bmc.http.internal.WrappedInvocationBuilder ib = ChangeCertificateCompartmentConverter.fromRequest(client, interceptedRequest); com.google.common.base.Function< javax.ws.rs.core.Response, ChangeCertificateCompartmentResponse> transformer = ChangeCertificateCompartmentConverter.fromResponse(); final com.oracle.bmc.retrier.BmcGenericRetrier retrier = com.oracle.bmc.retrier.Retriers.createPreferredRetrier( interceptedRequest.getRetryConfiguration(), retryConfiguration); return retrier.execute( interceptedRequest, retryRequest -> { final com.oracle.bmc.retrier.TokenRefreshRetrier tokenRefreshRetrier = new com.oracle.bmc.retrier.TokenRefreshRetrier( authenticationDetailsProvider); return tokenRefreshRetrier.execute( retryRequest, retriedRequest -> { javax.ws.rs.core.Response response = client.post( ib, retriedRequest .getChangeCertificateCompartmentDetails(), retriedRequest); return transformer.apply(response); }); }); } @Override public CreateCertificateResponse createCertificate(CreateCertificateRequest request) { LOG.trace("Called createCertificate"); final CreateCertificateRequest interceptedRequest = CreateCertificateConverter.interceptRequest(request); com.oracle.bmc.http.internal.WrappedInvocationBuilder ib = CreateCertificateConverter.fromRequest(client, interceptedRequest); com.google.common.base.Function transformer = CreateCertificateConverter.fromResponse(); final com.oracle.bmc.retrier.BmcGenericRetrier retrier = com.oracle.bmc.retrier.Retriers.createPreferredRetrier( interceptedRequest.getRetryConfiguration(), retryConfiguration); return retrier.execute( interceptedRequest, retryRequest -> { final com.oracle.bmc.retrier.TokenRefreshRetrier tokenRefreshRetrier = new com.oracle.bmc.retrier.TokenRefreshRetrier( authenticationDetailsProvider); return tokenRefreshRetrier.execute( retryRequest, retriedRequest -> { javax.ws.rs.core.Response response = client.post( ib, retriedRequest.getCreateCertificateDetails(), retriedRequest); return transformer.apply(response); }); }); } @Override public DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request) { LOG.trace("Called deleteCertificate"); final DeleteCertificateRequest interceptedRequest = DeleteCertificateConverter.interceptRequest(request); com.oracle.bmc.http.internal.WrappedInvocationBuilder ib = DeleteCertificateConverter.fromRequest(client, interceptedRequest); com.google.common.base.Function transformer = DeleteCertificateConverter.fromResponse(); final com.oracle.bmc.retrier.BmcGenericRetrier retrier = com.oracle.bmc.retrier.Retriers.createPreferredRetrier( interceptedRequest.getRetryConfiguration(), retryConfiguration); return retrier.execute( interceptedRequest, retryRequest -> { final com.oracle.bmc.retrier.TokenRefreshRetrier tokenRefreshRetrier = new com.oracle.bmc.retrier.TokenRefreshRetrier( authenticationDetailsProvider); return tokenRefreshRetrier.execute( retryRequest, retriedRequest -> { javax.ws.rs.core.Response response = client.delete(ib, retriedRequest); return transformer.apply(response); }); }); } @Override public GetCertificateResponse getCertificate(GetCertificateRequest request) { LOG.trace("Called getCertificate"); final GetCertificateRequest interceptedRequest = GetCertificateConverter.interceptRequest(request); com.oracle.bmc.http.internal.WrappedInvocationBuilder ib = GetCertificateConverter.fromRequest(client, interceptedRequest); com.google.common.base.Function transformer = GetCertificateConverter.fromResponse(); final com.oracle.bmc.retrier.BmcGenericRetrier retrier = com.oracle.bmc.retrier.Retriers.createPreferredRetrier( interceptedRequest.getRetryConfiguration(), retryConfiguration); return retrier.execute( interceptedRequest, retryRequest -> { final com.oracle.bmc.retrier.TokenRefreshRetrier tokenRefreshRetrier = new com.oracle.bmc.retrier.TokenRefreshRetrier( authenticationDetailsProvider); return tokenRefreshRetrier.execute( retryRequest, retriedRequest -> { javax.ws.rs.core.Response response = client.get(ib, retriedRequest); return transformer.apply(response); }); }); } @Override public ListCertificatesResponse listCertificates(ListCertificatesRequest request) { LOG.trace("Called listCertificates"); final ListCertificatesRequest interceptedRequest = ListCertificatesConverter.interceptRequest(request); com.oracle.bmc.http.internal.WrappedInvocationBuilder ib = ListCertificatesConverter.fromRequest(client, interceptedRequest); com.google.common.base.Function transformer = ListCertificatesConverter.fromResponse(); final com.oracle.bmc.retrier.BmcGenericRetrier retrier = com.oracle.bmc.retrier.Retriers.createPreferredRetrier( interceptedRequest.getRetryConfiguration(), retryConfiguration); return retrier.execute( interceptedRequest, retryRequest -> { final com.oracle.bmc.retrier.TokenRefreshRetrier tokenRefreshRetrier = new com.oracle.bmc.retrier.TokenRefreshRetrier( authenticationDetailsProvider); return tokenRefreshRetrier.execute( retryRequest, retriedRequest -> { javax.ws.rs.core.Response response = client.get(ib, retriedRequest); return transformer.apply(response); }); }); } @Override public UpdateCertificateResponse updateCertificate(UpdateCertificateRequest request) { LOG.trace("Called updateCertificate"); final UpdateCertificateRequest interceptedRequest = UpdateCertificateConverter.interceptRequest(request); com.oracle.bmc.http.internal.WrappedInvocationBuilder ib = UpdateCertificateConverter.fromRequest(client, interceptedRequest); com.google.common.base.Function transformer = UpdateCertificateConverter.fromResponse(); final com.oracle.bmc.retrier.BmcGenericRetrier retrier = com.oracle.bmc.retrier.Retriers.createPreferredRetrier( interceptedRequest.getRetryConfiguration(), retryConfiguration); return retrier.execute( interceptedRequest, retryRequest -> { final com.oracle.bmc.retrier.TokenRefreshRetrier tokenRefreshRetrier = new com.oracle.bmc.retrier.TokenRefreshRetrier( authenticationDetailsProvider); return tokenRefreshRetrier.execute( retryRequest, retriedRequest -> { javax.ws.rs.core.Response response = client.put( ib, retriedRequest.getUpdateCertificateDetails(), retriedRequest); return transformer.apply(response); }); }); } @Override public ApiGatewayWaiters getWaiters() { return waiters; } @Override public ApiGatewayPaginators getPaginators() { return paginators; } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy