com.amazonaws.services.ssooidc.AWSSSOOIDCAsyncClient Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssooidc Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ssooidc;
import javax.annotation.Generated;
import com.amazonaws.services.ssooidc.model.*;
import com.amazonaws.client.AwsAsyncClientParams;
import com.amazonaws.annotation.ThreadSafe;
import java.util.concurrent.ExecutorService;
/**
* Client for accessing SSO OIDC asynchronously. Each asynchronous method will return a Java Future object representing
* the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive notification when
* an asynchronous operation completes.
*
*
* IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native
* application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access
* token upon successful authentication and authorization with IAM Identity Center.
*
*
*
* IAM Identity Center uses the sso and identitystore API namespaces.
*
*
*
* Considerations for Using This Guide
*
*
* Before you begin using this guide, we recommend that you first review the following important information about how
* the IAM Identity Center OIDC service works.
*
*
* -
*
* The IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization
* Grant standard (https://tools.ietf.org/html/rfc8628) that are
* necessary to enable single sign-on authentication with the CLI.
*
*
* -
*
* With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must
* explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require
* re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC
* token refresh and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web
* Services access portal session duration .
*
*
* -
*
* The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to
* an IAM Identity Center user, not just a particular application.
*
*
* -
*
* The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services
* Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information,
* see
* GetRoleCredentials in the IAM Identity Center Portal API Reference Guide.
*
*
*
*
* For general information about IAM Identity Center, see What is IAM Identity Center? in the
* IAM Identity Center User Guide.
*
*/
@ThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AWSSSOOIDCAsyncClient extends AWSSSOOIDCClient implements AWSSSOOIDCAsync {
private static final int DEFAULT_THREAD_POOL_SIZE = 50;
private final java.util.concurrent.ExecutorService executorService;
public static AWSSSOOIDCAsyncClientBuilder asyncBuilder() {
return AWSSSOOIDCAsyncClientBuilder.standard();
}
/**
* Constructs a new asynchronous client to invoke service methods on SSO OIDC using the specified parameters.
*
* @param asyncClientParams
* Object providing client parameters.
*/
AWSSSOOIDCAsyncClient(AwsAsyncClientParams asyncClientParams) {
this(asyncClientParams, false);
}
/**
* Constructs a new asynchronous client to invoke service methods on SSO OIDC using the specified parameters.
*
* @param asyncClientParams
* Object providing client parameters.
* @param endpointDiscoveryEnabled
* true will enable endpoint discovery if the service supports it.
*/
AWSSSOOIDCAsyncClient(AwsAsyncClientParams asyncClientParams, boolean endpointDiscoveryEnabled) {
super(asyncClientParams, endpointDiscoveryEnabled);
this.executorService = asyncClientParams.getExecutor();
}
/**
* Returns the executor service used by this client to execute async requests.
*
* @return The executor service used by this client to execute async requests.
*/
public ExecutorService getExecutorService() {
return executorService;
}
@Override
public java.util.concurrent.Future createTokenAsync(CreateTokenRequest request) {
return createTokenAsync(request, null);
}
@Override
public java.util.concurrent.Future createTokenAsync(final CreateTokenRequest request,
final com.amazonaws.handlers.AsyncHandler asyncHandler) {
final CreateTokenRequest finalRequest = beforeClientExecution(request);
return executorService.submit(new java.util.concurrent.Callable() {
@Override
public CreateTokenResult call() throws Exception {
CreateTokenResult result = null;
try {
result = executeCreateToken(finalRequest);
} catch (Exception ex) {
if (asyncHandler != null) {
asyncHandler.onError(ex);
}
throw ex;
}
if (asyncHandler != null) {
asyncHandler.onSuccess(finalRequest, result);
}
return result;
}
});
}
@Override
public java.util.concurrent.Future createTokenWithIAMAsync(CreateTokenWithIAMRequest request) {
return createTokenWithIAMAsync(request, null);
}
@Override
public java.util.concurrent.Future createTokenWithIAMAsync(final CreateTokenWithIAMRequest request,
final com.amazonaws.handlers.AsyncHandler asyncHandler) {
final CreateTokenWithIAMRequest finalRequest = beforeClientExecution(request);
return executorService.submit(new java.util.concurrent.Callable() {
@Override
public CreateTokenWithIAMResult call() throws Exception {
CreateTokenWithIAMResult result = null;
try {
result = executeCreateTokenWithIAM(finalRequest);
} catch (Exception ex) {
if (asyncHandler != null) {
asyncHandler.onError(ex);
}
throw ex;
}
if (asyncHandler != null) {
asyncHandler.onSuccess(finalRequest, result);
}
return result;
}
});
}
@Override
public java.util.concurrent.Future registerClientAsync(RegisterClientRequest request) {
return registerClientAsync(request, null);
}
@Override
public java.util.concurrent.Future registerClientAsync(final RegisterClientRequest request,
final com.amazonaws.handlers.AsyncHandler asyncHandler) {
final RegisterClientRequest finalRequest = beforeClientExecution(request);
return executorService.submit(new java.util.concurrent.Callable() {
@Override
public RegisterClientResult call() throws Exception {
RegisterClientResult result = null;
try {
result = executeRegisterClient(finalRequest);
} catch (Exception ex) {
if (asyncHandler != null) {
asyncHandler.onError(ex);
}
throw ex;
}
if (asyncHandler != null) {
asyncHandler.onSuccess(finalRequest, result);
}
return result;
}
});
}
@Override
public java.util.concurrent.Future startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest request) {
return startDeviceAuthorizationAsync(request, null);
}
@Override
public java.util.concurrent.Future startDeviceAuthorizationAsync(final StartDeviceAuthorizationRequest request,
final com.amazonaws.handlers.AsyncHandler asyncHandler) {
final StartDeviceAuthorizationRequest finalRequest = beforeClientExecution(request);
return executorService.submit(new java.util.concurrent.Callable() {
@Override
public StartDeviceAuthorizationResult call() throws Exception {
StartDeviceAuthorizationResult result = null;
try {
result = executeStartDeviceAuthorization(finalRequest);
} catch (Exception ex) {
if (asyncHandler != null) {
asyncHandler.onError(ex);
}
throw ex;
}
if (asyncHandler != null) {
asyncHandler.onSuccess(finalRequest, result);
}
return result;
}
});
}
/**
* Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending
* asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should
* call {@code getExecutorService().shutdown()} followed by {@code getExecutorService().awaitTermination()} prior to
* calling this method.
*/
@Override
public void shutdown() {
super.shutdown();
executorService.shutdownNow();
}
}