com.amazonaws.services.signer

Class AWSsignerAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.signer.AWSsignerClient

com.amazonaws.services.signer.AWSsignerAsyncClient

All Implemented Interfaces:

AWSsigner, AWSsignerAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSsignerAsyncClient
extends AWSsignerClient
implements AWSsignerAsync

Client for accessing signer 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.

You can use Code Signing for Amazon FreeRTOS (AWS Signer) to sign code that you created for any of the IoT devices that Amazon Web Services supports. AWS Signer is integrated with Amazon FreeRTOS, AWS Certificate Manager, and AWS CloudTrail. Amazon FreeRTOS customers can use AWS Signer to sign code images before making them available for microcontrollers. You can use ACM to import third-party certificates to be used by AWS Signer. For general information about using AWS Signer, see the Code Signing for Amazon FreeRTOS Developer Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.signer.AWSsigner

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSsignerAsyncClientBuilder	asyncBuilder()
Future<CancelSigningProfileResult>	cancelSigningProfileAsync(CancelSigningProfileRequest request) Changes the state of an ACTIVE signing profile to CANCELED.
Future<CancelSigningProfileResult>	cancelSigningProfileAsync(CancelSigningProfileRequest request, AsyncHandler<CancelSigningProfileRequest,CancelSigningProfileResult> asyncHandler) Changes the state of an ACTIVE signing profile to CANCELED.
Future<DescribeSigningJobResult>	describeSigningJobAsync(DescribeSigningJobRequest request) Returns information about a specific code signing job.
Future<DescribeSigningJobResult>	describeSigningJobAsync(DescribeSigningJobRequest request, AsyncHandler<DescribeSigningJobRequest,DescribeSigningJobResult> asyncHandler) Returns information about a specific code signing job.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetSigningPlatformResult>	getSigningPlatformAsync(GetSigningPlatformRequest request) Returns information on a specific signing platform.
Future<GetSigningPlatformResult>	getSigningPlatformAsync(GetSigningPlatformRequest request, AsyncHandler<GetSigningPlatformRequest,GetSigningPlatformResult> asyncHandler) Returns information on a specific signing platform.
Future<GetSigningProfileResult>	getSigningProfileAsync(GetSigningProfileRequest request) Returns information on a specific signing profile.
Future<GetSigningProfileResult>	getSigningProfileAsync(GetSigningProfileRequest request, AsyncHandler<GetSigningProfileRequest,GetSigningProfileResult> asyncHandler) Returns information on a specific signing profile.
Future<ListSigningJobsResult>	listSigningJobsAsync(ListSigningJobsRequest request) Lists all your signing jobs.
Future<ListSigningJobsResult>	listSigningJobsAsync(ListSigningJobsRequest request, AsyncHandler<ListSigningJobsRequest,ListSigningJobsResult> asyncHandler) Lists all your signing jobs.
Future<ListSigningPlatformsResult>	listSigningPlatformsAsync(ListSigningPlatformsRequest request) Lists all signing platforms available in AWS Signer that match the request parameters.
Future<ListSigningPlatformsResult>	listSigningPlatformsAsync(ListSigningPlatformsRequest request, AsyncHandler<ListSigningPlatformsRequest,ListSigningPlatformsResult> asyncHandler) Lists all signing platforms available in AWS Signer that match the request parameters.
Future<ListSigningProfilesResult>	listSigningProfilesAsync(ListSigningProfilesRequest request) Lists all available signing profiles in your AWS account.
Future<ListSigningProfilesResult>	listSigningProfilesAsync(ListSigningProfilesRequest request, AsyncHandler<ListSigningProfilesRequest,ListSigningProfilesResult> asyncHandler) Lists all available signing profiles in your AWS account.
Future<PutSigningProfileResult>	putSigningProfileAsync(PutSigningProfileRequest request) Creates a signing profile.
Future<PutSigningProfileResult>	putSigningProfileAsync(PutSigningProfileRequest request, AsyncHandler<PutSigningProfileRequest,PutSigningProfileResult> asyncHandler) Creates a signing profile.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<StartSigningJobResult>	startSigningJobAsync(StartSigningJobRequest request) Initiates a signing job to be performed on the code provided.
Future<StartSigningJobResult>	startSigningJobAsync(StartSigningJobRequest request, AsyncHandler<StartSigningJobRequest,StartSigningJobResult> asyncHandler) Initiates a signing job to be performed on the code provided.

Methods inherited from class com.amazonaws.services.signer.AWSsignerClient

builder, cancelSigningProfile, describeSigningJob, getCachedResponseMetadata, getSigningPlatform, getSigningProfile, listSigningJobs, listSigningPlatforms, listSigningProfiles, putSigningProfile, startSigningJob, waiters

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.signer.AWSsigner

cancelSigningProfile, describeSigningJob, getCachedResponseMetadata, getSigningPlatform, getSigningProfile, listSigningJobs, listSigningPlatforms, listSigningProfiles, putSigningProfile, startSigningJob, waiters

Method Detail

asyncBuilder

public static AWSsignerAsyncClientBuilder 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.

cancelSigningProfileAsync

public Future<CancelSigningProfileResult> cancelSigningProfileAsync(CancelSigningProfileRequest request)

Description copied from interface: AWSsignerAsync

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Specified by:

cancelSigningProfileAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

cancelSigningProfileAsync

