com.oracle.bmc.apigateway.WorkRequestsClient Maven / Gradle / Ivy
Show all versions of oci-java-sdk-apigateway Show documentation
/**
* 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 WorkRequestsClient implements WorkRequests {
/**
* Service instance for WorkRequests.
*/
public static final com.oracle.bmc.Service SERVICE =
com.oracle.bmc.Services.serviceBuilder()
.serviceName("WORKREQUESTS")
.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 WorkRequestsWaiters waiters;
private final WorkRequestsPaginators 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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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 WorkRequestsClient(
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("WorkRequests-waiters-%d")
.build());
threadPoolExecutor.allowCoreThreadTimeOut(true);
executorService = threadPoolExecutor;
}
this.waiters = new WorkRequestsWaiters(executorService, this);
this.paginators = new WorkRequestsPaginators(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 WorkRequestsClient build(
@lombok.NonNull
com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
authenticationDetailsProvider) {
return new WorkRequestsClient(
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 CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request) {
LOG.trace("Called cancelWorkRequest");
final CancelWorkRequestRequest interceptedRequest =
CancelWorkRequestConverter.interceptRequest(request);
com.oracle.bmc.http.internal.WrappedInvocationBuilder ib =
CancelWorkRequestConverter.fromRequest(client, interceptedRequest);
com.google.common.base.Function
transformer = CancelWorkRequestConverter.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 GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request) {
LOG.trace("Called getWorkRequest");
final GetWorkRequestRequest interceptedRequest =
GetWorkRequestConverter.interceptRequest(request);
com.oracle.bmc.http.internal.WrappedInvocationBuilder ib =
GetWorkRequestConverter.fromRequest(client, interceptedRequest);
com.google.common.base.Function
transformer = GetWorkRequestConverter.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 ListWorkRequestErrorsResponse listWorkRequestErrors(
ListWorkRequestErrorsRequest request) {
LOG.trace("Called listWorkRequestErrors");
final ListWorkRequestErrorsRequest interceptedRequest =
ListWorkRequestErrorsConverter.interceptRequest(request);
com.oracle.bmc.http.internal.WrappedInvocationBuilder ib =
ListWorkRequestErrorsConverter.fromRequest(client, interceptedRequest);
com.google.common.base.Function
transformer = ListWorkRequestErrorsConverter.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 ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request) {
LOG.trace("Called listWorkRequestLogs");
final ListWorkRequestLogsRequest interceptedRequest =
ListWorkRequestLogsConverter.interceptRequest(request);
com.oracle.bmc.http.internal.WrappedInvocationBuilder ib =
ListWorkRequestLogsConverter.fromRequest(client, interceptedRequest);
com.google.common.base.Function
transformer = ListWorkRequestLogsConverter.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 ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request) {
LOG.trace("Called listWorkRequests");
final ListWorkRequestsRequest interceptedRequest =
ListWorkRequestsConverter.interceptRequest(request);
com.oracle.bmc.http.internal.WrappedInvocationBuilder ib =
ListWorkRequestsConverter.fromRequest(client, interceptedRequest);
com.google.common.base.Function
transformer = ListWorkRequestsConverter.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 WorkRequestsWaiters getWaiters() {
return waiters;
}
@Override
public WorkRequestsPaginators getPaginators() {
return paginators;
}
}