com.amazonaws.services.iotsecuretunneling

Class AWSIoTSecureTunnelingAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunnelingClient

com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunnelingAsyncClient

All Implemented Interfaces:

AWSIoTSecureTunneling, AWSIoTSecureTunnelingAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTSecureTunnelingAsyncClient
extends AWSIoTSecureTunnelingClient
implements AWSIoTSecureTunnelingAsync

Client for accessing AWS IoT Secure Tunneling asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS IoT Secure Tunneling

AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field.

For more information about how AWS IoT Secure Tunneling works, see the User Guide.

Field Summary

Fields inherited from class com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunnelingClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunneling

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSIoTSecureTunnelingAsyncClientBuilder	asyncBuilder()
Future<CloseTunnelResult>	closeTunnelAsync(CloseTunnelRequest request) Closes a tunnel identified by the unique tunnel id.
Future<CloseTunnelResult>	closeTunnelAsync(CloseTunnelRequest request, AsyncHandler<CloseTunnelRequest,CloseTunnelResult> asyncHandler) Closes a tunnel identified by the unique tunnel id.
Future<DescribeTunnelResult>	describeTunnelAsync(DescribeTunnelRequest request) Gets information about a tunnel identified by the unique tunnel id.
Future<DescribeTunnelResult>	describeTunnelAsync(DescribeTunnelRequest request, AsyncHandler<DescribeTunnelRequest,DescribeTunnelResult> asyncHandler) Gets information about a tunnel identified by the unique tunnel id.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Lists the tags for the specified resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists the tags for the specified resource.
Future<ListTunnelsResult>	listTunnelsAsync(ListTunnelsRequest request) List all tunnels for an AWS account.
Future<ListTunnelsResult>	listTunnelsAsync(ListTunnelsRequest request, AsyncHandler<ListTunnelsRequest,ListTunnelsResult> asyncHandler) List all tunnels for an AWS account.
Future<OpenTunnelResult>	openTunnelAsync(OpenTunnelRequest request) Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.
Future<OpenTunnelResult>	openTunnelAsync(OpenTunnelRequest request, AsyncHandler<OpenTunnelRequest,OpenTunnelResult> asyncHandler) Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) A resource tag.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) A resource tag.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes a tag from a resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes a tag from a resource.

Methods inherited from class com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunnelingClient

builder, closeTunnel, describeTunnel, getCachedResponseMetadata, listTagsForResource, listTunnels, openTunnel, tagResource, untagResource

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.iotsecuretunneling.AWSIoTSecureTunneling

closeTunnel, describeTunnel, getCachedResponseMetadata, listTagsForResource, listTunnels, openTunnel, tagResource, untagResource

Method Detail

asyncBuilder

public static AWSIoTSecureTunnelingAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

closeTunnelAsync

public Future<CloseTunnelResult> closeTunnelAsync(CloseTunnelRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Specified by:

closeTunnelAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the CloseTunnel operation returned by the service.

See Also:

AWS API Documentation

closeTunnelAsync

public Future<CloseTunnelResult> closeTunnelAsync(CloseTunnelRequest request,
                                                  AsyncHandler<CloseTunnelRequest,CloseTunnelResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Specified by:

closeTunnelAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CloseTunnel operation returned by the service.

See Also:

AWS API Documentation

describeTunnelAsync

public Future<DescribeTunnelResult> describeTunnelAsync(DescribeTunnelRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

Gets information about a tunnel identified by the unique tunnel id.

Specified by:

describeTunnelAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the DescribeTunnel operation returned by the service.

See Also:

AWS API Documentation

describeTunnelAsync

public Future<DescribeTunnelResult> describeTunnelAsync(DescribeTunnelRequest request,
                                                        AsyncHandler<DescribeTunnelRequest,DescribeTunnelResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

Gets information about a tunnel identified by the unique tunnel id.

Specified by:

describeTunnelAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeTunnel operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

Lists the tags for the specified resource.

Specified by:

listTagsForResourceAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

Lists the tags for the specified resource.

Specified by:

listTagsForResourceAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTunnelsAsync

public Future<ListTunnelsResult> listTunnelsAsync(ListTunnelsRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Specified by:

listTunnelsAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the ListTunnels operation returned by the service.

See Also:

AWS API Documentation

listTunnelsAsync

public Future<ListTunnelsResult> listTunnelsAsync(ListTunnelsRequest request,
                                                  AsyncHandler<ListTunnelsRequest,ListTunnelsResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

List all tunnels for an AWS account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Specified by:

listTunnelsAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListTunnels operation returned by the service.

See Also:

AWS API Documentation

openTunnelAsync

public Future<OpenTunnelResult> openTunnelAsync(OpenTunnelRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server. .

Specified by:

openTunnelAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the OpenTunnel operation returned by the service.

See Also:

AWS API Documentation

openTunnelAsync

public Future<OpenTunnelResult> openTunnelAsync(OpenTunnelRequest request,
                                                AsyncHandler<OpenTunnelRequest,OpenTunnelResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server. .

Specified by:

openTunnelAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the OpenTunnel operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

A resource tag.

Specified by:

tagResourceAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

A resource tag.

Specified by:

tagResourceAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AWSIoTSecureTunnelingAsync

Removes a tag from a resource.

Specified by:

untagResourceAsync in interface AWSIoTSecureTunnelingAsync

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AWSIoTSecureTunnelingAsync

Removes a tag from a resource.

Specified by:

untagResourceAsync in interface AWSIoTSecureTunnelingAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

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.

Specified by:

shutdown in interface AWSIoTSecureTunneling

Overrides:

shutdown in class AmazonWebServiceClient