public Future<CancelSigningProfileResult> cancelSigningProfileAsync(CancelSigningProfileRequest request,
                                                                    AsyncHandler<CancelSigningProfileRequest,CancelSigningProfileResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

Specified by:

cancelSigningProfileAsync in interface AWSsignerAsync

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 CancelSigningProfile operation returned by the service.

See Also:

AWS API Documentation

describeSigningJobAsync

public Future<DescribeSigningJobResult> describeSigningJobAsync(DescribeSigningJobRequest request)

Description copied from interface: AWSsignerAsync

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Specified by:

describeSigningJobAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

describeSigningJobAsync

public Future<DescribeSigningJobResult> describeSigningJobAsync(DescribeSigningJobRequest request,
                                                                AsyncHandler<DescribeSigningJobRequest,DescribeSigningJobResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

Specified by:

describeSigningJobAsync in interface AWSsignerAsync

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 DescribeSigningJob operation returned by the service.

See Also:

AWS API Documentation

getSigningPlatformAsync

public Future<GetSigningPlatformResult> getSigningPlatformAsync(GetSigningPlatformRequest request)

Description copied from interface: AWSsignerAsync

Returns information on a specific signing platform.

Specified by:

getSigningPlatformAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

getSigningPlatformAsync

public Future<GetSigningPlatformResult> getSigningPlatformAsync(GetSigningPlatformRequest request,
                                                                AsyncHandler<GetSigningPlatformRequest,GetSigningPlatformResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Returns information on a specific signing platform.

Specified by:

getSigningPlatformAsync in interface AWSsignerAsync

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 GetSigningPlatform operation returned by the service.

See Also:

AWS API Documentation

getSigningProfileAsync

public Future<GetSigningProfileResult> getSigningProfileAsync(GetSigningProfileRequest request)

Description copied from interface: AWSsignerAsync

Returns information on a specific signing profile.

Specified by:

getSigningProfileAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

getSigningProfileAsync

public Future<GetSigningProfileResult> getSigningProfileAsync(GetSigningProfileRequest request,
                                                              AsyncHandler<GetSigningProfileRequest,GetSigningProfileResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Returns information on a specific signing profile.

Specified by:

getSigningProfileAsync in interface AWSsignerAsync

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 GetSigningProfile operation returned by the service.

See Also:

AWS API Documentation

listSigningJobsAsync

public Future<ListSigningJobsResult> listSigningJobsAsync(ListSigningJobsRequest request)

Description copied from interface: AWSsignerAsync

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningJobsAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

listSigningJobsAsync

public Future<ListSigningJobsResult> listSigningJobsAsync(ListSigningJobsRequest request,
                                                          AsyncHandler<ListSigningJobsRequest,ListSigningJobsResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningJobsAsync in interface AWSsignerAsync

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 ListSigningJobs operation returned by the service.

See Also:

AWS API Documentation

listSigningPlatformsAsync

public Future<ListSigningPlatformsResult> listSigningPlatformsAsync(ListSigningPlatformsRequest request)

Description copied from interface: AWSsignerAsync

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningPlatformsAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

listSigningPlatformsAsync

public Future<ListSigningPlatformsResult> listSigningPlatformsAsync(ListSigningPlatformsRequest request,
                                                                    AsyncHandler<ListSigningPlatformsRequest,ListSigningPlatformsResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Lists all signing platforms available in AWS Signer that match the request parameters. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningPlatformsAsync in interface AWSsignerAsync

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 ListSigningPlatforms operation returned by the service.

See Also:

AWS API Documentation

listSigningProfilesAsync

public Future<ListSigningProfilesResult> listSigningProfilesAsync(ListSigningProfilesRequest request)

Description copied from interface: AWSsignerAsync

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningProfilesAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

listSigningProfilesAsync

public Future<ListSigningProfilesResult> listSigningProfilesAsync(ListSigningProfilesRequest request,
                                                                  AsyncHandler<ListSigningProfilesRequest,ListSigningProfilesResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, AWS Signer returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that AWS Signer returns in the nextToken parameter until all of your signing jobs have been returned.

Specified by:

listSigningProfilesAsync in interface AWSsignerAsync

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 ListSigningProfiles operation returned by the service.

See Also:

AWS API Documentation

putSigningProfileAsync

public Future<PutSigningProfileResult> putSigningProfileAsync(PutSigningProfileRequest request)

Description copied from interface: AWSsignerAsync

Creates a signing profile. A signing profile is an AWS Signer template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

Specified by:

putSigningProfileAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

putSigningProfileAsync

public Future<PutSigningProfileResult> putSigningProfileAsync(PutSigningProfileRequest request,
                                                              AsyncHandler<PutSigningProfileRequest,PutSigningProfileResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Creates a signing profile. A signing profile is an AWS Signer template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

Specified by:

putSigningProfileAsync in interface AWSsignerAsync

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 PutSigningProfile operation returned by the service.

See Also:

AWS API Documentation

startSigningJobAsync

public Future<StartSigningJobResult> startSigningJobAsync(StartSigningJobRequest request)

Description copied from interface: AWSsignerAsync

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

• You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide.

• Your S3 source bucket must be version enabled.

• You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

• You specify the name of the source and destination buckets when calling the StartSigningJob operation.

• You must also specify a request token that identifies your request to AWS Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/

Specified by:

startSigningJobAsync in interface AWSsignerAsync

Returns:

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

See Also:

AWS API Documentation

startSigningJobAsync

public Future<StartSigningJobResult> startSigningJobAsync(StartSigningJobRequest request,
                                                          AsyncHandler<StartSigningJobRequest,StartSigningJobResult> asyncHandler)

Description copied from interface: AWSsignerAsync

Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

• You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide.

• Your S3 source bucket must be version enabled.

• You must create an S3 destination bucket. AWS Signer uses your S3 destination bucket to write your signed code.

• You specify the name of the source and destination buckets when calling the StartSigningJob operation.

• You must also specify a request token that identifies your request to AWS Signer.

You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/

Specified by:

startSigningJobAsync in interface AWSsignerAsync

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 StartSigningJob 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 AWSsigner

Overrides:

shutdown in class AWSsignerClient