/* * Copyright 2010-2023 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.connectparticipant; import java.util.concurrent.Callable; import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; import java.util.concurrent.Future; import com.amazonaws.AmazonClientException; import com.amazonaws.AmazonServiceException; import com.amazonaws.handlers.AsyncHandler; import com.amazonaws.ClientConfiguration; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AWSCredentialsProvider; import com.amazonaws.auth.DefaultAWSCredentialsProviderChain; import com.amazonaws.services.connectparticipant.model.*; /** * Interface for accessing Amazon Connect Participant asynchronously. *
* Amazon Connect is an easy-to-use omnichannel cloud contact center service * that enables companies of any size to deliver superior customer service at a * lower cost. Amazon Connect communications capabilities make it easy for * companies to deliver personalized interactions across communication channels, * including chat. *
** Use the Amazon Connect Participant Service to manage participants (for * example, agents, customers, and managers listening in), and to send messages * and events within a chat contact. The APIs in the service enable the * following: sending chat messages, attachment sharing, managing a * participant's connection state and message events, and retrieving chat * transcripts. *
**/ public class AmazonConnectParticipantAsyncClient extends AmazonConnectParticipantClient implements AmazonConnectParticipantAsync { /** * Executor service for executing asynchronous requests. */ private ExecutorService executorService; private static final int DEFAULT_THREAD_POOL_SIZE = 10; /** * Constructs a new asynchronous client to invoke service methods on Amazon * Connect Participant. ** All service calls made using this new client object are blocking, and * will not return until the service call completes. */ public AmazonConnectParticipantAsyncClient() { this(Executors.newFixedThreadPool(DEFAULT_THREAD_POOL_SIZE)); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Connect Participant. *
* All service calls made using this new client object are blocking, and * will not return until the service call completes. * * @param clientConfiguration The client configuration options controlling * how this client connects to Amazon Connect Participant (ex: * proxy settings, retry counts, etc.). */ public AmazonConnectParticipantAsyncClient(ClientConfiguration clientConfiguration) { this(clientConfiguration, Executors.newFixedThreadPool(clientConfiguration .getMaxConnections())); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Connect Participant using the specified executor service. Default client * settings will be used. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonConnectParticipantAsyncClient(ExecutorService executorService) { this(new ClientConfiguration(), executorService); } /** * Constructs a new asynchronous client to invoke service methods on Amazon * Connect Participant using the specified executor service and client * configuration options. *
* All calls made using this new client object are non-blocking, and will * immediately return a Java Future object that the caller can later check * to see if the service call has actually completed. * * @param clientConfiguration Client configuration options (ex: max retry * limit, proxy settings, etc). * @param executorService The executor service by which all asynchronous * requests will be executed. */ public AmazonConnectParticipantAsyncClient(ClientConfiguration clientConfiguration, ExecutorService executorService) { super(clientConfiguration); this.executorService = executorService; } /** * Returns the executor service used by this async client to execute * requests. * * @return The executor service used by this async client to execute * requests. */ public ExecutorService getExecutorService() { return executorService; } /** * 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 getExecutorService().shutdown() followed by * getExecutorService().awaitTermination() prior to calling this method. */ @Override public void shutdown() { super.shutdown(); executorService.shutdownNow(); } /** *
* Allows you to confirm that the attachment has been uploaded using the * pre-signed URL provided in StartAttachmentUpload API. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param completeAttachmentUploadRequest * @return A Java Future object containing the response from the * CompleteAttachmentUpload service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Allows you to confirm that the attachment has been uploaded using the * pre-signed URL provided in StartAttachmentUpload API. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param completeAttachmentUploadRequest * @return A Java Future object containing the response from the * CompleteAttachmentUpload service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Creates the participant's connection. *
*
* ParticipantToken
is used for invoking this API instead of
* ConnectionToken
.
*
* The participant token is valid for the lifetime of the participant – * until they are part of a contact. *
*
* The response URL for WEBSOCKET
Type has a connect expiry
* timeout of 100s. Clients must manually connect to the returned websocket
* URL and subscribe to the desired topic.
*
* For chat, you need to publish the following on the established websocket * connection: *
*
* {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
*
* Upon websocket URL expiry, as specified in the response ConnectionExpiry * parameter, clients need to call this API again to obtain a new websocket * URL and perform the same steps as before. *
** Message streaming support: This API can also be used together with * the StartContactStreaming API to create a participant connection for * chat contacts that are not using a websocket. For more information about * message streaming, Enable real-time chat message streaming in the Amazon Connect * Administrator Guide. *
** Feature specifications: For information about feature * specifications, such as the allowed number of open websocket connections * per participant, see Feature specifications in the Amazon Connect Administrator * Guide. *
** The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
** Creates the participant's connection. *
*
* ParticipantToken
is used for invoking this API instead of
* ConnectionToken
.
*
* The participant token is valid for the lifetime of the participant – * until they are part of a contact. *
*
* The response URL for WEBSOCKET
Type has a connect expiry
* timeout of 100s. Clients must manually connect to the returned websocket
* URL and subscribe to the desired topic.
*
* For chat, you need to publish the following on the established websocket * connection: *
*
* {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}
*
* Upon websocket URL expiry, as specified in the response ConnectionExpiry * parameter, clients need to call this API again to obtain a new websocket * URL and perform the same steps as before. *
** Message streaming support: This API can also be used together with * the StartContactStreaming API to create a participant connection for * chat contacts that are not using a websocket. For more information about * message streaming, Enable real-time chat message streaming in the Amazon Connect * Administrator Guide. *
** Feature specifications: For information about feature * specifications, such as the allowed number of open websocket connections * per participant, see Feature specifications in the Amazon Connect Administrator * Guide. *
** The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
** Disconnects a participant. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param disconnectParticipantRequest * @return A Java Future object containing the response from the * DisconnectParticipant service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Disconnects a participant. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param disconnectParticipantRequest * @return A Java Future object containing the response from the * DisconnectParticipant service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Provides a pre-signed URL for download of a completed attachment. This is * an asynchronous API for use with active contacts. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param getAttachmentRequest * @return A Java Future object containing the response from the * GetAttachment service method, as returned by Amazon Connect * Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Provides a pre-signed URL for download of a completed attachment. This is * an asynchronous API for use with active contacts. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param getAttachmentRequest * @return A Java Future object containing the response from the * GetAttachment service method, as returned by Amazon Connect * Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Retrieves a transcript of the session, including details about any * attachments. For information about accessing past chat contact * transcripts for a persistent chat, see Enable persistent chat. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param getTranscriptRequest * @return A Java Future object containing the response from the * GetTranscript service method, as returned by Amazon Connect * Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Retrieves a transcript of the session, including details about any * attachments. For information about accessing past chat contact * transcripts for a persistent chat, see Enable persistent chat. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param getTranscriptRequest * @return A Java Future object containing the response from the * GetTranscript service method, as returned by Amazon Connect * Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Sends an event. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param sendEventRequest * @return A Java Future object containing the response from the SendEvent * service method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Sends an event. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param sendEventRequest * @return A Java Future object containing the response from the SendEvent * service method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Sends a message. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param sendMessageRequest * @return A Java Future object containing the response from the SendMessage * service method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Sends a message. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param sendMessageRequest * @return A Java Future object containing the response from the SendMessage * service method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Provides a pre-signed Amazon S3 URL in response for uploading the file * directly to S3. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param startAttachmentUploadRequest * @return A Java Future object containing the response from the * StartAttachmentUpload service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future* Provides a pre-signed Amazon S3 URL in response for uploading the file * directly to S3. *
*
* ConnectionToken
is used for invoking this API instead of
* ParticipantToken
.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param startAttachmentUploadRequest * @return A Java Future object containing the response from the * StartAttachmentUpload service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ public Future