diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html new file mode 100644 index 000000000..c252d2fbe --- /dev/null +++ b/docs/allclasses-index.html @@ -0,0 +1,1424 @@ + + + + + +All Classes (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+ +
+
+ + + diff --git a/docs/allclasses.html b/docs/allclasses.html new file mode 100644 index 000000000..67a37119a --- /dev/null +++ b/docs/allclasses.html @@ -0,0 +1,238 @@ + + + + + +All Classes (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html new file mode 100644 index 000000000..fd40314a8 --- /dev/null +++ b/docs/allpackages-index.html @@ -0,0 +1,217 @@ + + + + + +All Packages (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+ + + diff --git a/docs/constant-values.html b/docs/constant-values.html new file mode 100644 index 000000000..7e0197cd9 --- /dev/null +++ b/docs/constant-values.html @@ -0,0 +1,329 @@ + + + + + +Constant Field Values (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+ + +
+

software.amazon.*

+ + + +
+
+
+ + + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html new file mode 100644 index 000000000..05030354c --- /dev/null +++ b/docs/deprecated-list.html @@ -0,0 +1,407 @@ + + + + + +Deprecated List (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + + + + + + + + + +
+
+ + + diff --git a/docs/element-list b/docs/element-list new file mode 100644 index 000000000..ca742f42b --- /dev/null +++ b/docs/element-list @@ -0,0 +1,13 @@ +software.amazon.awssdk.crt +software.amazon.awssdk.crt.auth.credentials +software.amazon.awssdk.crt.auth.signing +software.amazon.awssdk.crt.cal +software.amazon.awssdk.crt.checksums +software.amazon.awssdk.crt.eventstream +software.amazon.awssdk.crt.http +software.amazon.awssdk.crt.io +software.amazon.awssdk.crt.mqtt +software.amazon.awssdk.crt.mqtt5 +software.amazon.awssdk.crt.mqtt5.packets +software.amazon.awssdk.crt.s3 +software.amazon.awssdk.crt.utils diff --git a/docs/help-doc.html b/docs/help-doc.html new file mode 100644 index 000000000..b2e9b787a --- /dev/null +++ b/docs/help-doc.html @@ -0,0 +1,283 @@ + + + + + +API Help (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +
+This help file applies to API documentation generated by the standard doclet.
+
+ + + diff --git a/docs/index-all.html b/docs/index-all.html new file mode 100644 index 000000000..60e97752b --- /dev/null +++ b/docs/index-all.html @@ -0,0 +1,6458 @@ + + + + + +Index (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I J K L M N O P Q R S T U V W X 
All Classes All Packages + + +

A

+
+
acquireConnection() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
+
Request a HttpClientConnection from the Connection Pool.
+
+
acquireShutdownRef() - Static method in class software.amazon.awssdk.crt.CRT
+
+
Public API that allows a user to indicate interest in controlling the CRT's time of shutdown.
+
+
acquireStream(Http2Request, HttpStreamBaseResponseHandler) - Method in class software.amazon.awssdk.crt.http.Http2StreamManager
+
+
Request a Http2Stream from StreamManager.
+
+
acquireStream(HttpRequest, HttpStreamBaseResponseHandler) - Method in class software.amazon.awssdk.crt.http.Http2StreamManager
+
 
+
activate() - Method in class software.amazon.awssdk.crt.http.HttpStreamBase
+
+
Activates the client stream.
+
+
activate(String, List<Header>, byte[], MessageType, int) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation
+
+
Sends the initial message on a continuation, and begins the message flow for a stream.
+
+
activate(String, List<Header>, byte[], MessageType, int, MessageFlushCallback) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation
+
+
Initiates a new client stream.
+
+
addHeader(String, String) - Method in class software.amazon.awssdk.crt.http.HttpRequestBase
+
 
+
addHeader(HttpHeader) - Method in class software.amazon.awssdk.crt.http.HttpRequestBase
+
 
+
addHeaders(HttpHeader[]) - Method in class software.amazon.awssdk.crt.http.HttpRequestBase
+
 
+
addRef() - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Increments the reference count to this resource.
+
+
addReferenceTo(CrtResource) - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Marks a resource as referenced by this resource.
+
+
addSetting(Http2ConnectionSetting) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
 
+
ADMINISTRATIVE_ACTION - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the connection was closed due to an administrative action.
+
+
alpnList - Variable in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the ALPN protocol list that will be provided when a TLS connection + starts e.g.
+
+
appendDecodingUri(String, String) - Static method in class software.amazon.awssdk.crt.io.Uri
+
+
Returns a concatenation of a decoded base, and the URI decoding of a UTF-8 + string, replacing %xx escapes by their single byte equivalent.
+
+
appendEncodingUriParam(String, String) - Static method in class software.amazon.awssdk.crt.io.Uri
+
+
Returns a concatenation of an encoded base, and the URI query param encoding + (passthrough alnum + '-' '_' '~' '.') of a UTF-8 string.
+
+
appendEncodingUriPath(String, String) - Static method in class software.amazon.awssdk.crt.io.Uri
+
+
Returns a concatenation of an encoded base, and the URI path encoding of a + string.
+
+
ApplicationError - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
ApplicationMessage - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
AsyncCallback - Interface in software.amazon.awssdk.crt
+
+
Async io completion abstraction used by the native mqtt layer.
+
+
AT_LEAST_ONCE - software.amazon.awssdk.crt.mqtt.QualityOfService
+
+
Message will be delivered at least once.
+
+
AT_LEAST_ONCE - software.amazon.awssdk.crt.mqtt5.QOS
+
+
A level of service that ensures that the message arrives at the receiver at least once.
+
+
AT_MOST_ONCE - software.amazon.awssdk.crt.mqtt.QualityOfService
+
+
Message will be delivered at most once, or may not be delivered at all.
+
+
AT_MOST_ONCE - software.amazon.awssdk.crt.mqtt5.QOS
+
+
The message is delivered according to the capabilities of the underlying network.
+
+
AuthCredentialsProvider - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
AuthGeneral - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
AuthProfile - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
AuthSigning - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
AWS_CRT_SUCCESS - Static variable in class software.amazon.awssdk.crt.CRT
+
 
+
AWS_ECDSA_P256 - software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve
+
+
Nist standard P256 elliptic curve
+
+
AWS_ECDSA_P384 - software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve
+
+
Nist standard P384 elliptic curve
+
+
AWS_IOT_CORE_DEFAULTS - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
+
+
Apply additional client-side validation and operational flow control that respects the + default AWS IoT Core limits.
+
+
awsErrorName(int) - Static method in class software.amazon.awssdk.crt.CRT
+
+
Given an integer error code from an internal operation, get a corresponding string identifier for it.
+
+
awsErrorString(int) - Static method in class software.amazon.awssdk.crt.CRT
+
+
Given an integer error code from an internal operation, get a corresponding description for it.
+
+
awsLastError() - Static method in class software.amazon.awssdk.crt.CRT
+
+
Returns the last error on the current thread.
+
+
AwsSignedBodyValue() - Constructor for class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
AwsSigner - Class in software.amazon.awssdk.crt.auth.signing
+
+
Static class for a variety of AWS signing APIs.
+
+
AwsSigner() - Constructor for class software.amazon.awssdk.crt.auth.signing.AwsSigner
+
 
+
AwsSigningConfig - Class in software.amazon.awssdk.crt.auth.signing
+
+
A class representing configuration related to signing something "signable" (an http request, a body chunk, a + stream event) via an AWS signing process.
+
+
AwsSigningConfig() - Constructor for class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Default constructor
+
+
AwsSigningConfig.AwsSignatureType - Enum in software.amazon.awssdk.crt.auth.signing
+
+
What sort of signature should be computed from the signable?
+
+
AwsSigningConfig.AwsSignedBodyHeaderType - Enum in software.amazon.awssdk.crt.auth.signing
+
+
Controls if signing adds a header containing the canonical request's body value
+
+
AwsSigningConfig.AwsSignedBodyValue - Class in software.amazon.awssdk.crt.auth.signing
+
+
A set of string constants for various canonical request payload values.
+
+
AwsSigningConfig.AwsSigningAlgorithm - Enum in software.amazon.awssdk.crt.auth.signing
+
+
What version of the AWS signing process should we use.
+
+
AwsSigningResult - Class in software.amazon.awssdk.crt.auth.signing
+
+
Wrapper that holds signing-related output.
+
+
AwsSigningResult() - Constructor for class software.amazon.awssdk.crt.auth.signing.AwsSigningResult
+
+
Default constructor
+
+
AwsSigningUtils - Class in software.amazon.awssdk.crt.auth.signing
+
+
Internal utility/testing functions for verifying sigv4a signatures.
+
+
AwsSigningUtils() - Constructor for class software.amazon.awssdk.crt.auth.signing.AwsSigningUtils
+
 
+
+ + + +

B

+
+
BAD_AUTHENTICATION_METHOD - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the authentication method used in the connection is either nor supported on the server or it does + not match the authentication method currently in use in the ConnectPacket.
+
+
BAD_USERNAME_OR_PASSWORD - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server does not accept the username and/or password specified by the client + in the connection packet.
+
+
BANNED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the client has been banned by the server.
+
+
base64Decode(byte[]) - Static method in class software.amazon.awssdk.crt.utils.StringUtils
+
+
Decode a Base64 byte array into a non-Base64 byte array.
+
+
base64Encode(byte[]) - Static method in class software.amazon.awssdk.crt.utils.StringUtils
+
+
Encode a byte array into a Base64 byte array.
+
+
Basic - software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType
+
+
Basic (username and password base64 encoded) authentication
+
+
BooleanFalse - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
BooleanTrue - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
build() - Method in class software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder
+
+
Builds a new caching credentials provider
+
+
build() - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Creates a new Cognito credentials provider, based on this builder's configuration
+
+
build() - Method in class software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder
+
+
Creates a new default credentials chain provider based on the builder's configuration
+
+
build() - Method in class software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider.DelegateCredentialsProviderBuilder
+
+
Builds a new delegate credentials provider using the builder's configuration
+
+
build() - Method in interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder
+
+
Create an ECS credentials provider using the configuration applied to this builder.
+
+
build() - Method in interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder
+
+
Create a profile credentials provider using the configuration applied to this builder.
+
+
build() - Method in class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
+
+
Builds a new static credentials provider based on the builder configuration
+
+
build() - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
+
Create a sts credentials provider using the configuration applied to this builder.
+
+
build() - Method in interface software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider.Builder
+
+
Create an STS web identity credentials provider using the configuration applied to this builder.
+
+
build() - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Creates a new X509 credentials provider, based on this builder's configuration
+
+
build() - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
 
+
build() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Returns a Mqtt5ClientOptions class configured with all of the options set in the Mqtt5ClientOptionsBuilder.
+
+
build() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Creates a new ConnectPacket using the settings set in the builder.
+
+
build() - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Creates a new DisconnectPacket using the settings set in the builder.
+
+
build() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Creates a new PublishPacket using the settings set in the builder.
+
+
build() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Creates a new SUBSCRIBE packet using the settings set in the builder.
+
+
build() - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder
+
+
Creates a new UnsubscribePacket using the settings set in the builder.
+
+
build() - Method in class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
+
 
+
builder() - Static method in class software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider
+
+
Get a builder for creating a custom ECS credentials provider.
+
+
builder() - Static method in class software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider
+
+
Get a builder for creating a custom profile credentials provider.
+
+
builder() - Static method in class software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider
+
+
Get a builder for creating a custom sts credentials provider.
+
+
builder() - Static method in class software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider
+
+
Get a builder for creating an STS web identity credentials provider.
+
+
builder() - Static method in class software.amazon.awssdk.crt.http.Http2ConnectionSetting
+
+
Helper to build a List of Http2ConnectionSetting
+
+
Byte - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
ByteBuf - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
ByteBufferUtils - Class in software.amazon.awssdk.crt.utils
+
+
Utility Class with Helper functions for working with ByteBuffers
+
+
BYTES - software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator
+
+
The payload is arbitrary binary data
+
+
+ + + +

C

+
+
CachedCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A credentials provider that adds caching to another credentials provider via decoration
+
+
CachedCredentialsProvider.CachedCredentialsProviderBuilder - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A simple builder class for a cached credentials provider and its options
+
+
CachedCredentialsProviderBuilder() - Constructor for class software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder
+
+
Default constructor
+
+
cancel() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequest
+
 
+
CANCEL - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
canonicalName - Variable in class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
checkJniExceptionContract(boolean) - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
ChecksumAlgorithm - Enum in software.amazon.awssdk.crt.s3
+
 
+
ChecksumConfig - Class in software.amazon.awssdk.crt.s3
+
 
+
ChecksumConfig() - Constructor for class software.amazon.awssdk.crt.s3.ChecksumConfig
+
 
+
ChecksumConfig.ChecksumLocation - Enum in software.amazon.awssdk.crt.s3
+
 
+
CLEAN - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Always ask for a clean session when connecting
+
+
cleanUpPem(String) - Static method in class software.amazon.awssdk.crt.utils.PemUtils
+
+
Cleanup Function that removes most formatting and copy/paste mistakes from + PEM formatted Strings.
+
+
CLIENT_IDENTIFIER_NOT_VALID - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the client identifier in the ConnectPacket is a valid string but not one that + is allowed on the server.
+
+
ClientBootstrap - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_client_bootstrap from aws-c-io to provide + a client context for all protocol stacks in the AWS Common Runtime.
+
+
ClientBootstrap(EventLoopGroup, HostResolver) - Constructor for class software.amazon.awssdk.crt.io.ClientBootstrap
+
+
Creates a new ClientBootstrap.
+
+
ClientConnection - Class in software.amazon.awssdk.crt.eventstream
+
+
Wrapper around an event stream rpc client initiated connection.
+
+
ClientConnectionContinuation - Class in software.amazon.awssdk.crt.eventstream
+
+
Java wrapper for event-stream-rpc client continuation.
+
+
ClientConnectionContinuationHandler - Class in software.amazon.awssdk.crt.eventstream
+
+
Handler interface for responding to continuation events.
+
+
ClientConnectionContinuationHandler() - Constructor for class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuationHandler
+
 
+
ClientConnectionHandler - Class in software.amazon.awssdk.crt.eventstream
+
+
Handler for EventStream ClientConnections.
+
+
ClientConnectionHandler() - Constructor for class software.amazon.awssdk.crt.eventstream.ClientConnectionHandler
+
 
+
ClientTlsContext - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_tls_context from aws-c-io to provide access to TLS + configuration contexts in the AWS Common Runtime.
+
+
ClientTlsContext(TlsContextOptions) - Constructor for class software.amazon.awssdk.crt.io.ClientTlsContext
+
+
Creates a new Client TlsContext.
+
+
clone() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Creates a new signing configuration from this one.
+
+
clone() - Method in class software.amazon.awssdk.crt.checksums.CRC32
+
 
+
clone() - Method in class software.amazon.awssdk.crt.checksums.CRC32C
+
 
+
clone() - Method in class software.amazon.awssdk.crt.checksums.CRC64NVME
+
 
+
clone() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Creates a (shallow) clone of this config object
+
+
close() - Method in class software.amazon.awssdk.crt.CrtResource
+
 
+
close() - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuationHandler
+
 
+
close() - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionHandler
+
 
+
close() - Method in class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuationHandler
+
 
+
close() - Method in class software.amazon.awssdk.crt.eventstream.ServerConnectionHandler
+
 
+
closeConnection(int) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
+
Closes the connection if it hasn't been closed already.
+
+
closeConnection(int) - Method in class software.amazon.awssdk.crt.eventstream.ServerConnection
+
+
Closes the connection with shutdownError
+
+
closeStaticDefault() - Static method in class software.amazon.awssdk.crt.io.ClientBootstrap
+
+
Closes the static ClientBootstrap, if it exists.
+
+
closeStaticDefault() - Static method in class software.amazon.awssdk.crt.io.EventLoopGroup
+
+
Closes the static EventLoopGroup, if it exists.
+
+
closeStaticDefault() - Static method in class software.amazon.awssdk.crt.io.HostResolver
+
+
Closes the static default host resolver, if it exists.
+
+
CognitoCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps a credentials provider that sources session credentials from the AWS Cognito Identity service.
+
+
CognitoCredentialsProvider.CognitoCredentialsProviderBuilder - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A builder class for the Cognito provider and its options
+
+
CognitoCredentialsProvider.CognitoLoginTokenPair - Class in software.amazon.awssdk.crt.auth.credentials
+
+
Pair of strings specifying an identity provider name and an associated login token.
+
+
CognitoCredentialsProviderBuilder() - Constructor for class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Default constructor
+
+
CognitoLoginTokenPair(String, String) - Constructor for class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoLoginTokenPair
+
 
+
collectNativeResource(Consumer<CrtResource.ResourceInstance>) - Static method in class software.amazon.awssdk.crt.CrtResource
+
+
Applies a generic diagnostic-gathering functor to all CRTResource objects
+
+
collectNativeResources(Consumer<String>) - Static method in class software.amazon.awssdk.crt.CrtResource
+
+
Applies a resource description consuming functor to all CRTResource objects
+
+
CommonGeneral - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
CommonTaskScheduler - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
complete(byte[]) - Method in class software.amazon.awssdk.crt.io.TlsKeyOperation
+
+
The function to call when you have modified the input data using the private key and are ready to + return it for use in the mutual TLS Handshake.
+
+
complete(HttpRequest) - Method in class software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs
+
+
Mark the transform operation as successfully completed.
+
+
complete(HttpRequest) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs
+
+
Mark the transform operation as successfully completed.
+
+
completeExceptionally(Throwable) - Method in class software.amazon.awssdk.crt.io.TlsKeyOperation
+
+
The function to call when you either have an exception and want to complete the operation with an + exception or you cannot complete the operation.
+
+
completeExceptionally(Throwable) - Method in class software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs
+
+
Mark the transform operation as unsuccessfully completed.
+
+
completeExceptionally(Throwable) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs
+
+
Mark the transform operation as unsuccessfully completed.
+
+
COMPRESSION_ERROR - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
ConnAckPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 CONNACK packet.
+
+
ConnAckPacket() - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
 
+
ConnAckPacket.ConnectReasonCode - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Server return code for connect attempts.
+
+
connect() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Connect to the service endpoint and start a session
+
+
connect(String, int, SocketOptions, ClientTlsContext, ClientBootstrap, ClientConnectionHandler) - Static method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
+
Initiates a new outgoing event-stream-rpc connection.
+
+
Connect - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
CONNECT_ERROR - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
ConnectAck - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
CONNECTION_RATE_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server connection rate limit has been exceeded.
+
+
CONNECTION_RATE_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the server disconnects the client due to the connection rate being too high.
+
+
ConnectionAccepted - software.amazon.awssdk.crt.eventstream.MessageFlags
+
 
+
ConnectPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 CONNECT packet.
+
+
ConnectPacket.ConnectPacketBuilder - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
A class to that allows for the creation of a ConnectPacket.
+
+
ConnectPacketBuilder() - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Creates a new ConnectPacketBuilder so a ConnectPacket can be created.
+
+
connectTimeoutMs - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Sets the number of milliseconds before a connection will be considered timed out
+
+
COPY_OBJECT - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
+
The CopyObject meta request performs a multi-part copy using multiple S3 UploadPartCopy requests + in parallel, or bypasses a CopyObject request to S3 if the object size is not large enough for + a multipart upload.
+
+
cpuId - Variable in class software.amazon.awssdk.crt.SystemInfo.CpuInfo
+
+
OS CpuId that can be used for pinning a thread to a specific Cpu
+
+
CRC32 - Class in software.amazon.awssdk.crt.checksums
+
+
CRT implementation of the Java Checksum interface for making CRC32 checksum calculations
+
+
CRC32 - software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
CRC32() - Constructor for class software.amazon.awssdk.crt.checksums.CRC32
+
+
Default constructor
+
+
CRC32C - Class in software.amazon.awssdk.crt.checksums
+
+
CRT implementation of the Java Checksum interface for making Crc32c checksum calculations
+
+
CRC32C - software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
CRC32C() - Constructor for class software.amazon.awssdk.crt.checksums.CRC32C
+
+
Default constructor
+
+
CRC64NVME - Class in software.amazon.awssdk.crt.checksums
+
+
CRT implementation of the Java Checksum interface for making CRC64NVME checksum calculations
+
+
CRC64NVME - software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
CRC64NVME() - Constructor for class software.amazon.awssdk.crt.checksums.CRC64NVME
+
+
Default constructor
+
+
create() - Static method in class software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider
+
+
Create an ECS credentials provider using the defaults.
+
+
create() - Static method in class software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider
+
+
Create a profile credentials provider using the default file locations and profile name.
+
+
create() - Static method in class software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider
+
+
Create a sts credentials provider.
+
+
create() - Static method in class software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider
+
+
Create an STS web identity credentials provider.
+
+
create(Http2StreamManagerOptions) - Static method in class software.amazon.awssdk.crt.http.Http2StreamManager
+
+
Factory function for Http2StreamManager instances
+
+
create(HttpClientConnectionManagerOptions) - Static method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
+
Factory function for HttpClientConnectionManager instances
+
+
CREATE_NEW - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
+
Always create a new file.
+
+
CREATE_OR_APPEND - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
+
Create a new file if it doesn't exist, otherwise append to the existing file.
+
+
CREATE_OR_REPLACE - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
+
Create a new file if it doesn't exist, otherwise replace the existing file.
+
+
createAnonymousCredentials() - Static method in class software.amazon.awssdk.crt.auth.credentials.Credentials
+
+
Anonymous Credentials constructor.
+
+
createDefaultClient() - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper which creates a default set of TLS options for the current platform
+
+
createDefaultServer() - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper which creates a default set of TLS options for the current platform
+
+
createHeader(String, boolean) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of boolean value
+
+
createHeader(String, byte) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of byte or int8 value
+
+
createHeader(String, byte[]) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of byte[] value
+
+
createHeader(String, int) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of int or int32 value
+
+
createHeader(String, long) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of long or int64 value
+
+
createHeader(String, short) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of short or int16 value
+
+
createHeader(String, String) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of String value
+
+
createHeader(String, Date) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of Date (assumed to be UTC) value
+
+
createHeader(String, UUID) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Create a header with name of UUID value
+
+
createS3ExpressCredentialsProvider(S3Client) - Method in interface software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderFactory
+
+
A handler to create a S3ExpressCredentialsProvider for the client to use.
+
+
createWithMtls(String, String) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper which creates mutual TLS (mTLS) options using a certificate and private key
+
+
createWithMtlsCustomKeyOperations(TlsContextCustomKeyOperationOptions) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Unix platforms only - Helper which creates mutual TLS (mTLS) options using the applied custom key operations.
+
+
createWithMtlsFromPath(String, String) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper which creates mutual TLS (mTLS) options using a certificate and private key
+
+
createWithMtlsJavaKeystore(KeyStore, String, String) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper which creates mutual TLS (mTLS) options using a certificate and private key + stored in a Java keystore.
+
+
createWithMtlsPkcs11(TlsContextPkcs11Options) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Unix platforms only - Helper which creates mutual TLS (mTLS) options using a PKCS#11 library for private key operations.
+
+
createWithMtlsPkcs12(String, String) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Apple platforms only - Helper which creates mutual TLS (mTLS) options using PKCS12
+
+
createWithMtlsWindowsCertStorePath(String) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Windows platforms only - Helper which creates mutual TLS (mTLS) options using a + certificate in a Windows certificate store.
+
+
Credentials - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class representing a set of AWS credentials.
+
+
Credentials() - Constructor for class software.amazon.awssdk.crt.auth.credentials.Credentials
+
+
Anonymous Credentials constructor.
+
+
Credentials(byte[], byte[], byte[]) - Constructor for class software.amazon.awssdk.crt.auth.credentials.Credentials
+
 
+
Credentials(byte[], byte[], byte[], long) - Constructor for class software.amazon.awssdk.crt.auth.credentials.Credentials
+
 
+
CredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A base class that represents a source of AWS credentials
+
+
CRT - Class in software.amazon.awssdk.crt
+
+
This class is responsible for loading the aws-crt-jni shared lib for the + current platform out of aws-crt-java.jar.
+
+
CRT() - Constructor for class software.amazon.awssdk.crt.CRT
+
 
+
CRT_LIB_NAME - Static variable in class software.amazon.awssdk.crt.CRT
+
 
+
CRT.UnknownPlatformException - Exception in software.amazon.awssdk.crt
+
+
Exception thrown when we can't detect what platform we're running on and thus can't figure out + the native library name/path to load.
+
+
CrtPlatform - Class in software.amazon.awssdk.crt
+
 
+
CrtPlatform() - Constructor for class software.amazon.awssdk.crt.CrtPlatform
+
 
+
CrtResource - Class in software.amazon.awssdk.crt
+
+
This wraps a native pointer and/or one or more references to an AWS Common Runtime resource.
+
+
CrtResource() - Constructor for class software.amazon.awssdk.crt.CrtResource
+
+
Default constructor
+
+
CrtResource.ResourceInstance - Class in software.amazon.awssdk.crt
+
+
Debug/diagnostic data about a CrtResource object
+
+
CrtRuntimeException - Exception in software.amazon.awssdk.crt
+
+
This exception will be thrown by any exceptional cases encountered within + the JNI bindings to the AWS Common Runtime
+
+
CrtRuntimeException(int) - Constructor for exception software.amazon.awssdk.crt.CrtRuntimeException
+
+
Constructor for Crt exceptions due to native errors
+
+
CrtRuntimeException(int, String) - Constructor for exception software.amazon.awssdk.crt.CrtRuntimeException
+
+
Deprecated. +
use CrtRuntimeException(int errorCode)
+
+
+
CrtRuntimeException(String) - Constructor for exception software.amazon.awssdk.crt.CrtRuntimeException
+
+
Constructor for CRT exceptions not due to native errors
+
+
+ + + +

D

+
+
Debug - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
decodeUri(String) - Static method in class software.amazon.awssdk.crt.io.Uri
+
+
Returns the URI decoding of a UTF-8 string, replacing %xx escapes by their + single byte equivalent.
+
+
Decorrelated - software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode
+
+
Backoff is taken randomly from the interval between the base backoff + interval and a scaling (greater than 1) of the current backoff value
+
+
decRef() - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Decrements the reference count to this resource.
+
+
DECRYPT - software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
 
+
Default - software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode
+
+
Maps to Full
+
+
Default - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
+
Maps to Disabled.
+
+
Default - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
Maps to Disabled.
+
+
DEFAULT - software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior
+
+
Default behavior that accommodates most use cases.
+
+
DEFAULT - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
Default client operation queue behavior.
+
+
DEFAULT - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Default client session behavior.
+
+
DEFAULT - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
+
The Default meta request type sends any request to S3 as-is (with no transformation).
+
+
DEFAULT_CONNECTION_PING_TIMEOUT_MS - Static variable in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
DEFAULT_MAX - Static variable in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
DEFAULT_MAX_BUFFER_SIZE - Static variable in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
DEFAULT_MAX_CONNECTIONS - Static variable in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
DEFAULT_MAX_CONNECTIONS - Static variable in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
DEFAULT_MAX_WINDOW_SIZE - Static variable in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
DEFAULT_MAX_WINDOW_SIZE - Static variable in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
DefaultChainCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps the default AWS credentials provider chain
+
+
DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A simple builder class for the default credentials provider chain and its options + Does not add reference to CRT resources
+
+
DefaultChainCredentialsProviderBuilder() - Constructor for class software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder
+
+
Default constructor
+
+
DelegateCredentialsHandler - Interface in software.amazon.awssdk.crt.auth.credentials
+
+
Interface that synchronously provides custom credentials.
+
+
DelegateCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A credentials provider that sources credentials from a custom synchronous + callback
+
+
DelegateCredentialsProvider.DelegateCredentialsProviderBuilder - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A simple builder class for a delegate credentials provider and its options
+
+
DelegateCredentialsProviderBuilder() - Constructor for class software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider.DelegateCredentialsProviderBuilder
+
+
Default constructor
+
+
destroyProvider() - Method in class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProvider
+
 
+
destroyProvider() - Method in interface software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderHandler
+
+
Invoked when the S3 client starts to destroy to clean up related resource.
+
+
DGRAM - software.amazon.awssdk.crt.io.SocketOptions.SocketType
+
+
Corresponds to SOCK_DGRAM in Berkeley sockets (UDP)
+
+
DirectoryEntry - Class in software.amazon.awssdk.crt.io
+
+
Supplied during calls to DirectoryTraversal.traverse() as each entry is encountered.
+
+
DirectoryEntry() - Constructor for class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
DirectoryTraversal - Class in software.amazon.awssdk.crt.io
+
+
Deprecated. +
It is currently an EXPERIMENTAL feature meant for internal use only. It may be changed incompatibly + or removed in a future version.
+
+
+
DirectoryTraversal() - Constructor for class software.amazon.awssdk.crt.io.DirectoryTraversal
+
+
Deprecated.
+ 
+
DirectoryTraversalHandler - Interface in software.amazon.awssdk.crt.io
+
+
Handler invoked during calls to DirectoryTraversal.traverse() as each entry is encountered.
+
+
Disabled - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
+
Forbid the server from sending PUBLISH packets to the client that use topic aliasing
+
+
Disabled - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
Completely disable outbound topic aliasing.
+
+
DISABLED - software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType
+
+
Disable reading from environment variable for proxy.
+
+
disconnect() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Disconnects the current session
+
+
DISCONNECT_WITH_WILL_MESSAGE - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returns when the client wants to disconnect but requires that the server publish the Will message configured + on the connection.
+
+
DisconnectPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 DISCONNECT packet.
+
+
DisconnectPacket.DisconnectPacketBuilder - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
A class to that allows for the creation of a DisconnectPacket.
+
+
DisconnectPacket.DisconnectReasonCode - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Reason code inside DisconnectPackets.
+
+
DisconnectPacketBuilder() - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Creates a new DisconnectPacketBuilder so a DisconnectPacket can be created.
+
+
domain - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Sets the socket domain
+
+
DONT_SEND - software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
+
Subscriptions must not trigger any retained message publishes from the server.
+
+
dumpNativeMemory() - Static method in class software.amazon.awssdk.crt.CRT
+
+
Dump info to logs about all memory currently allocated by native resources.
+
+
+ + + +

E

+
+
EccKeyPair - Class in software.amazon.awssdk.crt.cal
+
+
This class puts an opaque wrapper around aws_ecc_key_pair from aws-c-cal.
+
+
EccKeyPair.AwsEccCurve - Enum in software.amazon.awssdk.crt.cal
+
+
Enum for supported ECC curves + Needs to stay in sync with aws_ecc_curve_name
+
+
ECDSA - software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
 
+
EcsCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps a provider that gets credentials from an ECS service.
+
+
EcsCredentialsProvider.Builder - Interface in software.amazon.awssdk.crt.auth.credentials
+
+
A builder for creating a custom ECS credentials provider.
+
+
EMPTY_SHA256 - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
ENABLE_PUSH - software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
Enabled - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
+
Allow the server to send PUBLISH packets to the client that use topic aliasing
+
+
ENABLED - software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType
+
+
Default.
+
+
enablePush(boolean) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
+
The SETTINGS_ENABLE_PUSH.
+
+
encodeUriParam(String) - Static method in class software.amazon.awssdk.crt.io.Uri
+
+
Returns the URI query param encoding (passthrough alnum + '-' '_' '~' '.') of + a UTF-8 string.
+
+
encodeUriPath(String) - Static method in class software.amazon.awssdk.crt.io.Uri
+
+
Returns the URI path encoding of a string.
+
+
ENHANCE_YOUR_CALM - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
equals(Object) - Method in class software.amazon.awssdk.crt.eventstream.Header
+
 
+
Error - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
errorCode - Variable in exception software.amazon.awssdk.crt.CrtRuntimeException
+
 
+
errorName - Variable in exception software.amazon.awssdk.crt.CrtRuntimeException
+
 
+
EventLoopGroup - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_event_loop_group from aws-c-io to provide + access to an event loop for the MQTT protocol stack in the AWS Common + Runtime.
+
+
EventLoopGroup(int) - Constructor for class software.amazon.awssdk.crt.io.EventLoopGroup
+
+
Creates a new event loop group for the I/O subsystem to use to run non-blocking I/O requests
+
+
EventLoopGroup(int, int) - Constructor for class software.amazon.awssdk.crt.io.EventLoopGroup
+
+
Creates a new event loop group for the I/O subsystem to use to run non-blocking I/O requests.
+
+
EventStreamServerListener - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
EXACTLY_ONCE - software.amazon.awssdk.crt.mqtt.QualityOfService
+
+
The message is always delivered exactly once.
+
+
EXACTLY_ONCE - software.amazon.awssdk.crt.mqtt5.QOS
+
+
A level of service that ensures that the message arrives at the receiver exactly once.
+
+
ExponentialBackoffRetryOptions - Class in software.amazon.awssdk.crt.io
+
+
Configuration options for the exponential backoff retry strategy for http requests
+
+
ExponentialBackoffRetryOptions() - Constructor for class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
+
Default constructor
+
+
ExponentialBackoffRetryOptions.JitterMode - Enum in software.amazon.awssdk.crt.io
+
+
What kind of jitter or randomization to apply to the backoff time interval + + https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
+
+
+ + + +

F

+
+
FAIL_ALL_ON_DISCONNECT - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
All operations that are not complete at the time of disconnection are failed, except operations that + the MQTT5 spec requires to be retransmitted (un-acked QoS1+ publishes).
+
+
FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay + in place.
+
+
FAIL_QOS0_PUBLISH_ON_DISCONNECT - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
QoS 0 publishes that are not complete at the time of disconnection are failed.
+
+
Fatal - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
FLOW_CONTROL_ERROR - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
Forwarding - software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType
+
+
Establish a forwarding-based connection through the proxy.
+
+
FRAME_SIZE_ERROR - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
fromByteBuffer(ByteBuffer) - Static method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Marshals buffer into a Header instance
+
+
fromEnumValue(int) - Static method in enum software.amazon.awssdk.crt.eventstream.MessageType
+
+
Create a MessageType enum value from a native enum value
+
+
Full - software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode
+
+
Choose an actual backoff interval between [0, MaxCurrentBackoff] where MaxCurrentBackoff is the standard + exponential backoff value
+
+
+ + + +

G

+
+
GET_OBJECT - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
+
The GetObject request will be split into a series of ranged GetObject requests that are + executed in parallel to improve throughput, when possible.
+
+
getAccessKeyId() - Method in class software.amazon.awssdk.crt.auth.credentials.Credentials
+
 
+
getAckTimeoutSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before + failing the operation.
+
+
getAlgorithm() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets what version of the AWS signing procecss will be used
+
+
getAllowableThroughputFailureIntervalSeconds() - Method in class software.amazon.awssdk.crt.http.HttpMonitoringOptions
+
 
+
getArchIdentifier() - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
getArchIdentifier() - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
getAssignedClientID() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
+
Returns the final client id in use by the newly-established connection.
+
+
getAssignedClientIdentifier() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns a client identifier assigned to this connection by the server.
+
+
getAuthorizationPassword() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getAuthorizationType() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getAuthorizationUsername() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getAvailableConcurrency() - Method in class software.amazon.awssdk.crt.http.HttpManagerMetrics
+
 
+
getBackoffRetryOptions() - Method in class software.amazon.awssdk.crt.io.StandardRetryOptions
+
 
+
getBackoffScaleFactorMS() - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
 
+
getBodyStream() - Method in class software.amazon.awssdk.crt.http.HttpRequestBase
+
 
+
getBootstrap() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the Client bootstrap used.
+
+
getBoundPort() - Method in class software.amazon.awssdk.crt.eventstream.ServerListener
+
 
+
getBufferSize() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Deprecated. 
+
+
getBytesTransferred() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestProgress
+
 
+
getByteValue() - Method in enum software.amazon.awssdk.crt.eventstream.MessageFlags
+
 
+
getCause() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
+
Cause of the error, such as a Java exception from a callback.
+
+
getCertificateFileContents() - Method in class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
+
+
Returns the contents of the X.509 certificate if it has been set.
+
+
getCertificateFilePath() - Method in class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
+
+
Returns the path to the X.509 certificate file on disk if it has been set.
+
+
getChecksumAlgorithm() - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
 
+
getChecksumAlgorithm() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
 
+
getChecksumAlgorithm() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Deprecated. 
+
+
getChecksumConfig() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getChecksumLocation() - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
 
+
getCleanSession() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries whether or not the service should try to resume prior subscriptions, if it has any
+
+
getClientBootstrap() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Gets the client bootstrap instance to use to create the pool's connections
+
+
getClientBootstrap() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getClientId() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the client_id being used by a connection
+
+
getClientId() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a unique string identifying the client to the server.
+
+
getClientOptions() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Returns the Mqtt5ClientOptions used for the Mqtt5Client
+
+
getClosedFuture() - Method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
 
+
getClosedFuture() - Method in class software.amazon.awssdk.crt.eventstream.ServerConnection
+
 
+
getComputeContentMd5() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getConnAckPacket() - Method in class software.amazon.awssdk.crt.mqtt5.OnConnectionFailureReturn
+
+
Returns the ConnAckPacket returned from the server on the connection failure, or Null if none was returned.
+
+
getConnAckPacket() - Method in class software.amazon.awssdk.crt.mqtt5.OnConnectionSuccessReturn
+
+
Returns the ConnAckPacket returned from the server on the connection success or Null if none was returned.
+
+
getConnackTimeoutMs() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the time interval to wait after sending a CONNECT request for a CONNACK to arrive.
+
+
getConnectionAcquisitionTimeoutInMilliseconds() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getConnectionCallbacks() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the connection-related callbacks for a connection
+
+
getConnectionClosedFuture() - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionHandler
+
 
+
getConnectionManagerOptions() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
getConnectionPingPeriodMs() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
getConnectionPingTimeoutMs() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
getConnectionType() - Method in class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
 
+
getConnectionType() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getConnectOptions() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns all configurable options with respect to the CONNECT packet sent by the client, including the will.
+
+
getConnectTimeoutMs() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getContentLength() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestProgress
+
 
+
getContentType() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns a property specifying the content type of the payload.
+
+
getContinuationClosedFuture() - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuationHandler
+
 
+
getContinuationClosedFuture() - Method in class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuationHandler
+
 
+
getCorrelationData() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns a opaque binary data used to correlate between publish messages, as a potential method for request-response + implementation.
+
+
getCpuGroupCount() - Static method in class software.amazon.awssdk.crt.SystemInfo
+
 
+
getCpuInfoForGroup(short) - Static method in class software.amazon.awssdk.crt.SystemInfo
+
+
Get info on all active Cpus in a Cpu group.
+
+
getCredentials() - Method in class software.amazon.awssdk.crt.auth.credentials.CredentialsProvider
+
+
Request credentials from the provider
+
+
getCredentials() - Method in interface software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsHandler
+
+
Called from Native when delegate credential provider needs to fetch a + credential.
+
+
getCredentials() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets the credentials to use for signing.
+
+
getCredentialsProvider() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets the provider to source credentials from before signing
+
+
getCredentialsProvider() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getCredentialsProvider() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getCRuntime(String) - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
getCustomRoleArn() - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
 
+
getDefaultS3SigningConfig(String, CredentialsProvider) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Helper to get the default signing Config for S3.
+
+
getDigestAlgorithm() - Method in class software.amazon.awssdk.crt.io.TlsKeyOperation
+
+
Returns the TLS Hash algorithm used in the digest.
+
+
getDisconnectPacket() - Method in class software.amazon.awssdk.crt.mqtt5.OnDisconnectionReturn
+
+
Returns the ConnAckPacket returned from the server on the disconnection, or Null if none was returned.
+
+
getDup() - Method in class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Gets the DUP flag.
+
+
getEnableS3Express() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getEncodedPath() - Method in class software.amazon.awssdk.crt.http.HttpRequest
+
 
+
getEndpoint() - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
 
+
getEndpoint() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the IoT endpoint used by a connection
+
+
getEndpoint() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getEndpoint() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getEnumIntValue() - Method in enum software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
getEnumValue() - Method in enum software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Creates a Java enum value from a native enum value as an integer
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType
+
+
Creates a Java enum value from a native enum value as an integer
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
Creates a Java enum value from a native enum value as an integer
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve
+
+
Creates a Java enum value from a native enum value as an integer
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.http.HttpVersion
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt.QualityOfService
+
+
Creates a Java QualityOfService enum value from a native integer value
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
Creates a Java ClientOfflineQueueBehavior enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Creates a ClientSessionBehavior enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
+
+
Creates a Java ExtendedValidationAndFlowControlOptions enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Creates a Java ConnectReasonCode enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Creates a Java DisconnectReasonCode enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Creates a Java PubAckReasonCode enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator
+
+
Creates a Java PayloadFormatIndicator enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Creates a Java SubAckReasonCode enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
+
Creates a Java RetainHandlingType enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Creates a Java UnsubAckReasonCode enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType
+
+
Creates a Java PublishResultType enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.QOS
+
+
Creates a Java QualityOfService enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
+
Creates a Java InboundTopicAliasBehaviorType enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
Creates a Java OutboundTopicAliasBehaviorType enum value from a native integer value.
+
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
 
+
getEnumValueFromInteger(int) - Static method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
 
+
getEnvironmentVariableType() - Method in class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
 
+
getErrorCode() - Method in exception software.amazon.awssdk.crt.http.HttpException
+
+
Returns the error code captured when the exception occurred.
+
+
getErrorCode() - Method in class software.amazon.awssdk.crt.mqtt.OnConnectionFailureReturn
+
+
Gets the AWS CRT error code for the connection failure.
+
+
getErrorCode() - Method in class software.amazon.awssdk.crt.mqtt5.OnConnectionFailureReturn
+
+
Returns the error code returned from the server on the connection failure.
+
+
getErrorCode() - Method in class software.amazon.awssdk.crt.mqtt5.OnDisconnectionReturn
+
+
Returns the error code returned from the server on the disconnection.
+
+
getErrorCode() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
 
+
getErrorHeaders() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
+
In the case of a failed HTTP response, get the headers of the response.
+
+
getErrorOperationName() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
 
+
getErrorPayload() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
 
+
getEventLoopGroup() - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
 
+
getExpectedHttpVersion() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getExpirationInSeconds() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets the expiration time in seconds to use when signing to make a pre-signed url.
+
+
getExpirationTimePointSecs() - Method in class software.amazon.awssdk.crt.auth.credentials.Credentials
+
 
+
getExtendedValidationAndFlowControlOptions() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the additional controls for client behavior with respect to operation validation and flow control; + these checks go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.
+
+
getFileSize() - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
getHeaders() - Method in class software.amazon.awssdk.crt.http.HttpRequestBase
+
 
+
getHeadersAsArray() - Method in class software.amazon.awssdk.crt.http.HttpRequestBase
+
 
+
getHeaderType() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the header type of the value.
+
+
getHost() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getHostName() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the host name of the MQTT server to connect to.
+
+
getHostValue() - Method in class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties
+
 
+
getHttpProxyEnvironmentVariableSetting() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getHttpProxyEnvironmentVariableSetting() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getHttpProxyOptions() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries proxy options for an mqtt connection
+
+
getHttpProxyOptions() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the (tunneling) HTTP proxy usage when establishing MQTT connections
+
+
getHttpRequest() - Method in class software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs
+
+
Get the http request that will be used to perform the websocket handshake.
+
+
getHttpRequest() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs
+
+
Get the http request that will be used to perform the websocket handshake.
+
+
getHttpRequest() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getId() - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSetting
+
 
+
getIdealConcurrentStreamsPerConnection() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
getIdentity() - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
 
+
getIncompleteOperationCount() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics
+
+
Returns the total number of operations submitted to the connection that have not yet been completed.
+
+
getIncompleteOperationCount() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics
+
+
Returns the total number of operations submitted to the client that have not yet been completed.
+
+
getIncompleteOperationSize() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics
+
+
Returns the total packet size of operations submitted to the connection that have not yet been completed.
+
+
getIncompleteOperationSize() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics
+
+
Returns the total packet size of operations submitted to the client that have not yet been completed.
+
+
getInitialBucketCapacity() - Method in class software.amazon.awssdk.crt.io.StandardRetryOptions
+
 
+
getInitialReadWindowSize() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getInitialSettingsList() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
getInput() - Method in class software.amazon.awssdk.crt.io.TlsKeyOperation
+
+
Returns the input data from native that needs to be operated on using the private key.
+
+
getIsConnected() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Returns the connectivity state for the Mqtt5Client.
+
+
getJitterMode() - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
 
+
getKeepAliveIntervalSec() - Method in class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
getKeepAliveIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns the maximum time interval, in seconds, that is permitted to elapse between the point at which the client + finishes transmitting one MQTT packet and the point it starts sending the next.
+
+
getKeepAliveMaxFailedProbes() - Method in class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
getKeepAliveMs() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
Queries the MQTT keep-alive via PING messages. Please use + getKeepAliveSecs instead.
+
+
+
getKeepAliveSecs() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the MQTT keep-alive via PING messages.
+
+
getKeepAliveTimeoutSec() - Method in class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
getLeasedConcurrency() - Method in class software.amazon.awssdk.crt.http.HttpManagerMetrics
+
 
+
getLength() - Method in interface software.amazon.awssdk.crt.http.HttpRequestBodyStream
+
+
Called from native when the processing needs to know the length of the stream.
+
+
getLifecycleEvents() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the LifecycleEvents interface that will be called when the client gets a LifecycleEvent.
+
+
getLogins() - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
 
+
getManagerMetrics() - Method in class software.amazon.awssdk.crt.http.Http2StreamManager
+
 
+
getManagerMetrics() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
 
+
getMaxConcurrentStreamsPerConnection() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
getMaxConnectionIdleInMilliseconds() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getMaxConnections() - Method in class software.amazon.awssdk.crt.http.Http2StreamManager
+
 
+
getMaxConnections() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
 
+
getMaxConnections() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getMaxConnections() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getMaximumPacketSize() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns the maximum packet size, in bytes, that the server is willing to accept.
+
+
getMaximumPacketSizeBytes() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns the maximum packet size the client is willing to handle.
+
+
getMaximumPacketSizeToServer() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getMaximumQOS() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getMaximumQOS() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns the maximum message delivery quality of service that the server will allow on this connection.
+
+
getMaxIOHandlesHardLimit() - Static method in class software.amazon.awssdk.crt.Process
+
+
Gets the hard limit for IO handles for this process (max fds in unix terminology).
+
+
getMaxIOHandlesSoftLimit() - Static method in class software.amazon.awssdk.crt.Process
+
+
Gets the soft limit for IO handles for this process (max fds in unix terminology)
+
+
getMaxPendingConnectionAcquisitions() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getMaxReconnectDelayMs() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the maximum amount of time to wait to reconnect after a disconnect.
+
+
getMaxReconnectTimeoutSecs() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Return the maximum reconnect timeout.
+
+
getMaxRetries() - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
 
+
getMemoryLimitInBytes() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
Retrieves the memory limit set for the CRT client in bytes.
+
+
getMessageBuffer() - Method in class software.amazon.awssdk.crt.eventstream.Message
+
+
Get the binary format of this message (i.e.
+
+
getMessageExpiryIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Sent publishes - Returns the maximum amount of time allowed to elapse for message delivery before the server + should instead delete the message (relative to a recipient).
+
+
getMetaRequestType() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getMethod() - Method in class software.amazon.awssdk.crt.http.HttpRequest
+
 
+
getMinConnectedTimeToResetReconnectDelayMs() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum.
+
+
getMinReconnectDelayMs() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the minimum amount of time to wait to reconnect after a disconnect.
+
+
getMinReconnectTimeoutSecs() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Return the minimum reconnect timeout.
+
+
getMinThroughputBytesPerSecond() - Method in class software.amazon.awssdk.crt.http.HttpMonitoringOptions
+
 
+
getMonitoringOptions() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getMonitoringOptions() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getMqtt5Client() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the mqtt5 client to use for a connection
+
+
getMqttClient() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the mqtt client to use for a connection
+
+
getMqttClient() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs
+
+
Queries the Mqtt5Client.
+
+
getMqttClientConnection() - Method in class software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs
+
+
Queries the mqtt client connection.
+
+
getMultiPartUploadThreshold() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getName() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the name of the header as a (UTF-8) string
+
+
getName() - Method in class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
getNameBytes() - Method in class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
getNativeHandle() - Method in class software.amazon.awssdk.crt.CrtResource
+
+
returns the native handle associated with this CRTResource.
+
+
getNativeHandle() - Method in class software.amazon.awssdk.crt.io.SocketOptions
+
 
+
getNativeHandle() - Method in class software.amazon.awssdk.crt.io.TlsConnectionOptions
+
+
Note: Once this gets invoked the native resource will not be able to changed.
+
+
getNativeHandle() - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Gets the native enum value as an integer that is associated with this Java enum value
+
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType
+
+
Gets the native enum value as an integer that is associated with this Java enum value
+
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
Trivial Java Enum value to native enum value conversion function
+
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve
+
+
Gets the native enum value as an integer that is associated with this Java enum value
+
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
 
+
getNativeValue() - Method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
 
+
getNegotiatedSettings() - Method in class software.amazon.awssdk.crt.mqtt5.OnConnectionSuccessReturn
+
+
Returns the NegotiatedSettings returned from the server on the connection success or Null if none was returned.
+
+
getNoLocal() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
+
+
Returns whether the server should not send publishes to a client when that client was the one who sent the publish.
+
+
getNumPartsCompleted() - Method in class software.amazon.awssdk.crt.s3.ResumeToken
+
 
+
getObjectSizeHint() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getOfflineQueueBehavior() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns how disconnects affect the queued and in-progress operations tracked by the client.
+
+
getOmitSessionToken() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets whether or not X-Amz-Session-Token should be added to the canonical request when signing with session + credentials.
+
+
getOperationHandler() - Method in class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
+
+
Returns the TlsKeyOperationHandler assigned to this class.
+
+
getOperationName() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getOperationStatistics() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Returns statistics about the current state of the MqttClientConnection's + queue of operations.
+
+
getOperationStatistics() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Returns statistics about the current state of the Mqtt5Client's queue of operations.
+
+
getOrCreateStaticDefault() - Static method in class software.amazon.awssdk.crt.io.ClientBootstrap
+
+
This default will be used when a ClientBootstrap is not explicitly passed but is needed + to allow the process to function.
+
+
getOSIdentifier() - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
getOSIdentifier() - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
getPartSize() - Method in class software.amazon.awssdk.crt.s3.ResumeToken
+
 
+
getPartSize() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getPassword() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the password to use as part of the CONNECT attempt
+
+
getPassword() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns opaque binary data that the server may use for client authentication and authorization.
+
+
getPath() - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
getPayload() - Method in class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Gets the message payload
+
+
getPayload() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns the payload of the publish message.
+
+
getPayloadFormat() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns the property specifying the format of the payload data.
+
+
getPendingConcurrencyAcquires() - Method in class software.amazon.awssdk.crt.http.HttpManagerMetrics
+
 
+
getPid() - Static method in class software.amazon.awssdk.crt.Process
+
+
Gets the process id of the running process.
+
+
getPingTimeoutMs() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries ping timeout value.
+
+
getPingTimeoutMs() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the time interval to wait after sending a PINGREQ for a PINGRESP to arrive.
+
+
getPlatformImpl() - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
getPort() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getPort() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getPort() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the port to connect to.
+
+
getPort() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the network port of the MQTT server to connect to.
+
+
getProcessorCount() - Static method in class software.amazon.awssdk.crt.SystemInfo
+
 
+
getProtocolOperationTimeoutMs() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries timeout value for requests that response is required on healthy connection.
+
+
getProxyOptions() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getProxyOptions() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getPublishEvents() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the PublishEvents interface that will be called when the client gets a message.
+
+
getPublishPacket() - Method in class software.amazon.awssdk.crt.mqtt5.PublishReturn
+
+
Returns the PublishPacket returned from the server or Null if none was returned.
+
+
getQos() - Method in class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Gets the QualityOfService.
+
+
getQOS() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Sent publishes - Returns the MQTT quality of service level this message should be delivered with.
+
+
getQOS() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
+
+
Returns the maximum QoS on which the subscriber will accept publish messages.
+
+
getReadBackpressureEnabled() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getReasonCode() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns an indicator that is either success or the reason for failure for the connection attempt.
+
+
getReasonCode() - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket
+
+
Returns a value indicating the reason that the sender is closing the connection + + See MQTT5 Disconnect Reason Code
+
+
getReasonCode() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket
+
+
Returns success indicator or failure reason for the associated PublishPacket.
+
+
getReasonCodes() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket
+
+
Returns a list of reason codes indicating the result of each individual subscription entry in the + associated SubscribePacket.
+
+
getReasonCodes() - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket
+
+
Returns a list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the + associated UNSUBSCRIBE packet.
+
+
getReasonString() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns additional diagnostic information about the result of the connection attempt.
+
+
getReasonString() - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket
+
+
Returns additional diagnostic information about the reason that the sender is closing the connection + + See MQTT5 Reason String
+
+
getReasonString() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket
+
+
Returns additional diagnostic information about the result of the PUBLISH attempt.
+
+
getReasonString() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket
+
+
Returns additional diagnostic information about the result of the SUBSCRIBE attempt.
+
+
getReasonString() - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket
+
+
Returns additional diagnostic information about the result of the UNSUBSCRIBE attempt.
+
+
getReceiveEndTimestampNs() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getReceiveMaximum() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns the maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once.
+
+
getReceiveMaximum() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
+
+
getReceiveMaximumFromServer() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getReceiveStartTimestampNs() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getReceivingDurationNs() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getRegion() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets what will be used for the region or region-set concept during signing.
+
+
getRegion() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getRegion() - Method in class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties
+
 
+
getRejoinedSession() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getRelativePath() - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
getRequestFilePath() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getRequestProblemInformation() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a boolean that, if true, requests that the server send additional diagnostic information (via response string or + user properties) in DisconnectPacket or ConnAckPacket from the server.
+
+
getRequestResponseInformation() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a boolean that, if true, requests that the server send response information in the subsequent ConnAckPacket.
+
+
getResourceLogDescription() - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Gets a debug/diagnostic string describing this resource and its reference state
+
+
getResourcePath(String, String) - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
getResponseFileDeleteOnFailure() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getResponseFileOption() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getResponseFilePath() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getResponseFilePosition() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getResponseHandler() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getResponseInformation() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns a value that can be used in the creation of a response topic associated with this connection.
+
+
getResponseStatus() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
 
+
getResponseStatusCode() - Method in class software.amazon.awssdk.crt.http.HttpStreamBase
+
+
Retrieves the Http Response Status Code
+
+
getResponseTopic() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns a opaque topic string intended to assist with request/response implementations.
+
+
getResultPubAck() - Method in class software.amazon.awssdk.crt.mqtt5.PublishResult
+
+
Returns the data contained in the PublishResult for a PublishResultType of PUBACK.
+
+
getResumeToken() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getRetain() - Method in class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Gets the retain flag.
+
+
getRetain() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns true if this is a retained message, false otherwise.
+
+
getRetainAsPublished() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
+
+
Returns whether messages sent due to this subscription keep the retain flag preserved on the message.
+
+
getRetainAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getRetainAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns an indicator whether the server supports retained messages.
+
+
getRetainHandlingType() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
+
+
Returns whether retained messages on matching topics be sent in reaction to this subscription.
+
+
getRetryJitterMode() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt + time points for a large set of reconnecting clients.
+
+
getS3ExpressCredentials(S3ExpressCredentialsProperties, Credentials) - Method in interface software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderHandler
+
+
To resolve the S3Express Credentials.
+
+
getS3ExpressCredentials(S3ExpressCredentialsProperties, Credentials, long) - Method in class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProvider
+
 
+
getS3ExpressCredentialsProviderFactory() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getSecretAccessKey() - Method in class software.amazon.awssdk.crt.auth.credentials.Credentials
+
 
+
getSendEndTimestampNs() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getSendingDurationNs() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getSendStartTimestampNs() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getServerKeepAlive() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
+
Deprecated. +
prefer getServerKeepAliveSeconds
+
+
+
getServerKeepAlive() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Deprecated. +
prefer getServerKeepAliveSeconds
+
+
+
getServerKeepAliveSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
+
Returns the maximum amount of time in seconds between client packets.
+
+
getServerKeepAliveSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns server-requested override of the keep alive interval, in seconds.
+
+
getServerReference() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint.
+
+
getServerReference() - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket
+
+
Returns a property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint.
+
+
getService() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets what service signing name will be used
+
+
getSessionBehavior() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns how the Mqtt5Client should behave with respect to MQTT sessions.
+
+
getSessionExpiryInterval() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
+
Deprecated. +
prefer getSessionExpiryIntervalSeconds instead
+
+
+
getSessionExpiryInterval() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Deprecated. +
prefer getSessionExpiryIntervalSeconds
+
+
+
getSessionExpiryIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getSessionExpiryIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns a time interval, in seconds, that the server will persist this connection's MQTT session state + for.
+
+
getSessionExpiryIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a time interval, in seconds, that the client requests the server to persist this connection's MQTT session state + for.
+
+
getSessionExpiryIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket
+
+
Returns a change to the session expiry interval negotiated at connection time as part of the disconnect.
+
+
getSessionPresent() - Method in class software.amazon.awssdk.crt.mqtt.OnConnectionSuccessReturn
+
+
Returns whether a session was present and resumed for this successful connection.
+
+
getSessionPresent() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns true if the client rejoined an existing session on the server, false otherwise.
+
+
getSessionToken() - Method in class software.amazon.awssdk.crt.auth.credentials.Credentials
+
 
+
getSharedSubscriptionsAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getSharedSubscriptionsAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns whether the server supports shared subscription topic filters.
+
+
getShouldNormalizeUriPath() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets whether or not the uri path should be normalized during canonical request construction
+
+
getShouldSignHeader() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets the header-name signing predicate filter to use
+
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.auth.credentials.CredentialsProvider
+
+
Learn when this object has finished shutting down.
+
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.eventstream.ServerListener
+
 
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.http.Http2StreamManager
+
 
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
 
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.io.ClientBootstrap
+
 
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.io.EventLoopGroup
+
 
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.s3.S3Client
+
 
+
getShutdownCompleteFuture() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequest
+
 
+
getSignature() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningResult
+
+
Gets the signature value from the result.
+
+
getSignatureAlgorithm() - Method in class software.amazon.awssdk.crt.io.TlsKeyOperation
+
+
Returns the TLS algorithm used in the signature.
+
+
getSignatureType() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets what kind of signature will be computed
+
+
getSignedBodyHeader() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets what signed body header should hold the payload hash (or override value).
+
+
getSignedBodyValue() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets the payload hash override to use in canonical request construction.
+
+
getSignedRequest() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningResult
+
+
Gets the signed http request from the result
+
+
getSigningConfig() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getSigningConfig() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
getSocketOptions() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getSocketOptions() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the common settings to use for a connection's socket
+
+
getSocketOptions() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the socket properties of the underlying MQTT connections made by the client.
+
+
getStandardRetryOptions() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getStreamId() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
getSubscriptionIdentifier() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket
+
+
Returns the positive long to associate with all subscriptions in this request.
+
+
getSubscriptionIdentifiers() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Sent publishes - Ignored + + Received publishes - Returns the subscription identifiers of all the subscriptions this message matched.
+
+
getSubscriptionIdentifiersAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getSubscriptionIdentifiersAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns whether the server supports subscription identifiers.
+
+
getSubscriptions() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket
+
+
Returns the list of subscriptions that the client wishes to listen to + + See MQTT5 Subscribe Payload
+
+
getSubscriptions() - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket
+
+
Returns a list of subscriptions that the client wishes to unsubscribe from.
+
+
getTcpKeepAliveOptions() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getThroughputTargetGbps() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getTime() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets the point in time (in milliseconds since epoch) that signing will be done relative to
+
+
getTlsConnectionOptions() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getTlsConnectionOptions() - Method in class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
 
+
getTlsContext() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getTlsContext() - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
 
+
getTlsContext() - Method in class software.amazon.awssdk.crt.mqtt.MqttClient
+
 
+
getTlsContext() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the TLS context for secure socket connections.
+
+
getTlsContext() - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
getTopic() - Method in class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Gets the topic associated with this message
+
+
getTopic() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Sent publishes - Returns the topic this message should be published to.
+
+
getTopicAlias() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Sent publishes - topic alias to use, if possible, when encoding this packet.
+
+
getTopicAliasingOptions() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the topic aliasing options to be used by the client
+
+
getTopicAliasMaximum() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns the maximum topic alias value that the server will accept from the client.
+
+
getTopicAliasMaximumToClient() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getTopicAliasMaximumToServer() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getTopicFilter() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
+
+
Returns the topic filter to subscribe to + + See MQTT5 Subscription Options
+
+
getTotalByteLength() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
 
+
getTotalNumParts() - Method in class software.amazon.awssdk.crt.s3.ResumeToken
+
 
+
getType() - Method in class software.amazon.awssdk.crt.io.TlsKeyOperation
+
+
Returns the operation that needs to be performed.
+
+
getType() - Method in class software.amazon.awssdk.crt.mqtt5.PublishResult
+
+
Returns the type of data that was returned after calling Publish on the Mqtt5Client.
+
+
getType() - Method in class software.amazon.awssdk.crt.s3.ResumeToken
+
 
+
getUnackedOperationCount() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics
+
+
Returns the total number of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
+
+
getUnackedOperationCount() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics
+
+
Returns the total number of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
+
+
getUnackedOperationSize() - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics
+
+
Returns the total packet size of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
+
+
getUnackedOperationSize() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics
+
+
Returns the total packet size of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
+
+
getUploadId() - Method in class software.amazon.awssdk.crt.s3.ResumeToken
+
 
+
getUri() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
 
+
getUri() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getUseDoubleUriEncode() - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Gets whether or not signing will uri encode urls during canonical request construction
+
+
getUsername() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the username to use as part of the CONNECT attempt
+
+
getUsername() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a string value that the server may use for client authentication and authorization.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket
+
+
Returns the list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUserProperties() - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket
+
+
Returns a list of MQTT5 user properties included with the packet.
+
+
getUseWebsockets() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries whether or not to use websockets for the mqtt connection
+
+
getValidateChecksum() - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
 
+
getValidateChecksum() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Deprecated. 
+
+
getValidateChecksumAlgorithmList() - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
 
+
getValue() - Method in class software.amazon.awssdk.crt.checksums.CRC32
+
+
Returns the current checksum value.
+
+
getValue() - Method in class software.amazon.awssdk.crt.checksums.CRC32C
+
+
Returns the current checksum value.
+
+
getValue() - Method in class software.amazon.awssdk.crt.checksums.CRC64NVME
+
+
Returns the current checksum value.
+
+
getValue() - Method in enum software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
getValue() - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSetting
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
getValue() - Method in class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.http.HttpHeaderBlock
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.http.HttpVersion
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.Log.LogLevel
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.Log.LogSubject
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt.QualityOfService
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
 
+
getValue() - Method in class software.amazon.awssdk.crt.mqtt5.PublishResult
+
+
Returns the data contained in the PubAck result.
+
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.QOS
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
 
+
getValue() - Method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
 
+
getValueAsBoolean() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a boolean.
+
+
getValueAsByte() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a byte or int8.
+
+
getValueAsBytes() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a byte[].
+
+
getValueAsInt() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as an int or int32.
+
+
getValueAsLong() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a long or int64.
+
+
getValueAsShort() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a short or int16.
+
+
getValueAsString() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a utf-8 encoded string.
+
+
getValueAsTimestamp() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a Date.
+
+
getValueAsUUID() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Gets the value as a UUID.
+
+
getValueBytes() - Method in class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
getValueFromInt(int) - Static method in enum software.amazon.awssdk.crt.eventstream.HeaderType
+
+
Creates a Java header type enum from an associated native integer value
+
+
getVersion() - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
getVersion() - Method in class software.amazon.awssdk.crt.http.HttpClientConnection
+
 
+
getWebsocketHandshakeTransform() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the handshake http request transform to use when upgrading the connection
+
+
getWebsocketHandshakeTransform() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Returns the callback that allows a custom transformation of the HTTP request which acts as the websocket handshake.
+
+
getWebsocketProxyOptions() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
use getHttpProxyOptions instead + Queries proxy options for a websocket-based mqtt connection
+
+
+
getWildcardSubscriptionsAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
getWildcardSubscriptionsAvailable() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
+
+
Returns whether the server supports wildcard subscriptions.
+
+
getWill() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns the definition of a message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first.
+
+
getWillDelayIntervalSeconds() - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
+
+
Returns a time interval, in seconds, that the server should wait (for a session reconnection) before sending the + will message associated with the connection's session.
+
+
getWillMessage() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Queries the last will and testament message to be delivered to a topic when a connection disconnects
+
+
getWillQos() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
Query QoS directly from the will's MqttMessage.
+
+
+
getWillRetain() - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
Query retain directly from the will's MqttMessage.
+
+
+
getWindowSize() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
 
+
getWindowSize() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
getWireBytesOverhead() - Method in enum software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
getWrapper() - Method in class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
GRANTED_QOS_0 - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription was accepted and the maximum QoS sent will be QoS 0.
+
+
GRANTED_QOS_1 - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription was accepted and the maximum QoS sent will be QoS 1.
+
+
GRANTED_QOS_2 - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription was accepted and the maximum QoS sent will be QoS 2.
+
+
+ + + +

H

+
+
hashCode() - Method in class software.amazon.awssdk.crt.eventstream.Header
+
 
+
hasPriorKnowledge() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
Header - Class in software.amazon.awssdk.crt.eventstream
+
+
Event-stream header.
+
+
HEADER - software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation
+
 
+
HEADER_TABLE_SIZE - software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
headerTableSize(long) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
+
The SETTINGS_HEADER_TABLE_SIZE.
+
+
HeaderType - Enum in software.amazon.awssdk.crt.eventstream
+
+
Java mirror of the native aws_event_stream_header_value_type enum, specifying properties of + the type of a header's value
+
+
HostResolver - Class in software.amazon.awssdk.crt.io
+
+
Java wrapper around the native CRT host resolver, responsible for performing async dns lookups
+
+
HostResolver(EventLoopGroup) - Constructor for class software.amazon.awssdk.crt.io.HostResolver
+
 
+
HostResolver(EventLoopGroup, int) - Constructor for class software.amazon.awssdk.crt.io.HostResolver
+
 
+
HTTP_1_0 - software.amazon.awssdk.crt.http.HttpVersion
+
 
+
HTTP_1_1 - software.amazon.awssdk.crt.http.HttpVersion
+
 
+
HTTP_1_1_REQUIRED - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
HTTP_2 - software.amazon.awssdk.crt.http.HttpVersion
+
 
+
HTTP_REQUEST_CHUNK - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Compute a signature for a payload chunk.
+
+
HTTP_REQUEST_EVENT - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Compute a signature for an event stream event.
+
+
HTTP_REQUEST_TRAILING_HEADERS - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Compute a signature for a payloads trailing headers.
+
+
HTTP_REQUEST_VIA_HEADERS - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
A signature for a full http request should be computed, with header updates applied to the signing result.
+
+
HTTP_REQUEST_VIA_QUERY_PARAMS - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
A signature for a full http request should be computed, with query param updates applied to the signing result.
+
+
Http2ClientConnection - Class in software.amazon.awssdk.crt.http
+
+
This class wraps aws-c-http to provide the basic HTTP/2 request/response + functionality via the AWS Common Runtime.
+
+
Http2ClientConnection(long) - Constructor for class software.amazon.awssdk.crt.http.Http2ClientConnection
+
 
+
Http2ClientConnection.Http2ErrorCode - Enum in software.amazon.awssdk.crt.http
+
 
+
Http2ConnectionSetting - Class in software.amazon.awssdk.crt.http
+
 
+
Http2ConnectionSetting(Http2ConnectionSetting.ID, long) - Constructor for class software.amazon.awssdk.crt.http.Http2ConnectionSetting
+
+
HTTP/2 connection setting.
+
+
Http2ConnectionSetting.ID - Enum in software.amazon.awssdk.crt.http
+
+
Predefined settings identifiers (RFC-7540 6.5.2).
+
+
Http2ConnectionSettingListBuilder - Class in software.amazon.awssdk.crt.http
+
 
+
Http2ConnectionSettingListBuilder() - Constructor for class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
 
+
Http2Request - Class in software.amazon.awssdk.crt.http
+
+
Represents a single Client Request to be sent on a HTTP connection
+
+
Http2Request() - Constructor for class software.amazon.awssdk.crt.http.Http2Request
+
+
An empty HTTP/2 Request.
+
+
Http2Request(HttpHeader[], HttpRequestBodyStream) - Constructor for class software.amazon.awssdk.crt.http.Http2Request
+
+
An empty HTTP/2 Request with headers and body stream.
+
+
Http2Stream - Class in software.amazon.awssdk.crt.http
+
+
An HttpStream represents a single HTTP/2 specific Http Request/Response.
+
+
Http2StreamManager - Class in software.amazon.awssdk.crt.http
+
+
Manages a Pool of HTTP/2 Streams.
+
+
Http2StreamManagerOptions - Class in software.amazon.awssdk.crt.http
+
+
Contains all the configuration options for a Http2StreamManager + instance
+
+
Http2StreamManagerOptions() - Constructor for class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Default constructor
+
+
HttpClientConnection - Class in software.amazon.awssdk.crt.http
+
+
This class wraps aws-c-http to provide the basic HTTP request/response functionality via the AWS Common Runtime.
+
+
HttpClientConnectionManager - Class in software.amazon.awssdk.crt.http
+
+
Manages a Pool of Http Connections
+
+
HttpClientConnectionManagerOptions - Class in software.amazon.awssdk.crt.http
+
+
Contains all the configuration options for a HttpConnectionPoolManager instance
+
+
HttpClientConnectionManagerOptions() - Constructor for class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Default constructor
+
+
HttpConnection - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
HttpConnectionManager - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
HttpException - Exception in software.amazon.awssdk.crt.http
+
+
This exception will be thrown by any exceptional cases encountered within the + JNI bindings to the AWS Common Runtime
+
+
HttpException(int) - Constructor for exception software.amazon.awssdk.crt.http.HttpException
+
+
Constructs a new HttpException
+
+
HttpGeneral - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
HttpHeader - Class in software.amazon.awssdk.crt.http
+
+
A wrapper class for http header key-value pairs
+
+
HttpHeader(byte[], byte[]) - Constructor for class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
HttpHeader(String, String) - Constructor for class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
HttpHeaderBlock - Enum in software.amazon.awssdk.crt.http
+
+
Type of header block.
+
+
HttpManagerMetrics - Class in software.amazon.awssdk.crt.http
+
 
+
HttpMonitoringOptions - Class in software.amazon.awssdk.crt.http
+
+
This class provides access to basic http connection monitoring controls in lieu of the more traditional + timeouts.
+
+
HttpMonitoringOptions() - Constructor for class software.amazon.awssdk.crt.http.HttpMonitoringOptions
+
+
Creates a new set of monitoring options
+
+
HttpProxyEnvironmentVariableSetting - Class in software.amazon.awssdk.crt.http
+
+
This class provides access to Http proxy environment variable configuration + setting
+
+
HttpProxyEnvironmentVariableSetting() - Constructor for class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
+
Creates a new set of environment variable proxy setting + By Default environmentVariableType is set to Enable.
+
+
HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType - Enum in software.amazon.awssdk.crt.http
+
 
+
HttpProxyOptions - Class in software.amazon.awssdk.crt.http
+
+
This class provides access to Http proxy configuration options
+
+
HttpProxyOptions() - Constructor for class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Creates a new set of proxy options
+
+
HttpProxyOptions.HttpProxyAuthorizationType - Enum in software.amazon.awssdk.crt.http
+
+
what kind of authentication, if any, to use when connecting to a proxy server
+
+
HttpProxyOptions.HttpProxyConnectionType - Enum in software.amazon.awssdk.crt.http
+
+
What kind of proxy connection to establish
+
+
HttpRequest - Class in software.amazon.awssdk.crt.http
+
+
Represents a single Client Request to be sent on a HTTP connection
+
+
HttpRequest(String, String) - Constructor for class software.amazon.awssdk.crt.http.HttpRequest
+
 
+
HttpRequest(String, String, HttpHeader[], HttpRequestBodyStream) - Constructor for class software.amazon.awssdk.crt.http.HttpRequest
+
 
+
HttpRequestBase - Class in software.amazon.awssdk.crt.http
+
 
+
HttpRequestBodyStream - Interface in software.amazon.awssdk.crt.http
+
+
Interface that Native code knows how to call when handling Http Request bodies
+
+
HttpServer - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
HttpStream - Class in software.amazon.awssdk.crt.http
+
+
An HttpStream represents a single HTTP/1.1 specific Http Request/Response.
+
+
HttpStream - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
HttpStream.HttpStreamWriteChunkCompletionCallback - Interface in software.amazon.awssdk.crt.http
+
+
Completion interface for writing chunks to an http stream
+
+
HttpStreamBase - Class in software.amazon.awssdk.crt.http
+
+
An base class represents a single Http Request/Response for both HTTP/1.1 and + HTTP/2 and wraps the native resources from the aws-c-http library.
+
+
HttpStreamBaseResponseHandler - Interface in software.amazon.awssdk.crt.http
+
+
Interface that Native code knows how to call when handling Http Responses + + Maps 1-1 to the Native Http API here: + https://github.com/awslabs/aws-c-http/blob/master/include/aws/http/request_response.h
+
+
HttpStreamMetrics - Class in software.amazon.awssdk.crt.http
+
+
Holds tracing metrics for an HTTP stream.
+
+
HttpStreamResponseHandler - Interface in software.amazon.awssdk.crt.http
+
+
Interface that Native code knows how to call when handling Http Responses for HTTP/1.1 only.
+
+
HttpVersion - Enum in software.amazon.awssdk.crt.http
+
 
+
HttpWebsocket - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
HttpWebsocketSetup - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
+ + + +

I

+
+
identityProviderName - Variable in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoLoginTokenPair
+
 
+
identityProviderToken - Variable in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoLoginTokenPair
+
 
+
IMPLEMENTATION_SPECIFIC_ERROR - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the ConnectPacket is valid but was not accepted by the server.
+
+
IMPLEMENTATION_SPECIFIC_ERROR - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when a valid packet was received by the remote endpoint, but could not be processed by the current implementation.
+
+
IMPLEMENTATION_SPECIFIC_ERROR - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the (QoS 1) publish was valid but the receiver was not willing to accept it.
+
+
IMPLEMENTATION_SPECIFIC_ERROR - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription was valid but the server did not accept it.
+
+
IMPLEMENTATION_SPECIFIC_ERROR - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the topic filter was valid but the server does not accept an unsubscribe for it.
+
+
INADEQUATE_SECURITY - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
incrementReadWindow(long) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequest
+
+
Increment the flow-control window, so that response data continues downloading.
+
+
incrementWindow(int) - Method in class software.amazon.awssdk.crt.http.HttpStreamBase
+
+
Increment the flow-control window, so that response data continues downloading.
+
+
Info - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
INFORMATIONAL - software.amazon.awssdk.crt.http.HttpHeaderBlock
+
 
+
INITIAL_WINDOW_SIZE - software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
initialWindowSize(long) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
+
The SETTINGS_INITIAL_WINDOW_SIZE.
+
+
initLoggingFromSystemProperties() - Static method in class software.amazon.awssdk.crt.Log
+
+
Examines logging-related system properties and initializes the logging system if they + have been properly set.
+
+
initLoggingToFile(Log.LogLevel, String) - Static method in class software.amazon.awssdk.crt.Log
+
+
Initializes logging to go to a file
+
+
initLoggingToStderr(Log.LogLevel) - Static method in class software.amazon.awssdk.crt.Log
+
+
Initializes logging to go to stderr
+
+
initLoggingToStdout(Log.LogLevel) - Static method in class software.amazon.awssdk.crt.Log
+
+
Initializes logging to go to stdout
+
+
initMtls(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the certificate/key pair that identifies this mutual TLS (mTLS) host.
+
+
initMtlsFromPath(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the path to the certificate that identifies this mutual TLS (mTLS) host.
+
+
initMtlsPkcs12(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Apple platforms only - Initializes mutual TLS (mTLS) with PKCS12 file and password
+
+
Int16 - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
Int32 - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
Int64 - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
INTERNAL_ERROR - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
IoAlpn - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoChannel - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoChannelBootstrap - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoDns - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoEventLoop - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoFileUtils - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoGeneral - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoPki - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoSharedLibrary - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoSocket - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoSocketHandler - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IoTls - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
IPv4 - software.amazon.awssdk.crt.io.SocketOptions.SocketDomain
+
+
Corresponds to PF_INET in Berkeley sockets
+
+
IPv6 - software.amazon.awssdk.crt.io.SocketOptions.SocketDomain
+
+
Corresponds to PF_INET6 in Berkeley sockets
+
+
isAlpnSupported() - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Returns whether or not ALPN is supported on the current platform
+
+
isChecksumValidated() - Method in class software.amazon.awssdk.crt.s3.S3FinishedResponseContext
+
 
+
isCipherPreferenceSupported(TlsCipherPreference) - Static method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Returns whether or not the current platform can be configured to a specific TlsCipherPreference.
+
+
isClosed() - Method in class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuation
+
 
+
isConnectionManualWindowManagement() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
isConnectionOpen() - Method in class software.amazon.awssdk.crt.eventstream.ServerConnection
+
 
+
isDirectory() - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
isErrorRetryable(HttpException) - Static method in class software.amazon.awssdk.crt.http.HttpClientConnection
+
+
Certain exceptions thrown by this HTTP API are from invalid boundary conditions + that, if the request isn't altered, will never succeed.
+
+
isFile() - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
isFIPS() - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
isManualWindowManagement() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
 
+
isNull() - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Checks if this resource's native handle is NULL.
+
+
isOpen() - Method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
 
+
isOpen() - Method in class software.amazon.awssdk.crt.http.HttpClientConnection
+
+
Check the underlying http connection is still open or not.
+
+
isSupported() - Method in enum software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Not all Cipher Preferences are supported on all Platforms due to differences in the underlying TLS Libraries.
+
+
isSuspectedHyperThread - Variable in class software.amazon.awssdk.crt.SystemInfo.CpuInfo
+
+
If true, the Cpu is suspected of being virtual.
+
+
isSymLink() - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
 
+
isVariableLength() - Method in enum software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
+ + + +

J

+
+
JavaAndroidKeychain - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
JavaCrtGeneral - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
JavaCrtResource - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
JavaCrtS3 - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
join(CharSequence, Iterable<? extends CharSequence>) - Static method in class software.amazon.awssdk.crt.utils.StringUtils
+
+
Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter.
+
+
jvmInit() - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
+ + + +

K

+
+
KEEP_ALIVE_TIMEOUT - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the server closes the connection because no packet from the client has been received in + 1.5 times the KeepAlive time set when the connection was established.
+
+
keepAlive - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
If true, enables periodic transmits of keepalive messages for detecting a disconnected peer.
+
+
keepAliveIntervalSecs - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Sets the number of seconds between TCP keepalive packets being sent to the peer + 0 disables keepalive
+
+
keepAliveMaxFailedProbes - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Sets the number of keep alive probes allowed to fail before the connection is considered lost.
+
+
keepAliveTimeoutSecs - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Sets the number of seconds to wait for a keepalive response before considering the connection timed out + 0 disables keepalive
+
+
key - Variable in class software.amazon.awssdk.crt.mqtt5.packets.UserProperty
+
 
+
+ + + +

L

+
+
Legacy - software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType
+
+
The legacy default connection type: + (1) If Tls is being used to connect to the endpoint, use tunneling + (2) otherwise use forwarding
+
+
loadHeadersFromMarshalledHeadersBlob(ByteBuffer) - Static method in class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
loadHeadersListFromMarshalledHeadersBlob(ByteBuffer) - Static method in class software.amazon.awssdk.crt.http.HttpHeader
+
+
Each header is marshalled as + [4-bytes BE name length] [variable length name value] [4-bytes BE value length] [variable length value value]
+
+
LOCAL - software.amazon.awssdk.crt.io.SocketOptions.SocketDomain
+
+
Corresponds to PF_LOCAL in Berkeley sockets, usually UNIX domain sockets or named pipes
+
+
location() - Method in class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
log(Log.LogLevel, Log.LogSubject, String) - Static method in class software.amazon.awssdk.crt.Log
+
+
Logs a message at the specified log level.
+
+
Log - Class in software.amazon.awssdk.crt
+
+
Static wrapper around native and crt logging.
+
+
Log() - Constructor for class software.amazon.awssdk.crt.Log
+
 
+
Log.LogLevel - Enum in software.amazon.awssdk.crt
+
+
Enum that controls how detailed logging should be.
+
+
Log.LogSubject - Enum in software.amazon.awssdk.crt
+
 
+
logNativeResources() - Static method in class software.amazon.awssdk.crt.CrtResource
+
+
Debug method to log all of the currently un-closed CRTResource objects.
+
+
logNativeResources(Log.LogLevel) - Static method in class software.amazon.awssdk.crt.CrtResource
+
 
+
LRU - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
(Recommended) The client will ignore any user-specified topic aliasing and instead use an LRU cache to drive + alias usage.
+
+
+ + + +

M

+
+
MAIN - software.amazon.awssdk.crt.http.HttpHeaderBlock
+
 
+
major - Variable in class software.amazon.awssdk.crt.utils.PackageInfo.Version
+
 
+
makeMetaRequest(S3MetaRequestOptions) - Method in class software.amazon.awssdk.crt.s3.S3Client
+
 
+
makeRequest(HttpRequestBase, HttpStreamBaseResponseHandler) - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
+
Schedules an HttpRequest on the Native EventLoop for this + HttpClientConnection.
+
+
makeRequest(HttpRequestBase, HttpStreamBaseResponseHandler) - Method in class software.amazon.awssdk.crt.http.HttpClientConnection
+
+
Schedules an HttpRequestBase on the Native EventLoop for this HttpClientConnection applies to both HTTP/2 and HTTP/1.1 connection.
+
+
makeRequest(HttpRequest, HttpStreamResponseHandler) - Method in class software.amazon.awssdk.crt.http.HttpClientConnection
+
+
Schedules an HttpRequest on the Native EventLoop for this HttpClientConnection specific to HTTP/1.1 connection.
+
+
MALFORMED_PACKET - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when data in the ConnectPacket could not be correctly parsed by the server.
+
+
MALFORMED_PACKET - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Indicates the remote endpoint received a packet that does not conform to the MQTT specification.
+
+
Manual - software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
Outbound aliasing is the user's responsibility.
+
+
marshalHeadersForJni(List<HttpHeader>) - Static method in class software.amazon.awssdk.crt.http.HttpHeader
+
+
Lists of headers are marshalled as follows: + + each string field is: [4-bytes BE] [variable length bytes specified by the + previous field]
+
+
MAX_CONCURRENT_STREAMS - software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
MAX_FRAME_SIZE - software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
MAX_HEADER_LIST_SIZE - software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
 
+
maxConcurrentStreams(long) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
+
The SETTINGS_MAX_CONCURRENT_STREAMS.
+
+
maxFrameSize(long) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
+
The SETTINGS_MAX_FRAME_SIZE.
+
+
maxHeaderListSize(long) - Method in class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
+
+
The SETTINGS_MAX_HEADER_LIST_SIZE.
+
+
MAXIMUM_CONNECT_TIME - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned by the server when the maximum connection time authorized for the connection was exceeded.
+
+
Message - Class in software.amazon.awssdk.crt.eventstream
+
+
Wrapper around an instance of aws-event-stream-message.
+
+
Message(List<Header>, byte[]) - Constructor for class software.amazon.awssdk.crt.eventstream.Message
+
+
Creates a message using headers and payload.
+
+
MESSAGE_RATE_TOO_HIGH - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint's incoming data rate was too high.
+
+
MessageFlags - Enum in software.amazon.awssdk.crt.eventstream
+
+
Java mirror of the native aws_event_stream_rpc_message_flag enum, specifying rpc message-related flags
+
+
MessageFlushCallback - Interface in software.amazon.awssdk.crt.eventstream
+
+
Functor interface for receiving message flush events.
+
+
MessageType - Enum in software.amazon.awssdk.crt.eventstream
+
+
Java mirror of the native aws_event_stream_rpc_message_type enum, specifying the type of rpc message
+
+
minor - Variable in class software.amazon.awssdk.crt.utils.PackageInfo.Version
+
 
+
minTlsVersion - Variable in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the minimum acceptable TLS version that the TlsContext will + allow.
+
+
Mqtt5Client - Class in software.amazon.awssdk.crt.mqtt5
+
+
This class wraps the aws-c-mqtt MQTT5 client to provide the basic MQTT5 pub/sub functionalities + via the AWS Common Runtime + + One Mqtt5Client class creates one connection.
+
+
Mqtt5Client(Mqtt5ClientOptions) - Constructor for class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Creates a Mqtt5Client instance using the provided Mqtt5ClientOptions.
+
+
Mqtt5ClientOperationStatistics - Class in software.amazon.awssdk.crt.mqtt5
+
+
Simple statistics about the current state of the client's queue of operations
+
+
Mqtt5ClientOperationStatistics() - Constructor for class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics
+
 
+
Mqtt5ClientOptions - Class in software.amazon.awssdk.crt.mqtt5
+
+
Configuration for the creation of Mqtt5Clients
+
+
Mqtt5ClientOptions(Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder) - Constructor for class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
+
+
Creates a Mqtt5ClientOptionsBuilder instance
+
+
Mqtt5ClientOptions.ClientOfflineQueueBehavior - Enum in software.amazon.awssdk.crt.mqtt5
+
+
Controls how disconnects affect the queued and in-progress operations tracked by the client.
+
+
Mqtt5ClientOptions.ClientSessionBehavior - Enum in software.amazon.awssdk.crt.mqtt5
+
+
Controls how the Mqtt5Client should behave with respect to MQTT sessions.
+
+
Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions - Enum in software.amazon.awssdk.crt.mqtt5
+
+
Additional controls for client behavior with respect to operation validation and flow control; these checks + go beyond the MQTT5 spec to respect limits of specific MQTT brokers.
+
+
Mqtt5ClientOptions.LifecycleEvents - Interface in software.amazon.awssdk.crt.mqtt5
+
+
An interface that defines all of the functions the Mqtt5Client will call when it receives a lifecycle event.
+
+
Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder - Class in software.amazon.awssdk.crt.mqtt5
+
+
All of the options for a Mqtt5Client.
+
+
Mqtt5ClientOptions.PublishEvents - Interface in software.amazon.awssdk.crt.mqtt5
+
+
An interface that defines all of the publish functions the Mqtt5Client will call when it receives a publish packet.
+
+
Mqtt5ClientOptionsBuilder(String, Long) - Constructor for class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Creates a new Mqtt5ClientOptionsBuilder instance
+
+
Mqtt5WebsocketHandshakeTransformArgs - Class in software.amazon.awssdk.crt.mqtt5
+
+
Arguments to a websocket handshake transform operation.
+
+
Mqtt5WebsocketHandshakeTransformArgs(Mqtt5Client, HttpRequest, CompletableFuture<HttpRequest>) - Constructor for class software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs
+
 
+
MqttClient - Class in software.amazon.awssdk.crt.mqtt
+
+
This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionalities + via the AWS Common Runtime + + One MqttClient class is needed per application.
+
+
MqttClient - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
MqttClient() - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClient
+
+
Creates an MqttClient with no TLS from the default static ClientBootstrap
+
+
MqttClient(ClientBootstrap) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClient
+
+
Creates an MqttClient with no TLS from the provided ClientBootstrap
+
+
MqttClient(ClientBootstrap, TlsContext) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClient
+
+
Creates an MqttClient from the provided ClientBootstrap and TlsContext
+
+
MqttClient(TlsContext) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClient
+
+
Creates an MqttClient with a default static ClientBootstrap and provided TlsContext
+
+
MqttClientConnection - Class in software.amazon.awssdk.crt.mqtt
+
+
This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionality + via the AWS Common Runtime + + MqttClientConnection represents a single connection from one MqttClient to an + MQTT service endpoint
+
+
MqttClientConnection(MqttConnectionConfig) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Constructs a new MqttClientConnection.
+
+
MqttClientConnection(Mqtt5Client, MqttClientConnectionEvents) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Constructs a new MqttClientConnection from a Mqtt5Client.
+
+
MqttClientConnectionEvents - Interface in software.amazon.awssdk.crt.mqtt
+
+
Interface used to receive connection events from the CRT
+
+
MqttClientConnectionOperationStatistics - Class in software.amazon.awssdk.crt.mqtt
+
+
Simple statistics about the current state of the connection's queue of operations
+
+
MqttClientConnectionOperationStatistics() - Constructor for class software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics
+
 
+
MqttConnectionConfig - Class in software.amazon.awssdk.crt.mqtt
+
+
Encapsulates all per-mqtt-connection configuration
+
+
MqttConnectionConfig() - Constructor for class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
 
+
MqttException - Exception in software.amazon.awssdk.crt.mqtt
+
+
This exception will be thrown by any exceptional cases encountered within the + JNI bindings to the AWS Common Runtime
+
+
MqttException(int) - Constructor for exception software.amazon.awssdk.crt.mqtt.MqttException
+
 
+
MqttException(String) - Constructor for exception software.amazon.awssdk.crt.mqtt.MqttException
+
 
+
MqttGeneral - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
MqttMessage - Class in software.amazon.awssdk.crt.mqtt
+
+
Represents a message to publish, or a message that was received.
+
+
MqttMessage(String, byte[]) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Deprecated. +
Use alternate constructor.
+
+
+
MqttMessage(String, byte[], QualityOfService) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Constructs a new message.
+
+
MqttMessage(String, byte[], QualityOfService, boolean) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Constructs a new message.
+
+
MqttMessage(String, byte[], QualityOfService, boolean, boolean) - Constructor for class software.amazon.awssdk.crt.mqtt.MqttMessage
+
+
Constructs a new message.
+
+
MqttTopicTree - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
+ + + +

N

+
+
nativeHandle - Variable in class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
nativeMemory() - Static method in class software.amazon.awssdk.crt.CRT
+
 
+
NegotiatedSettings - Class in software.amazon.awssdk.crt.mqtt5
+
+
MQTT behavior settings that are dynamically negotiated as part of the CONNECT/CONNACK exchange.
+
+
NegotiatedSettings() - Constructor for class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
+
 
+
newDeriveFromCredentials(Credentials, EccKeyPair.AwsEccCurve) - Static method in class software.amazon.awssdk.crt.cal.EccKeyPair
+
+
Derives the associated ECC key from a pair of AWS credentials according to the sigv4a ecc key + derivation specification.
+
+
newStream(ClientConnectionContinuationHandler) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
+
Create a new stream.
+
+
NO_MATCHING_SUBSCRIBERS - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the (QoS 1) publish was accepted but there were no matching subscribers.
+
+
NO_SUBSCRIPTION_EXISTED - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the topic filter did not match one of the client's existing topic filters on the server.
+
+
None - software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType
+
+
No authentication
+
+
None - software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode
+
+
Do not apply any jitter or randomization to the backoff interval
+
+
None - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
NONE - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType
+
+
Do not add any signing information about the body to the signed request
+
+
NONE - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
+
+
Do not do any additional validation or flow control
+
+
NONE - software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType
+
+
No PublishResult result data (QoS 0) + This means the PublishResult has no data and getValue will return null.
+
+
NONE - software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
NONE - software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation
+
 
+
NORMAL_DISCONNECTION - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint wishes to disconnect normally.
+
+
NOT_AUTHORIZED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the client is not authorized to connect to the server.
+
+
NOT_AUTHORIZED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint received a packet that represented an operation that was not authorized within + the current connection.
+
+
NOT_AUTHORIZED - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the (QoS 1) publish was not authorized by the receiver.
+
+
NOT_AUTHORIZED - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the client was not authorized to make the subscription on the server.
+
+
NOT_AUTHORIZED - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the client was not authorized to unsubscribe from that topic filter on the server.
+
+
+ + + +

O

+
+
OMIT - software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior
+
+
Skip calling C_Initialize() and C_Finalize().
+
+
onAttemptingConnect(Mqtt5Client, OnAttemptingConnectReturn) - Method in interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents
+
+
Called when the client begins a connection attempt
+
+
OnAttemptingConnectReturn - Class in software.amazon.awssdk.crt.mqtt5
+
+
The data returned when AttemptingConnect is invoked in the LifecycleEvents callback.
+
+
onCallbackInvoked(int) - Method in interface software.amazon.awssdk.crt.eventstream.MessageFlushCallback
+
+
Invoked when a message has been flushed to the underlying transport mechanism.
+
+
onChunkCompleted(int) - Method in interface software.amazon.awssdk.crt.http.HttpStream.HttpStreamWriteChunkCompletionCallback
+
 
+
onConnectionClosed(OnConnectionClosedReturn) - Method in interface software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents
+
+
Called when the connection was disconnected and shutdown successfully.
+
+
OnConnectionClosedReturn - Class in software.amazon.awssdk.crt.mqtt
+
+
The data returned when the connection closed callback is invoked in a connection.
+
+
OnConnectionClosedReturn() - Constructor for class software.amazon.awssdk.crt.mqtt.OnConnectionClosedReturn
+
 
+
onConnectionFailure(OnConnectionFailureReturn) - Method in interface software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents
+
+
Called on every unsuccessful connect and every unsuccessful disconnect.
+
+
onConnectionFailure(Mqtt5Client, OnConnectionFailureReturn) - Method in interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents
+
+
Called when the client fails to establish an MQTT connection
+
+
OnConnectionFailureReturn - Class in software.amazon.awssdk.crt.mqtt
+
+
The data returned when the connection failure callback is invoked in a connection.
+
+
OnConnectionFailureReturn - Class in software.amazon.awssdk.crt.mqtt5
+
+
The data returned when OnConnectionFailure is invoked in the LifecycleEvents callback.
+
+
onConnectionInterrupted(int) - Method in interface software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents
+
+
Called when the connection was lost (or disconnected), reconnect will be attempted automatically until + disconnect() is called
+
+
onConnectionResumed(boolean) - Method in interface software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents
+
+
Called whenever a reconnect succeeds; not called on an initial connect success
+
+
onConnectionSuccess(OnConnectionSuccessReturn) - Method in interface software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents
+
+
Called on every successful connect and every successful reconnect.
+
+
onConnectionSuccess(Mqtt5Client, OnConnectionSuccessReturn) - Method in interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents
+
+
Called when the client successfully establishes an MQTT connection
+
+
OnConnectionSuccessReturn - Class in software.amazon.awssdk.crt.mqtt
+
+
The data returned when the connection success callback is invoked in a connection.
+
+
OnConnectionSuccessReturn - Class in software.amazon.awssdk.crt.mqtt5
+
+
The data returned when OnConnectionSuccess is invoked in the LifecycleEvents callback.
+
+
onDirectoryEntry(DirectoryEntry) - Method in interface software.amazon.awssdk.crt.io.DirectoryTraversalHandler
+
+
Invoked during calls to DirectoryTraversal.traverse() as each entry is encountered.
+
+
onDisconnection(Mqtt5Client, OnDisconnectionReturn) - Method in interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents
+
+
Called when the client's current MQTT connection is closed
+
+
OnDisconnectionReturn - Class in software.amazon.awssdk.crt.mqtt5
+
+
The data returned when OnDisconnect is invoked in the LifecycleEvents callback.
+
+
onFailure(Throwable) - Method in interface software.amazon.awssdk.crt.AsyncCallback
+
 
+
onFinished(S3FinishedResponseContext) - Method in interface software.amazon.awssdk.crt.s3.S3MetaRequestResponseHandler
+
+
Invoked when the entire meta request execution is complete.
+
+
onMessage(Consumer<MqttMessage>) - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Sets a handler to be invoked whenever a message arrives, subscription or not
+
+
onMessageReceived(Mqtt5Client, PublishReturn) - Method in interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.PublishEvents
+
+
Called when an MQTT PUBLISH packet is received by the client
+
+
onMetrics(HttpStreamBase, HttpStreamMetrics) - Method in interface software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler
+
+
Called right before stream is complete, whether successful or unsuccessful.
+
+
onMetrics(HttpStream, HttpStreamMetrics) - Method in interface software.amazon.awssdk.crt.http.HttpStreamResponseHandler
+
+
Called right before stream is complete, whether successful or unsuccessful.
+
+
onProgress(S3MetaRequestProgress) - Method in interface software.amazon.awssdk.crt.s3.S3MetaRequestResponseHandler
+
+
Invoked to report progress of the meta request execution.
+
+
onResponseBody(ByteBuffer, long, long) - Method in interface software.amazon.awssdk.crt.s3.S3MetaRequestResponseHandler
+
+
Invoked to provide the response body as it is received.
+
+
onResponseBody(HttpStreamBase, byte[]) - Method in interface software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler
+
+
Called when new Response Body bytes have been received.
+
+
onResponseBody(HttpStream, byte[]) - Method in interface software.amazon.awssdk.crt.http.HttpStreamResponseHandler
+
+
Called when new Response Body bytes have been received.
+
+
onResponseComplete(HttpStreamBase, int) - Method in interface software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler
+
+
Called from Native when the Response has completed.
+
+
onResponseComplete(HttpStream, int) - Method in interface software.amazon.awssdk.crt.http.HttpStreamResponseHandler
+
+
Called from Native when the Response has completed.
+
+
onResponseHeaders(int, HttpHeader[]) - Method in interface software.amazon.awssdk.crt.s3.S3MetaRequestResponseHandler
+
+
Invoked to provide response headers received during the execution of the meta request.
+
+
onResponseHeaders(HttpStreamBase, int, int, HttpHeader[]) - Method in interface software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler
+
+
Called from Native when new Http Headers have been received.
+
+
onResponseHeaders(HttpStream, int, int, HttpHeader[]) - Method in interface software.amazon.awssdk.crt.http.HttpStreamResponseHandler
+
+
Called from Native when new Http Headers have been received.
+
+
onResponseHeadersDone(HttpStreamBase, int) - Method in interface software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler
+
+
Called from Native once all HTTP Headers are processed.
+
+
onResponseHeadersDone(HttpStream, int) - Method in interface software.amazon.awssdk.crt.http.HttpStreamResponseHandler
+
+
Called from Native once all HTTP Headers are processed.
+
+
onStopped(Mqtt5Client, OnStoppedReturn) - Method in interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents
+
+
Called when the client reaches the 'Stopped' state as a result of the user invoking .stop()
+
+
OnStoppedReturn - Class in software.amazon.awssdk.crt.mqtt5
+
+
The data returned when OnStopped is invoked in the LifecycleEvents callback.
+
+
onSuccess() - Method in interface software.amazon.awssdk.crt.AsyncCallback
+
 
+
onSuccess(Object) - Method in interface software.amazon.awssdk.crt.AsyncCallback
+
 
+
OperationRoutingServerConnectionHandler - Class in software.amazon.awssdk.crt.eventstream
+
+
ServerConnectionHandler implementation that routes continuations to specific + operation specific message handlers
+
+
OperationRoutingServerConnectionHandler(ServerConnection, Map<String, Function<ServerConnectionContinuation, ServerConnectionContinuationHandler>>) - Constructor for class software.amazon.awssdk.crt.eventstream.OperationRoutingServerConnectionHandler
+
+
binds an operation handler mapping to a server connection
+
+
overrideDefaultTrustStore(String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper function to provide a TlsContext-local trust store
+
+
overrideDefaultTrustStoreFromPath(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Helper function to provide a TlsContext-local trust store
+
+
+ + + +

P

+
+
PackageInfo - Class in software.amazon.awssdk.crt.utils
+
+
Class that wraps version and package introspection
+
+
PackageInfo() - Constructor for class software.amazon.awssdk.crt.utils.PackageInfo
+
+
Default constructor
+
+
PackageInfo.Version - Class in software.amazon.awssdk.crt.utils
+
+
Class representing the introspected semantic version of the CRT library
+
+
PACKET_IDENTIFIER_IN_USE - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the packet identifier used in the associated PUBLISH was already in use.
+
+
PACKET_IDENTIFIER_IN_USE - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the packet identifier was already in use on the server.
+
+
PACKET_IDENTIFIER_IN_USE - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the packet identifier was already in use on the server.
+
+
PACKET_TOO_LARGE - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the ConnectPacket exceeded the maximum permissible size on the server.
+
+
PACKET_TOO_LARGE - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint received a packet whose size was greater than the maximum packet size limit + it established for itself when the connection was opened.
+
+
patch - Variable in class software.amazon.awssdk.crt.utils.PackageInfo.Version
+
 
+
pause() - Method in class software.amazon.awssdk.crt.s3.S3MetaRequest
+
+
Pauses meta request and returns a token that can be used to resume a meta request.
+
+
PAYLOAD_FORMAT_INVALID - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the Will payload in the ConnectPacket does not match the specified payload format indicator.
+
+
PAYLOAD_FORMAT_INVALID - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint received a packet where payload format did not match the format specified + by the payload format indicator.
+
+
PAYLOAD_FORMAT_INVALID - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the PUBLISH packet's payload format did not match its payload format indicator property.
+
+
PemUtils - Class in software.amazon.awssdk.crt.utils
+
+
Utility Class used for Cleaning Up and Sanity Checking PEM formatted Strings + for Validity.
+
+
performOperation(TlsKeyOperation) - Method in interface software.amazon.awssdk.crt.io.TlsKeyOperationHandler
+
+
Invoked each time a private key operation needs to be performed.
+
+
Ping - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
PingResponse - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
Pkcs11Lib - Class in software.amazon.awssdk.crt.io
+
+
Handle to a loaded PKCS#11 library.
+
+
Pkcs11Lib(String) - Constructor for class software.amazon.awssdk.crt.io.Pkcs11Lib
+
+
Load and initialize a PKCS#11 library.
+
+
Pkcs11Lib(String, Pkcs11Lib.InitializeFinalizeBehavior) - Constructor for class software.amazon.awssdk.crt.io.Pkcs11Lib
+
+
Load a PKCS#11 library, specifying how C_Initialize() and + C_Finalize() will be called.
+
+
Pkcs11Lib.InitializeFinalizeBehavior - Enum in software.amazon.awssdk.crt.io
+
+
Controls how Pkcs11Lib calls C_Initialize() and C_Finalize() + on the PKCS#11 library.
+
+
Process - Class in software.amazon.awssdk.crt
+
+
Encapsulates Process information and manipulation of process level operations.
+
+
Process() - Constructor for class software.amazon.awssdk.crt.Process
+
 
+
ProfileCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps a provider that gets credentials from profile files.
+
+
ProfileCredentialsProvider.Builder - Interface in software.amazon.awssdk.crt.auth.credentials
+
+
A builder for creating a custom profile credentials provider.
+
+
PROTOCOL_ERROR - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
PROTOCOL_ERROR - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when data in the ConnectPacket does not conform to the MQTT5 specification requirements.
+
+
PROTOCOL_ERROR - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when an unexpected or out-of-order packet was received by the remote endpoint.
+
+
ProtocolError - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
PUBACK - software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType
+
+
PublishResult result was a publish acknowledgment (PubAck - QoS 1) + This means the PublishResult has a PubAck and getValue will return + the PubAckPacket associated with the publish.
+
+
PubAckPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 PUBACK packet
+
+
PubAckPacket.PubAckReasonCode - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Reason code inside PubAckPackets that indicates the result of the associated PUBLISH request.
+
+
publish(MqttMessage) - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Publishes a message to a topic.
+
+
publish(MqttMessage, QualityOfService, boolean) - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Deprecated.
+
+
publish(PublishPacket) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Tells the Mqtt5Client to attempt to send a PUBLISH packet.
+
+
PublishPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 PUBLISH packet
+
+
PublishPacket.PayloadFormatIndicator - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Optional property describing a PublishPacket payload's format.
+
+
PublishPacket.PublishPacketBuilder - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
A class to that allows for the creation of a PublishPacket.
+
+
PublishPacketBuilder() - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Creates a new PublishPacketBuilder so a PublishPacket can be created.
+
+
PublishPacketBuilder(String, QOS, byte[]) - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Creates a new PublishPacketBuilder with common parameters set.
+
+
PublishResult - Class in software.amazon.awssdk.crt.mqtt5
+
+
The type of data returned after calling Publish on an Mqtt5Client.
+
+
PublishResult.PublishResultType - Enum in software.amazon.awssdk.crt.mqtt5
+
+
The type of data returned after calling Publish on an MQTT5 client.
+
+
PublishReturn - Class in software.amazon.awssdk.crt.mqtt5
+
+
The data returned when a publish is made to a topic the MQTT5 client is subscribed to.
+
+
PUT_OBJECT - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
+
The PutObject request will be split into MultiPart uploads that are executed in parallel + to improve throughput, when possible.
+
+
PutResumeTokenBuilder() - Constructor for class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
+
+
Default constructor
+
+
+ + + +

Q

+
+
QOS - Enum in software.amazon.awssdk.crt.mqtt5
+
+
MQTT message delivery quality of service.
+
+
QOS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server does not support the QOS setting set in the Will QOS in the ConnectPacket.
+
+
QOS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the client sends a QoS that is greater than the maximum QOS established when the connection was + opened.
+
+
QualityOfService - Enum in software.amazon.awssdk.crt.mqtt
+
+
Quality of Service associated with a publish action or subscription [MQTT-4.3].
+
+
QUOTA_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the quota limits set on the server have been met and/or exceeded.
+
+
QUOTA_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when an internal quota of the remote endpoint was exceeded.
+
+
QUOTA_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the associated PUBLISH failed because an internal quota on the recipient was exceeded.
+
+
QUOTA_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when a subscribe-related quota set on the server was exceeded.
+
+
+ + + +

R

+
+
RECEIVE_MAXIMUM_EXCEEDED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint reached a state where there were more in-progress QoS1+ publishes then the + limit it established for itself when the connection was opened.
+
+
REFUSED_STREAM - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
REJOIN_ALWAYS - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Always attempt to rejoin an existing session.
+
+
REJOIN_POST_SUCCESS - software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Always attempt to rejoin an existing session after an initial connection success.
+
+
releaseConnection(HttpClientConnection) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManager
+
+
Releases this HttpClientConnection back into the Connection Pool, and allows another Request to acquire this connection.
+
+
releaseShutdownRef() - Static method in class software.amazon.awssdk.crt.CRT
+
+
Public API to release a shutdown reference that blocks CRT shutdown from proceeding.
+
+
removeInvalidPemChars(String) - Static method in class software.amazon.awssdk.crt.utils.PemUtils
+
+
Removes characters that are not valid in PEM format (non-base64 chars).
+
+
removeReferenceTo(CrtResource) - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Removes a reference from this resource to another.
+
+
reset() - Method in class software.amazon.awssdk.crt.checksums.CRC32
+
+
Resets the checksum to its initial value.
+
+
reset() - Method in class software.amazon.awssdk.crt.checksums.CRC32C
+
+
Resets the checksum to its initial value.
+
+
reset() - Method in class software.amazon.awssdk.crt.checksums.CRC64NVME
+
+
Resets the checksum to its initial value.
+
+
resetPosition() - Method in interface software.amazon.awssdk.crt.http.HttpRequestBodyStream
+
+
Called from native when the processing needs the stream to rewind itself back to its beginning.
+
+
resetStream(Http2ClientConnection.Http2ErrorCode) - Method in class software.amazon.awssdk.crt.http.Http2Stream
+
+
Reset the HTTP/2 stream.
+
+
ResourceInstance(CrtResource, String) - Constructor for class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
ResumeToken - Class in software.amazon.awssdk.crt.s3
+
 
+
ResumeToken(ResumeToken.PutResumeTokenBuilder) - Constructor for class software.amazon.awssdk.crt.s3.ResumeToken
+
 
+
ResumeToken.PutResumeTokenBuilder - Class in software.amazon.awssdk.crt.s3
+
 
+
RETAIN_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server does not retain messages but the ConnectPacket on the client had Will retain enabled.
+
+
RETAIN_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the server does not support retained messages.
+
+
RSA - software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
 
+
+ + + +

S

+
+
S3Client - Class in software.amazon.awssdk.crt.s3
+
 
+
S3Client - software.amazon.awssdk.crt.Log.LogSubject
+
 
+
S3Client(S3ClientOptions) - Constructor for class software.amazon.awssdk.crt.s3.S3Client
+
 
+
S3ClientOptions - Class in software.amazon.awssdk.crt.s3
+
 
+
S3ClientOptions() - Constructor for class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
S3ExpressCredentialsProperties - Class in software.amazon.awssdk.crt.s3
+
 
+
S3ExpressCredentialsProperties() - Constructor for class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties
+
 
+
S3ExpressCredentialsProvider - Class in software.amazon.awssdk.crt.s3
+
+
The Java object for Native code to invoke.
+
+
S3ExpressCredentialsProvider(S3ExpressCredentialsProviderHandler) - Constructor for class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProvider
+
 
+
S3ExpressCredentialsProviderFactory - Interface in software.amazon.awssdk.crt.s3
+
 
+
S3ExpressCredentialsProviderHandler - Interface in software.amazon.awssdk.crt.s3
+
+
Interface to override the S3Express Credentials provider.
+
+
S3FinishedResponseContext - Class in software.amazon.awssdk.crt.s3
+
 
+
S3MetaRequest - Class in software.amazon.awssdk.crt.s3
+
 
+
S3MetaRequest() - Constructor for class software.amazon.awssdk.crt.s3.S3MetaRequest
+
 
+
S3MetaRequestOptions - Class in software.amazon.awssdk.crt.s3
+
 
+
S3MetaRequestOptions() - Constructor for class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
S3MetaRequestOptions.MetaRequestType - Enum in software.amazon.awssdk.crt.s3
+
+
A Meta Request represents a group of generated requests that are being done on behalf of the + original request.
+
+
S3MetaRequestOptions.ResponseFileOption - Enum in software.amazon.awssdk.crt.s3
+
 
+
S3MetaRequestProgress - Class in software.amazon.awssdk.crt.s3
+
+
Information about the meta request progress.
+
+
S3MetaRequestProgress() - Constructor for class software.amazon.awssdk.crt.s3.S3MetaRequestProgress
+
 
+
S3MetaRequestResponseHandler - Interface in software.amazon.awssdk.crt.s3
+
+
Interface called by native code to provide S3MetaRequest responses.
+
+
S3TcpKeepAliveOptions - Class in software.amazon.awssdk.crt.s3
+
+
This class provides access to setting Tcp Keep Alive Options.
+
+
S3TcpKeepAliveOptions() - Constructor for class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
safeSanityCheck(String, int, String) - Static method in class software.amazon.awssdk.crt.utils.PemUtils
+
+
Returns false if there is a problem with a PEM instead of throwing an + Exception.
+
+
sanityCheck(String, int, String) - Static method in class software.amazon.awssdk.crt.utils.PemUtils
+
+
Performs various sanity checks on a PEM Formatted String, and should be + tolerant of common minor mistakes in formatting.
+
+
SEND_ON_SUBSCRIBE - software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
+
The server should always send all retained messages on topics that match a subscription's filter.
+
+
SEND_ON_SUBSCRIBE_IF_NEW - software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
+
The server should send retained messages on topics that match the subscription's filter, but only for the + first matching subscription, per session.
+
+
sendGoAway(Http2ClientConnection.Http2ErrorCode, boolean) - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
 
+
sendGoAway(Http2ClientConnection.Http2ErrorCode, boolean, byte[]) - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
+
Send a custom GOAWAY frame.
+
+
sendMessage(List<Header>, byte[], MessageType, int) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation
+
+
Sends message on the continuation
+
+
sendMessage(List<Header>, byte[], MessageType, int) - Method in class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuation
+
+
Sends message on the continuation
+
+
sendMessage(List<Header>, byte[], MessageType, int, MessageFlushCallback) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation
+
+
Sends message on the continuation
+
+
sendMessage(List<Header>, byte[], MessageType, int, MessageFlushCallback) - Method in class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuation
+
+
Sends message on the continuation
+
+
sendPing() - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
 
+
sendPing(byte[]) - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
+
Send a PING frame.
+
+
sendProtocolMessage(List<Header>, byte[], MessageType, int) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
+
Sends a protocol message on the connection.
+
+
sendProtocolMessage(List<Header>, byte[], MessageType, int) - Method in class software.amazon.awssdk.crt.eventstream.ServerConnection
+
+
Sends a protocol message on the connection.
+
+
sendProtocolMessage(List<Header>, byte[], MessageType, int, MessageFlushCallback) - Method in class software.amazon.awssdk.crt.eventstream.ClientConnection
+
+
Sends a protocol message on the connection.
+
+
sendProtocolMessage(List<Header>, byte[], MessageType, int, MessageFlushCallback) - Method in class software.amazon.awssdk.crt.eventstream.ServerConnection
+
+
Sends a protocol message on the connection.
+
+
sendRequestBody(ByteBuffer) - Method in interface software.amazon.awssdk.crt.http.HttpRequestBodyStream
+
+
Called from Native when the Http Request has a Body (Eg PUT/POST requests).
+
+
SERVER_BUSY - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server is too busy to make a connection.
+
+
SERVER_BUSY - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the server is busy and cannot continue processing packets from the client.
+
+
SERVER_MOVED - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server is telling the client to permanently use another server instead of the one they + are trying to connect to.
+
+
SERVER_MOVED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned by the server to tell the client to permanently use a different server.
+
+
SERVER_SHUTTING_DOWN - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the server is shutting down.
+
+
SERVER_UNAVAILABLE - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the MQTT5 server is not available.
+
+
ServerBootstrap - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_server_bootstrap from aws-c-io to provide + a server context for all protocol stacks in the AWS Common Runtime.
+
+
ServerBootstrap(EventLoopGroup) - Constructor for class software.amazon.awssdk.crt.io.ServerBootstrap
+
 
+
ServerConnection - Class in software.amazon.awssdk.crt.eventstream
+
+
Wrapper around event-stream-rpc-server-connection.
+
+
ServerConnectionContinuation - Class in software.amazon.awssdk.crt.eventstream
+
+
Wrapper around aws-event-stream-rpc-server continuation.
+
+
ServerConnectionContinuationHandler - Class in software.amazon.awssdk.crt.eventstream
+
+
Handler interface for responding to continuation events.
+
+
ServerConnectionHandler - Class in software.amazon.awssdk.crt.eventstream
+
+
Handler for EventStream ServerConnections.
+
+
ServerError - software.amazon.awssdk.crt.eventstream.MessageType
+
 
+
ServerListener - Class in software.amazon.awssdk.crt.eventstream
+
+
Event-stream-rpc server listener.
+
+
ServerListener(String, int, SocketOptions, ServerTlsContext, ServerBootstrap, ServerListenerHandler) - Constructor for class software.amazon.awssdk.crt.eventstream.ServerListener
+
+
Instantiates a server listener.
+
+
ServerListenerHandler - Class in software.amazon.awssdk.crt.eventstream
+
+
Handler interface for processing incoming event-stream-rpc connections and their lifetimes.
+
+
ServerListenerHandler() - Constructor for class software.amazon.awssdk.crt.eventstream.ServerListenerHandler
+
 
+
ServerTlsContext - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_tls_context from aws-c-io to provide access to TLS + configuration contexts in the AWS Common Runtime.
+
+
ServerTlsContext(TlsContextOptions) - Constructor for class software.amazon.awssdk.crt.io.ServerTlsContext
+
+
Creates a new Server TlsContext.
+
+
SESSION_TAKEN_OVER - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the server has established another connection with the same client ID as a client's current + connection, causing the current client to become disconnected.
+
+
setAlgorithm(AwsSigningConfig.AwsSigningAlgorithm) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets what version of the AWS signing process should be used
+
+
setAllowableThroughputFailureIntervalSeconds(int) - Method in class software.amazon.awssdk.crt.http.HttpMonitoringOptions
+
+
Sets how long, in seconds, a connection is allowed to be unhealthy before getting shut down.
+
+
setAuthorizationPassword(String) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the password to use for authorization; only applicable to basic authentication
+
+
setAuthorizationType(HttpProxyOptions.HttpProxyAuthorizationType) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the proxy authorization type
+
+
setAuthorizationUsername(String) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the username to use for authorization; only applicable to basic authentication
+
+
setCipherPreference(TlsCipherPreference) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the TLS cipher preferences to use in contexts using this configuration
+
+
setCleanSession(boolean) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures whether or not the service should try to resume prior subscriptions, if it has any
+
+
setClientId(String) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the client_id to use with a connection
+
+
setConnectionCallbacks(MqttClientConnectionEvents) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the connection-related callbacks for a connection
+
+
setConnectionType(HttpProxyOptions.HttpProxyConnectionType) - Method in class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
+
(Optional) + Sets the proxy connection type.
+
+
setConnectionType(HttpProxyOptions.HttpProxyConnectionType) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the proxy connection type
+
+
setCredentials(Credentials) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets the credentials to use for signing.
+
+
setCredentialsProvider(CredentialsProvider) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets the provider to use to source credentials from before signing.
+
+
setDescription(String) - Method in class software.amazon.awssdk.crt.CrtResource
+
+
Sets a custom logging description for this resource
+
+
setEncodedPath(String) - Method in class software.amazon.awssdk.crt.http.HttpRequest
+
+
Sets the request's encoded path
+
+
setEndpoint(String) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the IoT endpoint for a connection
+
+
setEnvironmentVariableType(HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType) - Method in class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
+
(Optional) + Enable/Disable reading from environment variable for Proxy config.
+
+
setExpirationInSeconds(long) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets the expiration time in seconds when using query param signing (pre-signed url).
+
+
setHost(String) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the proxy host to connect through
+
+
setHttpProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures proxy options for the mqtt connection
+
+
setKeepAliveIntervalSec(short) - Method in class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
setKeepAliveMaxFailedProbes(short) - Method in class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
setKeepAliveMs(int) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
Configures MQTT keep-alive via PING messages. Note that this is not TCP + keepalive. Please use setKeepAliveSecs instead.
+
+
+
setKeepAliveSecs(int) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures MQTT keep-alive via PING messages.
+
+
setKeepAliveTimeoutSec(short) - Method in class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
+
 
+
setLogin(String, String) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Sets the login credentials for a connection.
+
+
setMaxIOHandlesSoftLimit(long) - Static method in class software.amazon.awssdk.crt.Process
+
+
Sets the soft limit for IO handles for this process (max fds in unix terminology).
+
+
setMinThroughputBytesPerSecond(long) - Method in class software.amazon.awssdk.crt.http.HttpMonitoringOptions
+
+
Sets a throughput threshold for connections.
+
+
setMqtt5Client(Mqtt5Client) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the mqtt5 client to use for a connection
+
+
setMqttClient(MqttClient) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the mqtt client to use for a connection
+
+
setNativeHandle(long) - Method in class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
setOmitSessionToken(boolean) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets whether or not X-Amz-Session-Token should be added to the canonical request when signing with session + credentials.
+
+
setPassword(String) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the password to use as part of the CONNECT attempt
+
+
setPingTimeoutMs(int) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures ping timeout value.
+
+
setPort(int) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the proxy port to connect through.
+
+
setPort(int) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the port to connect to.
+
+
setProtocolOperationTimeoutMs(int) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures timeout value for requests that response is required on healthy connection.
+
+
setReconnectTimeoutSecs(long, long) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the minimum and maximum reconnect timeouts.
+
+
setRegion(String) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets what to use for region when signing.
+
+
setService(String) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets what service signing name to use.
+
+
setShouldNormalizeUriPath(boolean) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets whether or not the uri path should be normalized during canonical request construction
+
+
setShouldSignHeader(Predicate<String>) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets a header-name signing predicate filter.
+
+
setSignatureType(AwsSigningConfig.AwsSignatureType) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets what sort of signature should be computed
+
+
setSignedBodyHeader(AwsSigningConfig.AwsSignedBodyHeaderType) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets what signed body header should hold the payload hash (or override value).
+
+
setSignedBodyValue(String) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets the payload hash override value to use in canonical request construction.
+
+
setSocketOptions(SocketOptions) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the common settings to use for a connection's socket
+
+
setStaticDefaultMaxEntries(int) - Static method in class software.amazon.awssdk.crt.io.HostResolver
+
+
Sets the max number of cached host entries for the static default resolver, if it's ever created/used.
+
+
setStaticDefaultNumThreads(int) - Static method in class software.amazon.awssdk.crt.io.EventLoopGroup
+
+
Sets the number of threads for the static default event loop group, should it ever be created.
+
+
setTcpKeepAlive(int, int) - Method in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Enables TCP keepalive.
+
+
setTcpKeepAlive(int, int, int) - Method in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Enables TCP keepalive.
+
+
setTime(long) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets the point in time that signing should be relative to.
+
+
SETTINGS_TIMEOUT - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
setTlsConnectionOptions(TlsConnectionOptions) - Method in class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
+
+
(Optional) + Sets the tls connection options for the proxy connection
+
+
setTlsContext(TlsContext) - Method in class software.amazon.awssdk.crt.http.HttpProxyOptions
+
+
Sets the tls context for the proxy connection
+
+
setupOnce() - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
setUseDoubleUriEncode(boolean) - Method in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig
+
+
Sets whether or not signing should uri encode urls as part of canonical request construction.
+
+
setUsername(String) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the username to use as part of the CONNECT attempt
+
+
setUseWebsockets(boolean) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures whether or not to use websockets for the mqtt connection
+
+
setWebsocketHandshakeTransform(Consumer<WebsocketHandshakeTransformArgs>) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Set a transform operation to use on each websocket handshake http request.
+
+
setWebsocketProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
use setHttpProxyOptions instead + Configures proxy options for a websocket-based mqtt connection
+
+
+
setWillMessage(MqttMessage) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Configures the last will and testament message to be delivered to a topic when a connection disconnects
+
+
setWillQos(QualityOfService) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
Set QoS directly on the will's MqttMessage.
+
+
+
setWillRetain(boolean) - Method in class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig
+
+
Deprecated. +
Set retain directly on the will's MqttMessage.
+
+
+
SHA1 - software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
SHA1 - software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
SHA224 - software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
SHA256 - software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
SHA256 - software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
 
+
SHA384 - software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
SHA512 - software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
SHARED_SUBSCRIPTIONS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned by the server to tell the client that shared subscriptions are not supported on the server.
+
+
SHARED_SUBSCRIPTIONS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription's topic filter was a shared subscription and the server does not support + shared subscriptions.
+
+
shouldCloseConnectionOnServerError() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
 
+
shutdown() - Method in class software.amazon.awssdk.crt.http.HttpClientConnection
+
+
Shuts down the underlying http connection.
+
+
sign(List<HttpHeader>, byte[], AwsSigningConfig) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigner
+
+
Signs a body chunk according to the supplied signing configuration
+
+
sign(HttpRequestBodyStream, byte[], AwsSigningConfig) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigner
+
+
Signs a body chunk according to the supplied signing configuration
+
+
sign(HttpRequest, AwsSigningConfig) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigner
+
+
Signs an http request according to the supplied signing configuration
+
+
SIGN - software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
 
+
signChunk(HttpRequestBodyStream, byte[], AwsSigningConfig) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigner
+
+
Signs a body chunk according to the supplied signing configuration
+
+
signMessage(byte[]) - Method in class software.amazon.awssdk.crt.cal.EccKeyPair
+
+
Sign a message using the ECC key pair via ECDSA
+
+
signRequest(HttpRequest, AwsSigningConfig) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigner
+
+
Signs an http request according to the supplied signing configuration
+
+
SIGV4 - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
Standard AWS Sigv4 signing, based on AWS credentials and symmetric secrets
+
+
SIGV4_ASYMMETRIC - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
AWS Sigv4a signing, based on ECDSA signatures
+
+
SIGV4_S3EXPRESS - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
AWS Sigv4 S3 Express signing
+
+
SocketOptions - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_socket_options from aws-c-io to provide + access to TCP/UDP socket configuration in the AWS Common Runtime.
+
+
SocketOptions() - Constructor for class software.amazon.awssdk.crt.io.SocketOptions
+
+
Creates a new set of socket options
+
+
SocketOptions.SocketDomain - Enum in software.amazon.awssdk.crt.io
+
+
Socket communications domain
+
+
SocketOptions.SocketType - Enum in software.amazon.awssdk.crt.io
+
+
Socket type
+
+
software.amazon.awssdk.crt - package software.amazon.awssdk.crt
+
 
+
software.amazon.awssdk.crt.auth.credentials - package software.amazon.awssdk.crt.auth.credentials
+
 
+
software.amazon.awssdk.crt.auth.signing - package software.amazon.awssdk.crt.auth.signing
+
 
+
software.amazon.awssdk.crt.cal - package software.amazon.awssdk.crt.cal
+
 
+
software.amazon.awssdk.crt.checksums - package software.amazon.awssdk.crt.checksums
+
 
+
software.amazon.awssdk.crt.eventstream - package software.amazon.awssdk.crt.eventstream
+
 
+
software.amazon.awssdk.crt.http - package software.amazon.awssdk.crt.http
+
 
+
software.amazon.awssdk.crt.io - package software.amazon.awssdk.crt.io
+
 
+
software.amazon.awssdk.crt.mqtt - package software.amazon.awssdk.crt.mqtt
+
 
+
software.amazon.awssdk.crt.mqtt5 - package software.amazon.awssdk.crt.mqtt5
+
 
+
software.amazon.awssdk.crt.mqtt5.packets - package software.amazon.awssdk.crt.mqtt5.packets
+
 
+
software.amazon.awssdk.crt.s3 - package software.amazon.awssdk.crt.s3
+
 
+
software.amazon.awssdk.crt.utils - package software.amazon.awssdk.crt.utils
+
 
+
SSLv3 - software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
SSL v3.
+
+
StandardRetryOptions - Class in software.amazon.awssdk.crt.io
+
+
Top-level configuration for http retries.
+
+
StandardRetryOptions() - Constructor for class software.amazon.awssdk.crt.io.StandardRetryOptions
+
 
+
start() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Notifies the Mqtt5Client that you want it maintain connectivity to the configured endpoint.
+
+
StaticCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps the a credentials provider that returns a fixed set of credentials
+
+
StaticCredentialsProvider.StaticCredentialsProviderBuilder - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A simple builder class for a static credentials provider and its options
+
+
StaticCredentialsProviderBuilder() - Constructor for class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
+
+
Default constructor
+
+
stop() - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Notifies the Mqtt5Client that you want it to end connectivity to the configured endpoint, disconnecting any + existing connection and halting any reconnect attempts.
+
+
stop(DisconnectPacket) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Notifies the Mqtt5Client that you want it to end connectivity to the configured endpoint, disconnecting any + existing connection and halting any reconnect attempts.
+
+
STREAM - software.amazon.awssdk.crt.io.SocketOptions.SocketType
+
+
Corresponds to SOCK_STREAM in Berkeley sockets (TCP)
+
+
STREAM_CLOSED - software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
 
+
STREAMING_AWS4_ECDSA_P256_SHA256_PAYLOAD - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
STREAMING_AWS4_ECDSA_P256_SHA256_PAYLOAD_TRAILER - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
STREAMING_AWS4_HMAC_SHA256_EVENTS - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
STREAMING_AWS4_HMAC_SHA256_PAYLOAD - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
STREAMING_UNSIGNED_PAYLOAD_TRAILER - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
STRICT - software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior
+
+
C_Initialize() is called on creation and C_Finalize() is + called on cleanup.
+
+
String - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
StringUtils - Class in software.amazon.awssdk.crt.utils
+
 
+
StringUtils() - Constructor for class software.amazon.awssdk.crt.utils.StringUtils
+
 
+
StsCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps a provider that gets credentials from Security Token Service (STS).
+
+
StsCredentialsProvider.Builder - Interface in software.amazon.awssdk.crt.auth.credentials
+
+
A builder for creating a sts credentials provider.
+
+
StsWebIdentityCredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
Sts with web identity credentials provider sources a set of temporary security credentials for users who have been + authenticated in a mobile or web application with a web identity provider.
+
+
StsWebIdentityCredentialsProvider.Builder - Interface in software.amazon.awssdk.crt.auth.credentials
+
+
A builder for creating an STS web identity credentials provider.
+
+
SubAckPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 SUBACK packet.
+
+
SubAckPacket.SubAckReasonCode - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Reason code inside SubAckPacket payloads.
+
+
subscribe(String, QualityOfService) - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Subscribes to a topic without a handler (messages will only be delivered to + the OnMessage handler)
+
+
subscribe(String, QualityOfService, Consumer<MqttMessage>) - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Subscribes to a topic
+
+
subscribe(SubscribePacket) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Tells the Mqtt5Client to attempt to subscribe to one or more topic filters.
+
+
SubscribePacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 SUBSCRIBE packet.
+
+
SubscribePacket.RetainHandlingType - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Configures how retained messages should be handled when subscribing with a subscription that matches topics with + associated retained messages.
+
+
SubscribePacket.SubscribePacketBuilder - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
A class to that allows for the creation of a SubscribePacket.
+
+
SubscribePacket.Subscription - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Configures a single subscription within a Subscribe operation + + See MQTT5 Subscription Options
+
+
SubscribePacketBuilder() - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Creates a new SubscribePacketBuilder so a SubscribePacket can be created.
+
+
SubscribePacketBuilder(String, QOS) - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Creates a new SubscribePacketBuilder with one subscription defined.
+
+
SubscribePacketBuilder(SubscribePacket.Subscription) - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Creates a new SubscribePacketBuilder with one subscription defined.
+
+
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned by the server when it received a SubscribePacket with a subscription identifier, but the server does + not support subscription identifiers.
+
+
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the SubscribePacket contained a subscription identifier and the server does not support + subscription identifiers.
+
+
SUCCESS - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the connection is accepted.
+
+
SUCCESS - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the (QoS 1) publish was accepted by the recipient.
+
+
SUCCESS - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the unsubscribe was successful and the client is no longer subscribed to the topic filter on the server.
+
+
SystemInfo - Class in software.amazon.awssdk.crt
+
+
Utility class for querying system hardware properties
+
+
SystemInfo() - Constructor for class software.amazon.awssdk.crt.SystemInfo
+
 
+
SystemInfo.CpuInfo - Class in software.amazon.awssdk.crt
+
 
+
+ + + +

T

+
+
tag - Variable in class software.amazon.awssdk.crt.utils.PackageInfo.Version
+
 
+
TerminateStream - software.amazon.awssdk.crt.eventstream.MessageFlags
+
 
+
testSetup(Object) - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
testTearDown(Object) - Method in class software.amazon.awssdk.crt.CrtPlatform
+
 
+
TimeStamp - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
TLS_CIPHER_KMS_PQ_TLSv1_0_2019_06 - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Deprecated. +
This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
+
+
+
TLS_CIPHER_PREF_KMS_PQ_SIKE_TLSv1_0_2019_11 - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Deprecated. +
This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
+
+
+
TLS_CIPHER_PREF_KMS_PQ_SIKE_TLSv1_0_2020_02 - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Deprecated. +
This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
+
+
+
TLS_CIPHER_PREF_KMS_PQ_TLSv1_0_2020_02 - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Deprecated. +
This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
+
+
+
TLS_CIPHER_PREF_KMS_PQ_TLSv1_0_2020_07 - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Deprecated. +
This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
+
+
+
TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
This TlsCipherPreference supports TLS 1.0 through TLS 1.3, and contains Kyber Round 3 as its highest priority + PQ algorithm.
+
+
TLS_CIPHER_SYSTEM_DEFAULT - software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Use whatever the System Default Preference is.
+
+
TLS_VER_SYS_DEFAULTS - software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
Use whatever the system default is.
+
+
tlsCipherPreference - Variable in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the TLS Cipher Preferences that can be negotiated and used during the + TLS Connection.
+
+
TlsCipherPreference - Enum in software.amazon.awssdk.crt.io
+
+
A TlsCipherPreference represents a hardcoded ordered list of TLS Ciphers to use when negotiating a TLS Connection.
+
+
TlsConnectionOptions - Class in software.amazon.awssdk.crt.io
+
+
Connection-specific TLS options.
+
+
TlsConnectionOptions(TlsContext) - Constructor for class software.amazon.awssdk.crt.io.TlsConnectionOptions
+
+
Initialize the connection-specific TLS options with TLSContext.
+
+
TlsContext - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_tls_context from aws-c-io to provide + access to TLS configuration contexts in the AWS Common Runtime.
+
+
TlsContext() - Constructor for class software.amazon.awssdk.crt.io.TlsContext
+
+
Creates a new Client TlsContext.
+
+
TlsContext(TlsContextOptions) - Constructor for class software.amazon.awssdk.crt.io.TlsContext
+
+
Creates a new Client TlsContext.
+
+
TlsContextCustomKeyOperationOptions - Class in software.amazon.awssdk.crt.io
+
+
Top level configuration for the custom TLS key operations.
+
+
TlsContextCustomKeyOperationOptions(TlsKeyOperationHandler) - Constructor for class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
+
+
Creates a new TlsContextCustomKeyOperationOptions and sets the TlsKeyOperationHandler that + will be invoked when there is a TLS key operation that needs to be performed.
+
+
TlsContextOptions - Class in software.amazon.awssdk.crt.io
+
+
This class wraps the aws_tls_connection_options from aws-c-io to provide + access to TLS configuration contexts in the AWS Common Runtime.
+
+
TlsContextOptions.TlsVersions - Enum in software.amazon.awssdk.crt.io
+
 
+
TlsContextPkcs11Options - Class in software.amazon.awssdk.crt.io
+
+
Options for TLS using a PKCS#11 library for private key operations.
+
+
TlsContextPkcs11Options(Pkcs11Lib) - Constructor for class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Constructor
+
+
TlsHashAlgorithm - Enum in software.amazon.awssdk.crt.io
+
+
The hash algorithm of a TLS private key operation.
+
+
TlsKeyOperation - Class in software.amazon.awssdk.crt.io
+
+
A class containing a mutual TLS (mTLS) Private Key operation that needs to be performed.
+
+
TlsKeyOperation.Type - Enum in software.amazon.awssdk.crt.io
+
+
The type of TlsKeyOperation that needs to be performed by the TlsKeyOperationHandler interface.
+
+
TlsKeyOperationHandler - Interface in software.amazon.awssdk.crt.io
+
+
Interface for handling private key operations during the TLS handshake.
+
+
TlsSignatureAlgorithm - Enum in software.amazon.awssdk.crt.io
+
+
The signature of a TLS private key operation.
+
+
TLSv1 - software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
 
+
TLSv1_1 - software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
TLS 1.1
+
+
TLSv1_2 - software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
TLS 1.2
+
+
TLSv1_3 - software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
TLS 1.3
+
+
TOPIC_ALIAS_INVALID - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the remote endpoint receives a PublishPacket that contained a topic alias greater than the + maximum topic alias limit that it established for itself when the connection was opened.
+
+
TOPIC_FILTER_INVALID - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the topic filter name is correctly formed but not accepted by the server.
+
+
TOPIC_FILTER_INVALID - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription topic filter was correctly formed but not allowed for the client.
+
+
TOPIC_FILTER_INVALID - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the topic filter was correctly formed but is not allowed for the client on the server.
+
+
TOPIC_NAME_INVALID - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the Will topic name sent in the ConnectPacket is correctly formed, but is not accepted by + the server.
+
+
TOPIC_NAME_INVALID - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when topic name is correctly formed, but is not accepted.
+
+
TOPIC_NAME_INVALID - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the topic name was valid but the receiver was not willing to accept it.
+
+
TopicAliasingOptions - Class in software.amazon.awssdk.crt.mqtt5
+
+
Configuration for all client topic aliasing behavior.
+
+
TopicAliasingOptions() - Constructor for class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions
+
+
Default constructor
+
+
TopicAliasingOptions.InboundTopicAliasBehaviorType - Enum in software.amazon.awssdk.crt.mqtt5
+
+
An enumeration that controls whether or not the client allows the broker to send publishes that use topic + aliasing.
+
+
TopicAliasingOptions.OutboundTopicAliasBehaviorType - Enum in software.amazon.awssdk.crt.mqtt5
+
+
An enumeration that controls how the client applies topic aliasing to outbound publish packets.
+
+
toString() - Method in class software.amazon.awssdk.crt.CrtResource.ResourceInstance
+
 
+
toString() - Method in exception software.amazon.awssdk.crt.CrtRuntimeException
+
 
+
toString() - Method in class software.amazon.awssdk.crt.http.HttpHeader
+
 
+
toString() - Method in class software.amazon.awssdk.crt.http.HttpStreamMetrics
+
 
+
toString() - Method in class software.amazon.awssdk.crt.utils.PackageInfo.Version
+
 
+
Trace - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
TRAILER - software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation
+
 
+
TRAILING - software.amazon.awssdk.crt.http.HttpHeaderBlock
+
 
+
transferData(ByteBuffer, ByteBuffer) - Static method in class software.amazon.awssdk.crt.utils.ByteBufferUtils
+
+
Transfers as much data as possible from an input ByteBuffer to an output ByteBuffer
+
+
traverse(String, boolean, DirectoryTraversalHandler) - Static method in class software.amazon.awssdk.crt.io.DirectoryTraversal
+
+
Deprecated.
+
Traverse a directory starting at the path provided.
+
+
Tunneling - software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType
+
+
Establish a tunneling-based connection through the proxy.
+
+
type - Variable in class software.amazon.awssdk.crt.io.SocketOptions
+
+
Sets the socket type
+
+
+ + + +

U

+
+
UNKNOWN - software.amazon.awssdk.crt.http.HttpVersion
+
 
+
UNKNOWN - software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
 
+
UNKNOWN - software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
 
+
UNKNOWN - software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
 
+
UNSIGNED_PAYLOAD - Static variable in class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
+
 
+
UNSPECIFIED_ERROR - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server has a failure but does not want to specify a reason or none + of the other reason codes apply.
+
+
UNSPECIFIED_ERROR - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned when the connection was closed but the sender does not want to specify a reason or none + of the other reason codes apply.
+
+
UNSPECIFIED_ERROR - software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returned when the (QoS 1) publish was not accepted and the receiver does not want to specify a reason or none + of the other reason codes apply.
+
+
UNSPECIFIED_ERROR - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the connection was closed but the sender does not want to specify a reason or none + of the other reason codes apply.
+
+
UNSPECIFIED_ERROR - software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returned when the unsubscribe of the topic filter was not accepted and the server does not want to specify a + reason or none of the other reason codes apply.
+
+
UnsubAckPacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 UNSUBACK packet.
+
+
UnsubAckPacket.UnsubAckReasonCode - Enum in software.amazon.awssdk.crt.mqtt5.packets
+
+
Reason codes inside UnsubAckPacket payloads that specify the results for each topic filter in the associated + UnsubscribePacket.
+
+
unsubscribe(String) - Method in class software.amazon.awssdk.crt.mqtt.MqttClientConnection
+
+
Unsubscribes from a topic
+
+
unsubscribe(UnsubscribePacket) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5Client
+
+
Tells the Mqtt5Client to attempt to unsubscribe from one or more topic filters.
+
+
UnsubscribePacket - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
Data model of an MQTT5 UNSUBSCRIBE packet.
+
+
UnsubscribePacket.UnsubscribePacketBuilder - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
A class to that allows for the creation of a UnsubscribePacket.
+
+
UnsubscribePacketBuilder() - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder
+
+
Creates a new UnsubscribePacketBuilder so a UnsubscribePacket can be created.
+
+
UnsubscribePacketBuilder(String) - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder
+
+
Creates a new UnsubscribePacketBuilder with one subscription defined.
+
+
UNSUPPORTED_PROTOCOL_VERSION - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server does not support MQTT5 protocol version specified in the connection.
+
+
update(byte[]) - Method in class software.amazon.awssdk.crt.checksums.CRC32
+
+
Updates the current checksum with the specified array of bytes.
+
+
update(byte[]) - Method in class software.amazon.awssdk.crt.checksums.CRC32C
+
 
+
update(byte[]) - Method in class software.amazon.awssdk.crt.checksums.CRC64NVME
+
+
Updates the current checksum with the specified array of bytes.
+
+
update(byte[], int, int) - Method in class software.amazon.awssdk.crt.checksums.CRC32
+
+
Updates the current checksum with the specified array of bytes.
+
+
update(byte[], int, int) - Method in class software.amazon.awssdk.crt.checksums.CRC32C
+
+
Updates the current checksum with the specified array of bytes.
+
+
update(byte[], int, int) - Method in class software.amazon.awssdk.crt.checksums.CRC64NVME
+
+
Updates the current checksum with the specified array of bytes.
+
+
update(int) - Method in class software.amazon.awssdk.crt.checksums.CRC32
+
+
Updates the current checksum with the specified byte.
+
+
update(int) - Method in class software.amazon.awssdk.crt.checksums.CRC32C
+
 
+
update(int) - Method in class software.amazon.awssdk.crt.checksums.CRC64NVME
+
+
Updates the current checksum with the specified byte.
+
+
updateConnectionWindow(long) - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
+
Increment the connection's flow-control window to keep data flowing.
+
+
updateSettings(List<Http2ConnectionSetting>) - Method in class software.amazon.awssdk.crt.http.Http2ClientConnection
+
+
Send a SETTINGS frame.
+
+
Uri - Class in software.amazon.awssdk.crt.io
+
+
Wrapper around an http URI
+
+
Uri() - Constructor for class software.amazon.awssdk.crt.io.Uri
+
 
+
USE_ANOTHER_SERVER - software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returned when the server is telling the client to temporarily use another server instead of the one they + are trying to connect to.
+
+
USE_ANOTHER_SERVER - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned by the server to tell the client to temporarily use a different server.
+
+
UserProperty - Class in software.amazon.awssdk.crt.mqtt5.packets
+
+
A simple key-value pair struct to define a user property.
+
+
UserProperty(String, String) - Constructor for class software.amazon.awssdk.crt.mqtt5.packets.UserProperty
+
 
+
UTF8 - software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator
+
+
The payload is a well-formed utf-8 string value.
+
+
UUID - software.amazon.awssdk.crt.eventstream.HeaderType
+
 
+
+ + + +

V

+
+
validateOptions() - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Validate the stream manager options are valid to use.
+
+
validateOptions() - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Validate the connection manager options are valid to use.
+
+
value - Variable in class software.amazon.awssdk.crt.mqtt5.packets.UserProperty
+
 
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.eventstream.HeaderType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.eventstream.MessageFlags
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.eventstream.MessageType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.HttpHeaderBlock
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.http.HttpVersion
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.SocketOptions.SocketDomain
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.SocketOptions.SocketType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.Log.LogLevel
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.Log.LogSubject
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt.QualityOfService
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.QOS
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
+
Returns the enum constant of this type with the specified name.
+
+
values() - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.eventstream.HeaderType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.eventstream.MessageFlags
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.eventstream.MessageType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.HttpHeaderBlock
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.http.HttpVersion
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.SocketOptions.SocketDomain
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.SocketOptions.SocketType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.TlsCipherPreference
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.TlsHashAlgorithm
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.TlsKeyOperation.Type
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.io.TlsSignatureAlgorithm
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.Log.LogLevel
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.Log.LogSubject
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt.QualityOfService
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.QOS
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.s3.ChecksumAlgorithm
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
verifyPeer - Variable in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Set whether or not the peer should be verified.
+
+
verifyRawSha256EcdsaSignature(byte[], byte[], String, String) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigningUtils
+
 
+
verifySigv4aEcdsaSignature(HttpRequest, String, AwsSigningConfig, byte[], String, String) - Static method in class software.amazon.awssdk.crt.auth.signing.AwsSigningUtils
+
 
+
version - Variable in class software.amazon.awssdk.crt.utils.PackageInfo
+
+
the introspected semantic version of the CRT library instance
+
+
Version(String) - Constructor for class software.amazon.awssdk.crt.utils.PackageInfo.Version
+
 
+
+ + + +

W

+
+
waitForNoResources() - Static method in class software.amazon.awssdk.crt.CrtResource
+
+
Debug/test method to wait for the CRTResource count to drop to zero.
+
+
Warn - software.amazon.awssdk.crt.Log.LogLevel
+
 
+
WebsocketHandshakeTransformArgs - Class in software.amazon.awssdk.crt.mqtt
+
+
Arguments to a websocket handshake transform operation.
+
+
WebsocketHandshakeTransformArgs(MqttClientConnection, HttpRequest, CompletableFuture<HttpRequest>) - Constructor for class software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs
+
 
+
WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode
+
+
Returned by the server when it received a SubscribePacket with a wildcard topic filter, but the server does + not support wildcard topic filters.
+
+
WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED - software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode
+
+
Returned when the subscription's topic filter contains a wildcard but the server does not support + wildcard subscriptions.
+
+
withAccessKeyId(byte[]) - Method in class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
+
+
Sets the AWS access key id to use within the static credentials
+
+
withAckTimeoutSeconds(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before + failing the operation.
+
+
withAlpnList(String) - Method in class software.amazon.awssdk.crt.io.TlsConnectionOptions
+
+
Sets alpn list in the form protocol1;protocol2;....
+
+
withAlpnList(String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the ALPN protocols list for any connections using this TlsContext
+
+
withAuthToken(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder
+
 
+
withBackoffRetryOptions(ExponentialBackoffRetryOptions) - Method in class software.amazon.awssdk.crt.io.StandardRetryOptions
+
+
Sets the exponential backoff configuration
+
+
withBackoffScaleFactorMS(long) - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
+
Configures the initial (base) unscaled backoff interval in milliseconds
+
+
withBootstrap(ClientBootstrap) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the ClientBootstrap to use.
+
+
withBufferSize(int) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Deprecated. +
Sets the IO buffer size to use for connections in the connection pool
+
+
+
withBytesTransferred(long) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestProgress
+
 
+
withCachedProvider(CredentialsProvider) - Method in class software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder
+
+
Sets the credentials provider to cache results from
+
+
withCachingDurationInSeconds(int) - Method in class software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder
+
+
Sets the maximum caching duration for any credentials sourced through this provider.
+
+
withCertificateAuthority(String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Specifies the certificate authority to use.
+
+
withCertificateAuthorityFromPath(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Specifies the certificate authority to use.
+
+
withCertificateFileContents(String) - Method in class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
+
+
Use this X.509 certificate (contents in memory).
+
+
withCertificateFileContents(String) - Method in class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Use this X.509 certificate (contents in memory).
+
+
withCertificateFilePath(String) - Method in class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
+
+
Use this X.509 certificate (file on disk).
+
+
withCertificateFilePath(String) - Method in class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Use this X.509 certificate (file on disk).
+
+
withChecksumAlgorithm(ChecksumAlgorithm) - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
+
The checksum algorithm used to calculate the checksum of payload uploaded.
+
+
withChecksumAlgorithm(ChecksumAlgorithm) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Deprecated. +
Please use S3MetaRequestOptions.withChecksumConfig(ChecksumConfig) instead. + Specify the checksum algorithm to use use for put requests, if unset defaults to NONE and no checksum will be calculated. + The location of the checksum will be default to trailer.
+
+
+
withChecksumConfig(ChecksumConfig) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
The config related to checksum used for the meta request.
+
+
withChecksumLocation(ChecksumConfig.ChecksumLocation) - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
+
If NONE.
+
+
withCipherPreference(TlsCipherPreference) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the ciphers that the TlsContext will be able to use
+
+
withClientBootstrap(ClientBootstrap) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
(Optional) Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
+
+
withClientBootstrap(ClientBootstrap) - Method in class software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder
+
+
Sets what client bootstrap to use when establishing network connections for credentials sourcing
+
+
withClientBootstrap(ClientBootstrap) - Method in interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder
+
+
Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
+
+
withClientBootstrap(ClientBootstrap) - Method in interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder
+
+
Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
+
+
withClientBootstrap(ClientBootstrap) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
+
Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
+
+
withClientBootstrap(ClientBootstrap) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider.Builder
+
+
Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
+
+
withClientBootstrap(ClientBootstrap) - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
+
+
withClientBootstrap(ClientBootstrap) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the client bootstrap instance to use to create the pool's connections
+
+
withClientBootstrap(ClientBootstrap) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withClientId(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the unique string identifying the client to the server.
+
+
withCloseConnectionOnServerError(boolean) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Set to true to inform stream manager to close connection when response with + 500/502/503/504 received.
+
+
withComputeContentMd5(Boolean) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withConfigFileNameOverride(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder
+
+
Sets the name of the config file to use.
+
+
withConnackTimeoutMs(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the time interval to wait after sending a CONNECT request for a CONNACK to arrive.
+
+
withConnectionAcquisitionTimeoutInMilliseconds(int) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
If set, HttpClientConnectionManager.acquireConnection() + will give up after waiting this long for a connection from the pool, + failing with error AWS_ERROR_HTTP_CONNECTION_MANAGER_ACQUISITION_TIMEOUT.
+
+
withConnectionManagerOptions(HttpClientConnectionManagerOptions) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Required.
+
+
withConnectionManualWindowManagement(boolean) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Set to true to manually manage the flow-control window of whole HTTP/2 + connection.
+
+
withConnectionPing(int, int) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Settings to control the period ping to be sent for connections held by stream + manager.
+
+
withConnectOptions(ConnectPacket) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets all configurable options with respect to the CONNECT packet sent by the client, including the Will.
+
+
withConnectTimeoutMs(int) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withContentLength(long) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestProgress
+
 
+
withContentType(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the property specifying the content type of the payload.
+
+
withCorrelationData(byte[]) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the opaque binary data used to correlate between publish messages, as a potential method for request-response + implementation.
+
+
withCredentials(Credentials) - Method in class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
+
+
sets the entire credential set to use within the static credentials provider.
+
+
withCredentialsFileNameOverride(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder
+
+
Sets the name of the credentials file to use.
+
+
withCredentialsProvider(CredentialsProvider) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
Deprecated. +
Please use S3ClientOptions.withSigningConfig(AwsSigningConfig) instead. + The credentials provider will be used to create the signing Config when the client was created. + Client will use `AwsSigningConfig.getDefaultS3SigningConfig(region, credentialsProvider);` to create the signing config.
+
+
+
withCredentialsProvider(CredentialsProvider) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Deprecated. +
Please use S3MetaRequestOptions.withSigningConfig(AwsSigningConfig) instead. + The credentials provider will be used to create the signing Config to override the client level config. + The client config will be used.
+
+
+
withCredsProvider(CredentialsProvider) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
+
Sets the underlying Credentials Provider to use for source credentials
+
+
withCustomRoleArn(String) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
(optional) Sets the ARN of the role to be assumed when multiple roles were received in the token from the + identity provider.
+
+
withDurationSeconds(int) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
 
+
withEnableS3Express(boolean) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
To enable S3 Express support for client + The typical usage for a S3 Express request is to set this to true and let the request to be signed with + AwsSigningConfig.AwsSigningAlgorithm.SIGV4_S3EXPRESS, either from the client level signingConfig or override from request.
+
+
withEndpoint(String) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Sets the Cognito service endpoint to use when sourcing credentials via HTTP
+
+
withEndpoint(String) - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Sets the endpoint to fetch credentials from.
+
+
withEndpoint(String) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
Deprecated.
+
+
withEndpoint(URI) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
withEventLoopGroup(EventLoopGroup) - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
+
Configure the event loop group to use to schedule the backoff/retry tasks
+
+
withExpectedHttpVersion(HttpVersion) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Set the expected protocol version of the connection to be made, default is HTTP/1.1
+
+
withExtendedValidationAndFlowControlOptions(Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the additional controls for client behavior with respect to operation validation and flow control; these checks + go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.
+
+
withFileSize(long) - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
+
Sets the file size corresponding to this entry
+
+
withHandler(DelegateCredentialsHandler) - Method in class software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider.DelegateCredentialsProviderBuilder
+
+
Sets the delegate this provider should use for sourcing credentials
+
+
withHost(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder
+
 
+
withHostName(String) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the host name of the MQTT server to connect to.
+
+
withHostValue(String) - Method in class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties
+
 
+
withHttpMonitoringOptions(HttpMonitoringOptions) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
Options for detecting bad HTTP connections.
+
+
withHttpProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Sets the proxy configuration to use when making the http request that fetches session + credentials from the AWS Cognito Identity service
+
+
withHttpProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the (tunneling) HTTP proxy usage when establishing MQTT connection.
+
+
withHttpRequest(HttpRequest) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Set the initial HTTP request.
+
+
withIdealConcurrentStreamsPerConnection(int) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
For HTTP/2 stream manager only.
+
+
withIdentity(String) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Sets the Cognito identity to source credentials for
+
+
withInboundBehavior(TopicAliasingOptions.InboundTopicAliasBehaviorType) - Method in class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions
+
+
Controls whether or not the client allows the broker to use topic aliasing when sending publishes.
+
+
withInboundCacheMaxSize(int) - Method in class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions
+
+
If inbound topic aliasing is enabled, this will control the size of the inbound alias cache.
+
+
withInitialBucketCapacity(long) - Method in class software.amazon.awssdk.crt.io.StandardRetryOptions
+
+
Sets the initial capacity of the token bucket in the standard retry strategy
+
+
withInitialReadWindowSize(long) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
The starting size of each S3MetaRequest's flow-control window (if backpressure is enabled).
+
+
withInitialSettingsList(List<Http2ConnectionSetting>) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
For HTTP/2 stream manager only.
+
+
withIsDirectory(boolean) - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
+
Sets the isDirectory flag, meaning this entry corresponds to a directory
+
+
withIsFile(boolean) - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
+
Sets the isFile flag, meaning this entry corresponds to a file
+
+
withIsSymLink(boolean) - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
+
Sets the isSymLink flag, meaning this entry corresponds to a symbolic link
+
+
withJitterMode(ExponentialBackoffRetryOptions.JitterMode) - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
+
Configure the type of jitter to apply to the backoff interval calculations
+
+
withKeepAliveIntervalSeconds(Long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the maximum time interval, in seconds, that is permitted to elapse between the point at which the client + finishes transmitting one MQTT packet and the point it starts sending the next.
+
+
withLifecycleEvents(Mqtt5ClientOptions.LifecycleEvents) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the Lifecycle Events interface that will be called when the client gets a LifecycleEvent.
+
+
withLogin(CognitoCredentialsProvider.CognitoLoginTokenPair) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Adds an identity provider token pair to allow for authenticated identity access.
+
+
withManualWindowManagement(boolean) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
If set to true, then you must manage the read backpressure mechanism.
+
+
withMaxConcurrentStreamsPerConnection(int) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Default is no limit, which will use the limit from the server.
+
+
withMaxConnectionIdleInMilliseconds(long) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets maximum amount of time, in milliseconds, that the connection can be idle in the manager before + getting culled by the manager
+
+
withMaxConnections(int) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the maximum number of connections allowed in the connection pool
+
+
withMaxConnections(int) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withMaximumPacketSizeBytes(Long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the maximum packet size the client is willing to handle.
+
+
withMaxPendingConnectionAcquisitions(int) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
If set, HttpClientConnectionManager.acquireConnection() will fail with + AWS_ERROR_HTTP_CONNECTION_MANAGER_MAX_PENDING_ACQUISITIONS_EXCEEDED if there are already pending acquisitions + equal to `maxPendingConnectionAcquisitions`.
+
+
withMaxReconnectDelayMs(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the maximum amount of time to wait to reconnect after a disconnect.
+
+
withMaxRetries(long) - Method in class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
+
+
Configure the maximum number of retries to make while using a strategy sourced from these options
+
+
withMemoryLimitInBytes(long) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
The amount of memory the CRT client is allowed to use.
+
+
withMessageExpiryIntervalSeconds(Long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the maximum amount of time allowed to elapse for message delivery before the server + should instead delete the message (relative to a recipient).
+
+
withMetaRequestType(S3MetaRequestOptions.MetaRequestType) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
withMinConnectedTimeToResetReconnectDelayMs(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the minimum time needed to pass to reset the reconnect delay in milliseconds used when the Mqtt5Client connects.
+
+
withMinimumTlsVersion(TlsContextOptions.TlsVersions) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets the minimum TLS version that the TlsContext will allow.
+
+
withMinReconnectDelayMs(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the minimum amount of time to wait to reconnect after a disconnect.
+
+
withMonitoringOptions(HttpMonitoringOptions) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the monitoring options for connections in the connection pool
+
+
withMtls(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Enables mutual TLS (mTLS) on this TlsContext
+
+
withMtlsCustomKeyOperations(TlsContextCustomKeyOperationOptions) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Unix platforms only, specifies TLS options for custom private key operations.
+
+
withMtlsFromPath(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Enables mutual TLS (mTLS) on this TlsContext
+
+
withMtlsPkcs11(TlsContextPkcs11Options) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Unix platforms only, specifies mutual TLS (mTLS) using a PKCS#11 library for private key operations.
+
+
withMtlsPkcs12(String, String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Apple platforms only, specifies mutual TLS (mTLS) using PKCS#12
+
+
withMtlsWindowsCertStorePath(String) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Windows platforms only, specifies mutual TLS (mTLS) using a certificate in a Windows + certificate store.
+
+
withMultipartUploadThreshold(long) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withNumPartsCompleted(long) - Method in class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
+
 
+
withObjectSizeHint(Long) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
withOfflineQueueBehavior(Mqtt5ClientOptions.ClientOfflineQueueBehavior) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets how disconnects affect the queued and in-progress operations tracked by the client.
+
+
withOperationName(String) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
The S3 operation name (eg: "CreateBucket"), + this MUST be set for S3MetaRequestOptions.MetaRequestType.DEFAULT, + it is ignored for other meta request types since the operation is implicit.
+
+
withOutboundBehavior(TopicAliasingOptions.OutboundTopicAliasBehaviorType) - Method in class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions
+
+
Controls what kind of outbound topic aliasing behavior the client should attempt to use.
+
+
withOutboundCacheMaxSize(int) - Method in class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions
+
+
If outbound topic aliasing is set to LRU, this controls the maximum size of the cache.
+
+
withPartSize(long) - Method in class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
+
 
+
withPartSize(long) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withPassword(byte[]) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the opaque binary data that the server may use for client authentication and authorization.
+
+
withPath(String) - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
+
Sets the absolute path of this entry
+
+
withPathAndQuery(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder
+
 
+
withPayload(byte[]) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the payload for the publish message.
+
+
withPayloadFormat(PublishPacket.PayloadFormatIndicator) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the property specifying the format of the payload data.
+
+
withPingTimeoutMs(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the time interval to wait after sending a PINGREQ for a PINGRESP to arrive.
+
+
withPort(int) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the port to connect to for connections in the connection pool.
+
+
withPort(Long) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the network port of the MQTT server to connect to.
+
+
withPriorKnowledge(boolean) - Method in class software.amazon.awssdk.crt.http.Http2StreamManagerOptions
+
+
Set to true to use prior knowledge to setup connection.
+
+
withPrivateKeyObjectLabel(String) - Method in class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Specify the label of the private key object on the PKCS#11 token.
+
+
withProfileName(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder
+
+
Sets the name of the profile to use.
+
+
withProxyEnvironmentVariableSetting(HttpProxyEnvironmentVariableSetting) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Optional.
+
+
withProxyEnvironmentVariableSetting(HttpProxyEnvironmentVariableSetting) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Sets the proxy configuration to use when making the http request that fetches session + credentials from the IoT x509 credentials provider service
+
+
withProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the proxy options for connections in the connection pool
+
+
withProxyOptions(HttpProxyOptions) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withPublishEvents(Mqtt5ClientOptions.PublishEvents) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the PublishEvents interface that will be called when the client gets a message.
+
+
withQOS(QOS) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the MQTT quality of service level the message should be delivered with.
+
+
withReadBackpressureEnabled(boolean) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
Set whether backpressure is enabled (false by default), to prevent response data downloading faster than you can handle it.
+
+
withReasonCode(DisconnectPacket.DisconnectReasonCode) - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Sets the value indicating the reason that the sender is closing the connection + + See MQTT5 Disconnect Reason Code
+
+
withReasonString(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Sets the additional diagnostic information about the reason that the sender is closing the connection + + See MQTT5 Reason String
+
+
withReceiveMaximum(Long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
+
+
withRegion(String) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withRegion(String) - Method in class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties
+
 
+
withRelativePath(String) - Method in class software.amazon.awssdk.crt.io.DirectoryEntry
+
+
Sets the path relative to the current working directory
+
+
withRequestFilePath(Path) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
If set, this file is sent as the request's body, and the S3MetaRequestOptions.withHttpRequest(software.amazon.awssdk.crt.http.HttpRequest) body stream is ignored.
+
+
withRequestProblemInformation(Boolean) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets whether requests that the server send additional diagnostic information (via response string or + user properties) in DisconnectPacket or ConnAckPacket from the server.
+
+
withRequestResponseInformation(Boolean) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets whether requests that the server send response information in the subsequent ConnAckPacket.
+
+
withResponseFileDeleteOnFailure(boolean) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Sets whether to delete the response file on failure when downloading an + object from S3.
+
+
withResponseFileOption(S3MetaRequestOptions.ResponseFileOption) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Sets the option for how to handle the response file when downloading an + object from S3.
+
+
withResponseFilePath(Path) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
If set, this file will be used to write the response body to a file.
+
+
withResponseFilePosition(long) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Sets the position to start writing to the response file.
+
+
withResponseHandler(S3MetaRequestResponseHandler) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
withResponseTopic(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the opaque topic string intended to assist with request/response implementations.
+
+
withResumeToken(ResumeToken) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
 
+
withRetain(Boolean) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets if this should be a retained message.
+
+
withRetryJitterMode(ExponentialBackoffRetryOptions.JitterMode) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt + time points for a large set of reconnecting clients.
+
+
withRoleAlias(String) - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Sets the role alias to fetch credentials through
+
+
withRoleArn(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
 
+
withS3ExpressCredentialsProviderFactory(S3ExpressCredentialsProviderFactory) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withS3TcpKeepAliveOptions(S3TcpKeepAliveOptions) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withSecretAccessKey(byte[]) - Method in class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
+
+
Sets the AWS secret access key to use within the static credentials
+
+
withServerName(String) - Method in class software.amazon.awssdk.crt.io.TlsConnectionOptions
+
+
Sets server name to use for the SNI extension (supported everywhere), as well + as x.509 validation.
+
+
withServerReference(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Sets the property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint.
+
+
withSessionBehavior(Mqtt5ClientOptions.ClientSessionBehavior) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets how the Mqtt5Client should behave with respect to MQTT sessions.
+
+
withSessionExpiryIntervalSeconds(long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Sets the change to the session expiry interval negotiated at connection time as part of the disconnect.
+
+
withSessionExpiryIntervalSeconds(Long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the time interval, in seconds, that the client requests the server to persist this connection's MQTT session state + for.
+
+
withSessionName(String) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
 
+
withSessionToken(byte[]) - Method in class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
+
+
Sets the AWS session token to use within the static credentials.
+
+
withSigningConfig(AwsSigningConfig) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
+
The configuration related to signing used by S3 client.
+
+
withSigningConfig(AwsSigningConfig) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
The configuration related to signing used by S3 client.
+
+
withSlotId(long) - Method in class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Specify the slot ID containing a PKCS#11 token.
+
+
withSocketOptions(SocketOptions) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the socket options to use for connections in the connection pool
+
+
withSocketOptions(SocketOptions) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the socket properties of the underlying MQTT connections made by the client.
+
+
withStandardRetryOptions(StandardRetryOptions) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withSubscription(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder
+
+
Sets a single topic filter that the client wishes to unsubscribe from.
+
+
withSubscription(String, QOS) - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Sets a single subscription within the SubscribePacket.
+
+
withSubscription(String, QOS, Boolean, Boolean, SubscribePacket.RetainHandlingType) - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Sets a single subscription within the SubscribePacket.
+
+
withSubscription(SubscribePacket.Subscription) - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Sets a single subscription within the SubscribePacket.
+
+
withSubscriptionIdentifier(long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Sets the positive long to associate with all topic filters in this request.
+
+
withThingName(String) - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Sets the iot thing name to fetch credentials by.
+
+
withThroughputTargetGbps(double) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withTimeoutMs(int) - Method in class software.amazon.awssdk.crt.io.TlsConnectionOptions
+
+
Set the TLS negotiation timeout
+
+
withTlsConnectionOptions(TlsConnectionOptions) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the connection-specific TLS options to use for connections in the connection pool.
+
+
withTlsContext(TlsContext) - Method in class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+
+
Sets the tls context to use when making HTTP requests to the Cognito Identity service
+
+
withTlsContext(TlsContext) - Method in interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder
+
+
Sets the tls context to use for any secure network connections made while sourcing credentials.
+
+
withTlsContext(TlsContext) - Method in interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder
+
+
Sets the tls context to use for any secure network connections made while sourcing credentials.
+
+
withTlsContext(TlsContext) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder
+
+
Sets the tls context to use for any secure network connections made while sourcing credentials.
+
+
withTlsContext(TlsContext) - Method in interface software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider.Builder
+
+
Sets the tls context to use for any secure network connections made while sourcing credentials.
+
+
withTlsContext(TlsContext) - Method in class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Sets the tls context initialized with a x509 certificate and private key suitable for + queries against the account's iot credential provider endpoint
+
+
withTlsContext(TlsContext) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the tls context to use for connections in the connection pool
+
+
withTlsContext(TlsContext) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the TLS context for secure socket connections.
+
+
withTlsContext(TlsContext) - Method in class software.amazon.awssdk.crt.s3.S3ClientOptions
+
 
+
withTokenLabel(String) - Method in class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Specify the label of the PKCS#11 token to use.
+
+
withTopic(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the topic this message should be published to.
+
+
withTopicAlias(long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the topic alias to use when sending this publish.
+
+
withTopicAliasingOptions(TopicAliasingOptions) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the topic aliasing options for clients constructed from this builder
+
+
withTotalNumParts(long) - Method in class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
+
 
+
withUploadId(String) - Method in class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
+
 
+
withUri(URI) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the URI to use for connections in the connection pool
+
+
withUsername(String) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the string value that the server may use for client authentication and authorization.
+
+
withUserPin(String) - Method in class software.amazon.awssdk.crt.io.TlsContextPkcs11Options
+
+
Use this PIN to log the user into the PKCS#11 token.
+
+
withUserProperties(List<UserProperty>) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the list of MQTT5 user properties included with the packet.
+
+
withUserProperties(List<UserProperty>) - Method in class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
+
+
Sets the list of MQTT5 user properties included with the packet.
+
+
withUserProperties(List<UserProperty>) - Method in class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
+
+
Sets the list of MQTT5 user properties included with the packet.
+
+
withUserProperties(List<UserProperty>) - Method in class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
+
+
Sets the list of MQTT5 user properties included with the packet.
+
+
withUserProperties(List<UserProperty>) - Method in class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder
+
+
Sets the list of MQTT5 user properties included with the packet.
+
+
withValidateChecksum(boolean) - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
+
Enable checksum mode header will be attached to get requests, this will tell + s3 to send back checksums headers if they exist.
+
+
withValidateChecksum(boolean) - Method in class software.amazon.awssdk.crt.s3.S3MetaRequestOptions
+
+
Deprecated. +
Please use S3MetaRequestOptions.withChecksumConfig(ChecksumConfig) instead. + validateChecksum defaults to false, if set to true, it will cause the client to compare a streamed + calculation of the objects checksum to a remotely stored checksum assigned to the object if one exists. + The checksumValidated field passed in parameter of the finished callback will inform + the user if validation ocurred. A mismatch will result in a AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH error
+
+
+
withValidateChecksumAlgorithmList(List<ChecksumAlgorithm>) - Method in class software.amazon.awssdk.crt.s3.ChecksumConfig
+
+
Ignored when validate_response_checksum is not set.
+
+
withVerifyPeer() - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Enables TLS peer verification of certificates
+
+
withVerifyPeer(boolean) - Method in class software.amazon.awssdk.crt.io.TlsContextOptions
+
+
Sets whether or not TLS will validate the certificate from the peer.
+
+
withWebsocketHandshakeTransform(Consumer<Mqtt5WebsocketHandshakeTransformArgs>) - Method in class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+
+
Sets the callback that allows a custom transformation of the HTTP request that acts as the websocket handshake.
+
+
withWill(PublishPacket) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the definition of a message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first.
+
+
withWillDelayIntervalSeconds(Long) - Method in class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
+
+
Sets the time interval, in seconds, that the server should wait (for a session reconnection) before sending the + will message associated with the connection's session.
+
+
withWindowSize(long) - Method in class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
+
+
Sets the starting size of each HTTP stream's flow-control window.
+
+
wrapFuture(CompletableFuture<T>, T) - Static method in interface software.amazon.awssdk.crt.AsyncCallback
+
 
+
WRITE_TO_POSITION - software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption
+
+
Write to an existing file at the specified position, defined by the + S3MetaRequestOptions.withHttpRequest(software.amazon.awssdk.crt.http.HttpRequest).
+
+
writeChunk(byte[], boolean) - Method in class software.amazon.awssdk.crt.http.HttpStream
+
+
Use only for Http 1.1 Chunked Encoding.
+
+
writeChunk(byte[], boolean, HttpStream.HttpStreamWriteChunkCompletionCallback) - Method in class software.amazon.awssdk.crt.http.HttpStream
+
+
Use only for Http 1.1 Chunked Encoding.
+
+
writeToByteBuffer(ByteBuffer) - Method in class software.amazon.awssdk.crt.eventstream.Header
+
+
Writes the value of this header into a buffer, using the wire representation + of + the header.
+
+
+ + + +

X

+
+
X_AMZ_CONTENT_SHA256 - software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType
+
+
Add the 'X-Amz-Content-Sha256' header to the signed request
+
+
X509CredentialsProvider - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A class that wraps a credentials provider that sources session credentials from IoT's x509 credentials + service.
+
+
X509CredentialsProvider.X509CredentialsProviderBuilder - Class in software.amazon.awssdk.crt.auth.credentials
+
+
A builder class for the 509 provider and its options
+
+
X509CredentialsProviderBuilder() - Constructor for class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
+
+
Default constructor
+
+
+A B C D E F G H I J K L M N O P Q R S T U V W X 
All Classes All Packages
+
+ + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 000000000..47ea53a7a --- /dev/null +++ b/docs/index.html @@ -0,0 +1,213 @@ + + + + + +Overview (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

AWS Common Runtime for Java/JVM

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
software.amazon.awssdk.crt 
software.amazon.awssdk.crt.auth.credentials 
software.amazon.awssdk.crt.auth.signing 
software.amazon.awssdk.crt.cal 
software.amazon.awssdk.crt.checksums 
software.amazon.awssdk.crt.eventstream 
software.amazon.awssdk.crt.http 
software.amazon.awssdk.crt.io 
software.amazon.awssdk.crt.mqtt 
software.amazon.awssdk.crt.mqtt5 
software.amazon.awssdk.crt.mqtt5.packets 
software.amazon.awssdk.crt.s3 
software.amazon.awssdk.crt.utils 
+
+
+ + + diff --git a/docs/jquery-ui.overrides.css b/docs/jquery-ui.overrides.css new file mode 100644 index 000000000..facf852c2 --- /dev/null +++ b/docs/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/docs/jquery/external/jquery/jquery.js b/docs/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..50937333b --- /dev/null +++ b/docs/jquery/external/jquery/jquery.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/docs/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/docs/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/docs/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/docs/jquery/jszip-utils/dist/jszip-utils.js b/docs/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/docs/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + +
+ +

index.html

+
+ + diff --git a/docs/overview-tree.html b/docs/overview-tree.html new file mode 100644 index 000000000..661e1c4a7 --- /dev/null +++ b/docs/overview-tree.html @@ -0,0 +1,439 @@ + + + + + +Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +

Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

+
+ + diff --git a/docs/package-search-index.js b/docs/package-search-index.js new file mode 100644 index 000000000..ecfaa444c --- /dev/null +++ b/docs/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"software.amazon.awssdk.crt"},{"l":"software.amazon.awssdk.crt.auth.credentials"},{"l":"software.amazon.awssdk.crt.auth.signing"},{"l":"software.amazon.awssdk.crt.cal"},{"l":"software.amazon.awssdk.crt.checksums"},{"l":"software.amazon.awssdk.crt.eventstream"},{"l":"software.amazon.awssdk.crt.http"},{"l":"software.amazon.awssdk.crt.io"},{"l":"software.amazon.awssdk.crt.mqtt"},{"l":"software.amazon.awssdk.crt.mqtt5"},{"l":"software.amazon.awssdk.crt.mqtt5.packets"},{"l":"software.amazon.awssdk.crt.s3"},{"l":"software.amazon.awssdk.crt.utils"}] \ No newline at end of file diff --git a/docs/package-search-index.zip b/docs/package-search-index.zip new file mode 100644 index 000000000..95c5fe939 Binary files /dev/null and b/docs/package-search-index.zip differ diff --git a/docs/resources/glass.png b/docs/resources/glass.png new file mode 100644 index 000000000..a7f591f46 Binary files /dev/null and b/docs/resources/glass.png differ diff --git a/docs/resources/x.png b/docs/resources/x.png new file mode 100644 index 000000000..30548a756 Binary files /dev/null and b/docs/resources/x.png differ diff --git a/docs/script.js b/docs/script.js new file mode 100644 index 000000000..7dc93c48e --- /dev/null +++ b/docs/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/docs/search.js b/docs/search.js new file mode 100644 index 000000000..8492271e7 --- /dev/null +++ b/docs/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/docs/serialized-form.html b/docs/serialized-form.html new file mode 100644 index 000000000..76f8a61b1 --- /dev/null +++ b/docs/serialized-form.html @@ -0,0 +1,236 @@ + + + + + +Serialized Form (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/AsyncCallback.html b/docs/software/amazon/awssdk/crt/AsyncCallback.html new file mode 100644 index 000000000..daf32be3c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/AsyncCallback.html @@ -0,0 +1,302 @@ + + + + + +AsyncCallback (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Interface AsyncCallback

    +
    +
    +
    +
      +
    • +
      +
      public interface AsyncCallback
      +
      Async io completion abstraction used by the native mqtt layer. We moved to using futures directly but + that might have been a mistake and we should consider moving back to this for our other async + operations that cross the managed/native boundary
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/CRT.UnknownPlatformException.html b/docs/software/amazon/awssdk/crt/CRT.UnknownPlatformException.html new file mode 100644 index 000000000..cc170cfef --- /dev/null +++ b/docs/software/amazon/awssdk/crt/CRT.UnknownPlatformException.html @@ -0,0 +1,261 @@ + + + + + +CRT.UnknownPlatformException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class CRT.UnknownPlatformException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable
      +
      +
      +
      Enclosing class:
      +
      CRT
      +
      +
      +
      public static class CRT.UnknownPlatformException
+extends RuntimeException
      +
      Exception thrown when we can't detect what platform we're running on and thus can't figure out + the native library name/path to load.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/CRT.html b/docs/software/amazon/awssdk/crt/CRT.html new file mode 100644 index 000000000..8a2e5e47c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/CRT.html @@ -0,0 +1,641 @@ + + + + + +CRT (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class CRT

    +
    +
    + +
    +
      +
    • +
      +
      public final class CRT
+extends Object
      +
      This class is responsible for loading the aws-crt-jni shared lib for the + current platform out of aws-crt-java.jar. One instance of this class has to + be created somewhere to invoke the static initialization block which will + load the shared lib
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CRT

          +
          public CRT()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getCRuntime

          +
          public static String getCRuntime​(String osIdentifier)
          +
          • +
        + + + +
          +
        • +

          getPlatformImpl

          +
          public static CrtPlatform getPlatformImpl()
          +
          • +
        + + + +
          +
        • +

          acquireShutdownRef

          +
          public static void acquireShutdownRef()
          +
          Public API that allows a user to indicate interest in controlling the CRT's time of shutdown. The + shutdown process works via ref-counting, with a default starting count of 1 which is decremented by a + JVM shutdown hook. Each external call to `acquireShutdownRef()` requires a corresponding call to + `releaseShutdownRef()` when the caller is ready for the CRT to be shut down. Once all shutdown references + have been released, the CRT will be shut down. + + If the ref count is not properly driven to zero (and thus leaving the CRT active), the JVM may crash + if unmanaged native code in the CRT is still busy and attempts to call back into the JVM after the JVM cleans + up JNI.
          +
          • +
        + + + +
          +
        • +

          releaseShutdownRef

          +
          public static void releaseShutdownRef()
          +
          Public API to release a shutdown reference that blocks CRT shutdown from proceeding. Must be called once, and + only once, for each call to `acquireShutdownRef()`. Once all shutdown references have been released (including + the initial reference that is managed by a JVM shutdown hook), the CRT will begin its shutdown process which + permanently severs all native-JVM interactions.
          +
          • +
        + + + +
          +
        • +

          awsLastError

          +
          public static int awsLastError()
          +
          Returns the last error on the current thread.
          +
          +
          Returns:
          +
          Last error code recorded in this thread
          +
          +
          • +
        + + + +
          +
        • +

          awsErrorString

          +
          public static String awsErrorString​(int errorCode)
          +
          Given an integer error code from an internal operation, get a corresponding description for it.
          +
          +
          Parameters:
          +
          errorCode - An error code returned from an exception or other native + function call
          +
          Returns:
          +
          A user-friendly description of the error
          +
          +
          • +
        + + + +
          +
        • +

          awsErrorName

          +
          public static String awsErrorName​(int errorCode)
          +
          Given an integer error code from an internal operation, get a corresponding string identifier for it.
          +
          +
          Parameters:
          +
          errorCode - An error code returned from an exception or other native + function call
          +
          Returns:
          +
          A string identifier for the error
          +
          +
          • +
        + + + +
          +
        • +

          nativeMemory

          +
          public static long nativeMemory()
          +
          +
          Returns:
          +
          The number of bytes allocated in native resources. If + aws.crt.memory.tracing is 1 or 2, this will be a non-zero value. + Otherwise, no tracing will be done, and the value will always be 0
          +
          +
          • +
        + + + +
          +
        • +

          dumpNativeMemory

          +
          public static void dumpNativeMemory()
          +
          Dump info to logs about all memory currently allocated by native resources. + The following system properties must be set to see a dump: + aws.crt.memory.tracing must be 1 or 2 + aws.crt.log.level must be "Trace"
          +
          • +
        + + + +
          +
        • +

          checkJniExceptionContract

          +
          public static void checkJniExceptionContract​(boolean clearException)
          +
          • +
        + + + +
          +
        • +

          isFIPS

          +
          public static boolean isFIPS()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/software/amazon/awssdk/crt/CrtPlatform.html b/docs/software/amazon/awssdk/crt/CrtPlatform.html new file mode 100644 index 000000000..af88a97ed --- /dev/null +++ b/docs/software/amazon/awssdk/crt/CrtPlatform.html @@ -0,0 +1,414 @@ + + + + + +CrtPlatform (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class CrtPlatform

    +
    +
    + +
    +
      +
    • +
      +
      public abstract class CrtPlatform
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CrtPlatform

          +
          public CrtPlatform()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/CrtResource.ResourceInstance.html b/docs/software/amazon/awssdk/crt/CrtResource.ResourceInstance.html new file mode 100644 index 000000000..20c4b1191 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/CrtResource.ResourceInstance.html @@ -0,0 +1,418 @@ + + + + + +CrtResource.ResourceInstance (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class CrtResource.ResourceInstance

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.CrtResource.ResourceInstance
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CrtResource
      +
      +
      +
      public class CrtResource.ResourceInstance
+extends Object
      +
      Debug/diagnostic data about a CrtResource object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          nativeHandle

          +
          public long nativeHandle
          +
          • +
        + + + +
          +
        • +

          canonicalName

          +
          public final String canonicalName
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceInstance

          +
          public ResourceInstance​(CrtResource wrapper,
+                        String name)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          location

          +
          public String location()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setNativeHandle

          +
          public void setNativeHandle​(long handle)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/CrtResource.html b/docs/software/amazon/awssdk/crt/CrtResource.html new file mode 100644 index 000000000..4ab8a5c6a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/CrtResource.html @@ -0,0 +1,605 @@ + + + + + +CrtResource (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class CrtResource

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CrtResource

          +
          public CrtResource()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          addReferenceTo

          +
          public void addReferenceTo​(CrtResource resource)
          +
          Marks a resource as referenced by this resource.
          +
          +
          Parameters:
          +
          resource - The resource to add a reference to
          +
          +
          • +
        + + + +
          +
        • +

          removeReferenceTo

          +
          public void removeReferenceTo​(CrtResource resource)
          +
          Removes a reference from this resource to another.
          +
          +
          Parameters:
          +
          resource - The resource to remove a reference to
          +
          +
          • +
        + + + +
          +
        • +

          getNativeHandle

          +
          public long getNativeHandle()
          +
          returns the native handle associated with this CRTResource.
          +
          +
          Returns:
          +
          native address
          +
          +
          • +
        + + + +
          +
        • +

          addRef

          +
          public void addRef()
          +
          Increments the reference count to this resource.
          +
          • +
        + + + +
          +
        • +

          isNull

          +
          public boolean isNull()
          +
          Checks if this resource's native handle is NULL. For always-null resources this is always true. For all other + resources it means it has already been cleaned up or was not properly constructed.
          +
          +
          Returns:
          +
          true if no native resource is bound, false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          close

          +
          public void close()
          +
          +
          Specified by:
          +
          close in interface AutoCloseable
          +
          +
          • +
        + + + +
          +
        • +

          decRef

          +
          public void decRef()
          +
          Decrements the reference count to this resource. If zero is reached, begins (and possibly completes) the resource's + cleanup process.
          +
          • +
        + + + +
          +
        • +

          setDescription

          +
          public void setDescription​(String description)
          +
          Sets a custom logging description for this resource
          +
          +
          Parameters:
          +
          description - custom resource description
          +
          +
          • +
        + + + +
          +
        • +

          getResourceLogDescription

          +
          public String getResourceLogDescription()
          +
          Gets a debug/diagnostic string describing this resource and its reference state
          +
          +
          Returns:
          +
          resource diagnostic string
          +
          +
          • +
        + + + +
          +
        • +

          collectNativeResources

          +
          public static void collectNativeResources​(Consumer<String> fn)
          +
          Applies a resource description consuming functor to all CRTResource objects
          +
          +
          Parameters:
          +
          fn - function to apply to each resource description
          +
          +
          • +
        + + + +
          +
        • +

          collectNativeResource

          +
          public static void collectNativeResource​(Consumer<CrtResource.ResourceInstance> fn)
          +
          Applies a generic diagnostic-gathering functor to all CRTResource objects
          +
          +
          Parameters:
          +
          fn - function to apply to each outstanding Crt resource
          +
          +
          • +
        + + + +
          +
        • +

          logNativeResources

          +
          public static void logNativeResources()
          +
          Debug method to log all of the currently un-closed CRTResource objects.
          +
          • +
        + + + +
          +
        • +

          logNativeResources

          +
          public static void logNativeResources​(Log.LogLevel logLevel)
          +
          • +
        + + + +
          +
        • +

          waitForNoResources

          +
          public static void waitForNoResources()
          +
          Debug/test method to wait for the CRTResource count to drop to zero. Times out with an exception after + a period of waiting.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/CrtRuntimeException.html b/docs/software/amazon/awssdk/crt/CrtRuntimeException.html new file mode 100644 index 000000000..8d5285d42 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/CrtRuntimeException.html @@ -0,0 +1,456 @@ + + + + + +CrtRuntimeException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class CrtRuntimeException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable
      +
      +
      +
      public class CrtRuntimeException
+extends RuntimeException
      +
      This exception will be thrown by any exceptional cases encountered within + the JNI bindings to the AWS Common Runtime
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          errorCode

          +
          public final int errorCode
          +
          • +
        + + + +
          +
        • +

          errorName

          +
          public final String errorName
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CrtRuntimeException

          +
          public CrtRuntimeException​(String msg)
          +
          Constructor for CRT exceptions not due to native errors
          +
          +
          Parameters:
          +
          msg - exception message
          +
          +
          • +
        + + + +
          +
        • +

          CrtRuntimeException

          +
          @Deprecated
+public CrtRuntimeException​(int errorCode,
+                           String errorName)
          +
          Deprecated. +
          use CrtRuntimeException(int errorCode)
          +
          +
          +
          Parameters:
          +
          errorCode - native error code detailing the reason for the exception
          +
          errorName - name of native error code
          +
          +
          • +
        + + + +
          +
        • +

          CrtRuntimeException

          +
          public CrtRuntimeException​(int errorCode)
          +
          Constructor for Crt exceptions due to native errors
          +
          +
          Parameters:
          +
          errorCode - native error code detailing the reason for the exception
          +
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/Log.LogLevel.html b/docs/software/amazon/awssdk/crt/Log.LogLevel.html new file mode 100644 index 000000000..cbd5aee76 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/Log.LogLevel.html @@ -0,0 +1,465 @@ + + + + + +Log.LogLevel (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Enum Log.LogLevel

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Log.LogLevel[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Log.LogLevel c : Log.LogLevel.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Log.LogLevel valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/Log.LogSubject.html b/docs/software/amazon/awssdk/crt/Log.LogSubject.html new file mode 100644 index 000000000..6d2e8c68e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/Log.LogSubject.html @@ -0,0 +1,815 @@ + + + + + +Log.LogSubject (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Enum Log.LogSubject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Log.LogSubject[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Log.LogSubject c : Log.LogSubject.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Log.LogSubject valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/Log.html b/docs/software/amazon/awssdk/crt/Log.html new file mode 100644 index 000000000..d2b446183 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/Log.html @@ -0,0 +1,445 @@ + + + + + +Log (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class Log

    +
    +
    + +
    +
      +
    • +
      +
      public class Log
+extends Object
      +
      Static wrapper around native and crt logging. + + It is NOT safe to change the logging setup after it has been initialized.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Log

          +
          public Log()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          log

          +
          public static void log​(Log.LogLevel level,
+                       Log.LogSubject subject,
+                       String message)
          +
          Logs a message at the specified log level.
          +
          +
          Parameters:
          +
          level - (for filtering purposes) level attached to the log invocation
          +
          subject - (for filtering purposes) log subject
          +
          message - log string to write
          +
          +
          • +
        + + + +
          +
        • +

          initLoggingFromSystemProperties

          +
          public static void initLoggingFromSystemProperties()
+                                            throws IllegalArgumentException
          +
          Examines logging-related system properties and initializes the logging system if they + have been properly set.
          +
          +
          Throws:
          +
          IllegalArgumentException
          +
          +
          • +
        + + + +
          +
        • +

          initLoggingToStdout

          +
          public static void initLoggingToStdout​(Log.LogLevel level)
          +
          Initializes logging to go to stdout
          +
          +
          Parameters:
          +
          level - the filter level to apply to log calls
          +
          +
          • +
        + + + +
          +
        • +

          initLoggingToStderr

          +
          public static void initLoggingToStderr​(Log.LogLevel level)
          +
          Initializes logging to go to stderr
          +
          +
          Parameters:
          +
          level - the filter level to apply to log calls
          +
          +
          • +
        + + + +
          +
        • +

          initLoggingToFile

          +
          public static void initLoggingToFile​(Log.LogLevel level,
+                                     String filename)
          +
          Initializes logging to go to a file
          +
          +
          Parameters:
          +
          level - the filter level to apply to log calls
          +
          filename - name of the file to direct logging to
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/Process.html b/docs/software/amazon/awssdk/crt/Process.html new file mode 100644 index 000000000..706fb40f9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/Process.html @@ -0,0 +1,387 @@ + + + + + +Process (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class Process

    +
    +
    + +
    +
      +
    • +
      +
      public class Process
+extends Object
      +
      Encapsulates Process information and manipulation of process level operations.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Process

          +
          public Process()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPid

          +
          public static int getPid()
          +
          Gets the process id of the running process.
          +
          +
          Returns:
          +
          process id.
          +
          +
          • +
        + + + +
          +
        • +

          getMaxIOHandlesSoftLimit

          +
          public static long getMaxIOHandlesSoftLimit()
          +
          Gets the soft limit for IO handles for this process (max fds in unix terminology)
          +
          +
          Returns:
          +
          soft limit for IO handles.
          +
          +
          • +
        + + + +
          +
        • +

          getMaxIOHandlesHardLimit

          +
          public static long getMaxIOHandlesHardLimit()
          +
          Gets the hard limit for IO handles for this process (max fds in unix terminology). This + value cannot be altered without root permissions.
          +
          +
          Returns:
          +
          hard limit for IO handles.
          +
          +
          • +
        + + + +
          +
        • +

          setMaxIOHandlesSoftLimit

          +
          public static void setMaxIOHandlesSoftLimit​(long maxHandles)
          +
          Sets the soft limit for IO handles for this process (max fds in unix terminology). maxHandles may not exceed the + return value of getMaxIOHandlesHardLimit(). In addition, avoid calling this function unless you've checked + getMaxIOHandlesSoftLimit() is actually less than getMaxIOHandlesHardLimit() since this function will always + fail on some platforms (such as windows) where there are no practical limits in the first place.
          +
          +
          Parameters:
          +
          maxHandles - new soft limit for this process.
          +
          Throws:
          +
          CrtRuntimeException - if the operation fails due to illegal arguments or the opereration is unsupported on + the current platform.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/SystemInfo.CpuInfo.html b/docs/software/amazon/awssdk/crt/SystemInfo.CpuInfo.html new file mode 100644 index 000000000..0466ef5cb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/SystemInfo.CpuInfo.html @@ -0,0 +1,297 @@ + + + + + +SystemInfo.CpuInfo (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class SystemInfo.CpuInfo

    +
    +
    + +
    +
      +
    • +
      +
      Enclosing class:
      +
      SystemInfo
      +
      +
      +
      public static class SystemInfo.CpuInfo
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          cpuId

          +
          public final int cpuId
          +
          OS CpuId that can be used for pinning a thread to a specific Cpu
          +
          • +
        + + + +
          +
        • +

          isSuspectedHyperThread

          +
          public final boolean isSuspectedHyperThread
          +
          If true, the Cpu is suspected of being virtual. If false, it's likely a hw core.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/SystemInfo.html b/docs/software/amazon/awssdk/crt/SystemInfo.html new file mode 100644 index 000000000..139733119 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/SystemInfo.html @@ -0,0 +1,378 @@ + + + + + +SystemInfo (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt
    +

    Class SystemInfo

    +
    +
    + +
    +
      +
    • +
      +
      public class SystemInfo
+extends Object
      +
      Utility class for querying system hardware properties
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SystemInfo

          +
          public SystemInfo()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getProcessorCount

          +
          public static int getProcessorCount()
          +
          +
          Returns:
          +
          active count of processors configured on this system.
          +
          +
          • +
        + + + +
          +
        • +

          getCpuGroupCount

          +
          public static short getCpuGroupCount()
          +
          +
          Returns:
          +
          number of active Cpu groupings on this system. This currently refers to NUMA nodes.
          +
          +
          • +
        + + + +
          +
        • +

          getCpuInfoForGroup

          +
          public static SystemInfo.CpuInfo[] getCpuInfoForGroup​(short groupIdx)
          +
          Get info on all active Cpus in a Cpu group.
          +
          +
          Parameters:
          +
          groupIdx - group index to query.
          +
          Returns:
          +
          Array of CpuInfo objects configured for this group. This value is never null even if groupIdx was invalid.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/CachedCredentialsProvider.CachedCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/CachedCredentialsProvider.CachedCredentialsProviderBuilder.html new file mode 100644 index 000000000..63a2fc1f7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/CachedCredentialsProvider.CachedCredentialsProviderBuilder.html @@ -0,0 +1,371 @@ + + + + + +CachedCredentialsProvider.CachedCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class CachedCredentialsProvider.CachedCredentialsProviderBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CachedCredentialsProvider
      +
      +
      +
      public static class CachedCredentialsProvider.CachedCredentialsProviderBuilder
+extends Object
      +
      A simple builder class for a cached credentials provider and its options
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CachedCredentialsProviderBuilder

          +
          public CachedCredentialsProviderBuilder()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withCachingDurationInSeconds

          +
          public CachedCredentialsProvider.CachedCredentialsProviderBuilder withCachingDurationInSeconds​(int cachingDurationInSeconds)
          +
          Sets the maximum caching duration for any credentials sourced through this provider. Depending on the + wrapped provider's configuration, credentials may be sourced with shorter durations.
          +
          +
          Parameters:
          +
          cachingDurationInSeconds - maximum caching duration in seconds of sourced credentials
          +
          Returns:
          +
          the provider builder
          +
          +
          • +
        + + + + + + + +
          +
        • +

          build

          +
          public CachedCredentialsProvider build()
          +
          Builds a new caching credentials provider
          +
          +
          Returns:
          +
          the new credentials provider
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/CachedCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/CachedCredentialsProvider.html new file mode 100644 index 000000000..4d1d7b6dd --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/CachedCredentialsProvider.html @@ -0,0 +1,286 @@ + + + + + +CachedCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class CachedCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class CachedCredentialsProvider
+extends CredentialsProvider
      +
      A credentials provider that adds caching to another credentials provider via decoration
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.CognitoCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.CognitoCredentialsProviderBuilder.html new file mode 100644 index 000000000..9347b92c0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.CognitoCredentialsProviderBuilder.html @@ -0,0 +1,548 @@ + + + + + +CognitoCredentialsProvider.CognitoCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class CognitoCredentialsProvider.CognitoCredentialsProviderBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CognitoCredentialsProvider
      +
      +
      +
      public static class CognitoCredentialsProvider.CognitoCredentialsProviderBuilder
+extends Object
      +
      A builder class for the Cognito provider and its options
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.CognitoLoginTokenPair.html b/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.CognitoLoginTokenPair.html new file mode 100644 index 000000000..acee759c7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.CognitoLoginTokenPair.html @@ -0,0 +1,334 @@ + + + + + +CognitoCredentialsProvider.CognitoLoginTokenPair (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class CognitoCredentialsProvider.CognitoLoginTokenPair

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoLoginTokenPair
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CognitoCredentialsProvider
      +
      +
      +
      public static class CognitoCredentialsProvider.CognitoLoginTokenPair
+extends Object
      +
      Pair of strings specifying an identity provider name and an associated login token.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          identityProviderName

          +
          public final byte[] identityProviderName
          +
          • +
        + + + +
          +
        • +

          identityProviderToken

          +
          public final byte[] identityProviderToken
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CognitoLoginTokenPair

          +
          public CognitoLoginTokenPair​(String identityProviderName,
+                             String identityProviderToken)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.html new file mode 100644 index 000000000..43dfdcda2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/CognitoCredentialsProvider.html @@ -0,0 +1,293 @@ + + + + + +CognitoCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class CognitoCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class CognitoCredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps a credentials provider that sources session credentials from the AWS Cognito Identity service.
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/Credentials.html b/docs/software/amazon/awssdk/crt/auth/credentials/Credentials.html new file mode 100644 index 000000000..9f3e11534 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/Credentials.html @@ -0,0 +1,442 @@ + + + + + +Credentials (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class Credentials

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.Credentials
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Credentials
+extends Object
      +
      A class representing a set of AWS credentials.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Credentials

          +
          public Credentials()
          +
          Anonymous Credentials constructor. Use Anonymous Credentials when you want to skip signing. + The recommended approach is to use createAnonymousCredentials().
          +
          • +
        + + + +
          +
        • +

          Credentials

          +
          public Credentials​(byte[] accessKeyId,
+                   byte[] secretAccessKey,
+                   byte[] sessionToken)
          +
          +
          Parameters:
          +
          accessKeyId - - access key id to use
          +
          secretAccessKey - - secret access key to use
          +
          sessionToken - - (optional) session token to use
          +
          +
          • +
        + + + +
          +
        • +

          Credentials

          +
          public Credentials​(byte[] accessKeyId,
+                   byte[] secretAccessKey,
+                   byte[] sessionToken,
+                   long expirationTimePointSecs)
          +
          +
          Parameters:
          +
          accessKeyId - - access key id to use
          +
          secretAccessKey - - secret access key to use
          +
          sessionToken - - (optional) session token to use
          +
          expirationTimePointSecs - - Time when the credentials expires, as secs since epoch.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createAnonymousCredentials

          +
          public static Credentials createAnonymousCredentials()
          +
          Anonymous Credentials constructor. Use Anonymous Credentials when you want to skip signing.
          +
          +
          Returns:
          +
          Anonymous Credentials
          +
          +
          • +
        + + + +
          +
        • +

          getAccessKeyId

          +
          public byte[] getAccessKeyId()
          +
          +
          Returns:
          +
          the access key id of the credentials
          +
          +
          • +
        + + + +
          +
        • +

          getSecretAccessKey

          +
          public byte[] getSecretAccessKey()
          +
          +
          Returns:
          +
          the secret access key of the credentials
          +
          +
          • +
        + + + +
          +
        • +

          getSessionToken

          +
          public byte[] getSessionToken()
          +
          +
          Returns:
          +
          the session token of the credentials
          +
          +
          • +
        + + + +
          +
        • +

          getExpirationTimePointSecs

          +
          public long getExpirationTimePointSecs()
          +
          +
          Returns:
          +
          the expiration timepoint as secs since epoch.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/CredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/CredentialsProvider.html new file mode 100644 index 000000000..420e72338 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/CredentialsProvider.html @@ -0,0 +1,336 @@ + + + + + +CredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class CredentialsProvider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCredentials

          +
          public CompletableFuture<Credentials> getCredentials()
          +
          Request credentials from the provider
          +
          +
          Returns:
          +
          A Future for Credentials that will be completed when they are acquired.
          +
          +
          • +
        + + + +
          +
        • +

          getShutdownCompleteFuture

          +
          public CompletableFuture<Void> getShutdownCompleteFuture()
          +
          Learn when this object has finished shutting down.
          +
          +
          Returns:
          +
          future that completes when all of this object's native resources have shut down or released + properly.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder.html new file mode 100644 index 000000000..ccf816bbf --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder.html @@ -0,0 +1,348 @@ + + + + + +DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      DefaultChainCredentialsProvider
      +
      +
      +
      public static class DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder
+extends Object
      +
      A simple builder class for the default credentials provider chain and its options + Does not add reference to CRT resources
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DefaultChainCredentialsProviderBuilder

          +
          public DefaultChainCredentialsProviderBuilder()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public DefaultChainCredentialsProvider build()
          +
          Creates a new default credentials chain provider based on the builder's configuration
          +
          +
          Returns:
          +
          a new default credentials chain provider based on the builder's configuration
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/DefaultChainCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/DefaultChainCredentialsProvider.html new file mode 100644 index 000000000..7076aef58 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/DefaultChainCredentialsProvider.html @@ -0,0 +1,287 @@ + + + + + +DefaultChainCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class DefaultChainCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class DefaultChainCredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps the default AWS credentials provider chain
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsHandler.html b/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsHandler.html new file mode 100644 index 000000000..5465173ae --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsHandler.html @@ -0,0 +1,263 @@ + + + + + +DelegateCredentialsHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Interface DelegateCredentialsHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface DelegateCredentialsHandler
      +
      Interface that synchronously provides custom credentials.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCredentials

          +
          Credentials getCredentials()
          +
          Called from Native when delegate credential provider needs to fetch a + credential.
          +
          +
          Returns:
          +
          Credentials
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsProvider.DelegateCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsProvider.DelegateCredentialsProviderBuilder.html new file mode 100644 index 000000000..ae45ef96c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsProvider.DelegateCredentialsProviderBuilder.html @@ -0,0 +1,347 @@ + + + + + +DelegateCredentialsProvider.DelegateCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class DelegateCredentialsProvider.DelegateCredentialsProviderBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider.DelegateCredentialsProviderBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      DelegateCredentialsProvider
      +
      +
      +
      public static class DelegateCredentialsProvider.DelegateCredentialsProviderBuilder
+extends Object
      +
      A simple builder class for a delegate credentials provider and its options
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DelegateCredentialsProviderBuilder

          +
          public DelegateCredentialsProviderBuilder()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsProvider.html new file mode 100644 index 000000000..d82b80913 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/DelegateCredentialsProvider.html @@ -0,0 +1,287 @@ + + + + + +DelegateCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class DelegateCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class DelegateCredentialsProvider
+extends CredentialsProvider
      +
      A credentials provider that sources credentials from a custom synchronous + callback
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/EcsCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/EcsCredentialsProvider.Builder.html new file mode 100644 index 000000000..4fd232311 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/EcsCredentialsProvider.Builder.html @@ -0,0 +1,374 @@ + + + + + +EcsCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Interface EcsCredentialsProvider.Builder

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      EcsCredentialsProvider
      +
      +
      +
      public static interface EcsCredentialsProvider.Builder
      +
      A builder for creating a custom ECS credentials provider.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withClientBootstrap

          +
          EcsCredentialsProvider.Builder withClientBootstrap​(ClientBootstrap clientBootstrap)
          +
          Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider. The default is a bootstrap which uses the static default event loop group and host + resolver.
          +
          +
          Parameters:
          +
          clientBootstrap - client bootstrap to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          EcsCredentialsProvider.Builder withTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context to use for any secure network connections made while sourcing credentials.
          +
          +
          Parameters:
          +
          tlsContext - the tls context to use when establishing network connections
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withPathAndQuery

          +
          EcsCredentialsProvider.Builder withPathAndQuery​(String pathAndQuery)
          +
          +
          Parameters:
          +
          pathAndQuery - The URL path and query used to connect to the credential service.
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withAuthToken

          +
          EcsCredentialsProvider.Builder withAuthToken​(String authToken)
          +
          +
          Parameters:
          +
          authToken - Token used to retrieve credentials.
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          EcsCredentialsProvider build()
          +
          Create an ECS credentials provider using the configuration applied to this builder.
          +
          +
          Returns:
          +
          A new ECS credentials provider.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/EcsCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/EcsCredentialsProvider.html new file mode 100644 index 000000000..863c41ead --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/EcsCredentialsProvider.html @@ -0,0 +1,359 @@ + + + + + +EcsCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class EcsCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class EcsCredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps a provider that gets credentials from an ECS service. + See https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html for details.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static EcsCredentialsProvider create()
          +
          Create an ECS credentials provider using the defaults.
          +
          +
          Returns:
          +
          An ECS credentials provider.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static EcsCredentialsProvider.Builder builder()
          +
          Get a builder for creating a custom ECS credentials provider.
          +
          +
          Returns:
          +
          A builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/ProfileCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/ProfileCredentialsProvider.Builder.html new file mode 100644 index 000000000..cfcab2dc1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/ProfileCredentialsProvider.Builder.html @@ -0,0 +1,385 @@ + + + + + +ProfileCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Interface ProfileCredentialsProvider.Builder

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ProfileCredentialsProvider
      +
      +
      +
      public static interface ProfileCredentialsProvider.Builder
      +
      A builder for creating a custom profile credentials provider.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withClientBootstrap

          +
          ProfileCredentialsProvider.Builder withClientBootstrap​(ClientBootstrap clientBootstrap)
          +
          Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider. The default is a bootstrap which uses the static default event loop group and host + resolver.
          +
          +
          Parameters:
          +
          clientBootstrap - client bootstrap to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          ProfileCredentialsProvider.Builder withTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context to use for any secure network connections made while sourcing credentials.
          +
          +
          Parameters:
          +
          tlsContext - the tls context to use when establishing network connections
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withProfileName

          +
          ProfileCredentialsProvider.Builder withProfileName​(String profileName)
          +
          Sets the name of the profile to use. If none is specified, the profile named "default" is used.
          +
          +
          Parameters:
          +
          profileName - the profile name to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withConfigFileNameOverride

          +
          ProfileCredentialsProvider.Builder withConfigFileNameOverride​(String configFileNameOverride)
          +
          Sets the name of the config file to use. If none is specified, a name of "~/.aws/config" (Linux and Mac) or + "%USERPROFILE%\.aws\config" (Windows) is used.
          +
          +
          Parameters:
          +
          configFileNameOverride - the config file name to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withCredentialsFileNameOverride

          +
          ProfileCredentialsProvider.Builder withCredentialsFileNameOverride​(String credentialsFileNameOverride)
          +
          Sets the name of the credentials file to use. If none is specified, a name of "~/.aws/credentials" (Linux and + Mac) or "%USERPROFILE%\.aws\credentials" (Windows) is used.
          +
          +
          Parameters:
          +
          credentialsFileNameOverride - the credentials file name to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          ProfileCredentialsProvider build()
          +
          Create a profile credentials provider using the configuration applied to this builder.
          +
          +
          Returns:
          +
          A new profile credentials provider.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/ProfileCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/ProfileCredentialsProvider.html new file mode 100644 index 000000000..e3f5e25b7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/ProfileCredentialsProvider.html @@ -0,0 +1,358 @@ + + + + + +ProfileCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class ProfileCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ProfileCredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps a provider that gets credentials from profile files.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static ProfileCredentialsProvider create()
          +
          Create a profile credentials provider using the default file locations and profile name.
          +
          +
          Returns:
          +
          A profile credentials provider.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static ProfileCredentialsProvider.Builder builder()
          +
          Get a builder for creating a custom profile credentials provider.
          +
          +
          Returns:
          +
          A builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/StaticCredentialsProvider.StaticCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/StaticCredentialsProvider.StaticCredentialsProviderBuilder.html new file mode 100644 index 000000000..86b3c4f62 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/StaticCredentialsProvider.StaticCredentialsProviderBuilder.html @@ -0,0 +1,419 @@ + + + + + +StaticCredentialsProvider.StaticCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class StaticCredentialsProvider.StaticCredentialsProviderBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      StaticCredentialsProvider
      +
      +
      +
      public static class StaticCredentialsProvider.StaticCredentialsProviderBuilder
+extends Object
      +
      A simple builder class for a static credentials provider and its options
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StaticCredentialsProviderBuilder

          +
          public StaticCredentialsProviderBuilder()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          withSecretAccessKey

          +
          public StaticCredentialsProvider.StaticCredentialsProviderBuilder withSecretAccessKey​(byte[] secretAccessKey)
          +
          Sets the AWS secret access key to use within the static credentials
          +
          +
          Parameters:
          +
          secretAccessKey - AWS secret access key to use
          +
          Returns:
          +
          this builder object
          +
          +
          • +
        + + + +
          +
        • +

          withSessionToken

          +
          public StaticCredentialsProvider.StaticCredentialsProviderBuilder withSessionToken​(byte[] sessionToken)
          +
          Sets the AWS session token to use within the static credentials. Session credentials are inherently + time-bound; static providers do not provide any mechanism to update session-based credentials, and use + of session-based credentials with a static provider is discouraged.
          +
          +
          Parameters:
          +
          sessionToken - AWS session token to use
          +
          Returns:
          +
          this builder object
          +
          +
          • +
        + + + + + + + +
          +
        • +

          build

          +
          public StaticCredentialsProvider build()
          +
          Builds a new static credentials provider based on the builder configuration
          +
          +
          Returns:
          +
          a new static credentials provider
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/StaticCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/StaticCredentialsProvider.html new file mode 100644 index 000000000..0964dc7a9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/StaticCredentialsProvider.html @@ -0,0 +1,286 @@ + + + + + +StaticCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class StaticCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class StaticCredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps the a credentials provider that returns a fixed set of credentials
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/StsCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/StsCredentialsProvider.Builder.html new file mode 100644 index 000000000..b61db8c45 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/StsCredentialsProvider.Builder.html @@ -0,0 +1,397 @@ + + + + + +StsCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Interface StsCredentialsProvider.Builder

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      StsCredentialsProvider
      +
      +
      +
      public static interface StsCredentialsProvider.Builder
      +
      A builder for creating a sts credentials provider.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withClientBootstrap

          +
          StsCredentialsProvider.Builder withClientBootstrap​(ClientBootstrap clientBootstrap)
          +
          Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider. The default is a bootstrap which uses the static default event loop group and host + resolver.
          +
          +
          Parameters:
          +
          clientBootstrap - client bootstrap to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          StsCredentialsProvider.Builder withTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context to use for any secure network connections made while sourcing credentials.
          +
          +
          Parameters:
          +
          tlsContext - the tls context to use when establishing network connections
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withCredsProvider

          +
          StsCredentialsProvider.Builder withCredsProvider​(CredentialsProvider credsProvider)
          +
          Sets the underlying Credentials Provider to use for source credentials
          +
          +
          Parameters:
          +
          credsProvider - the CredentialsProvider for source credentials
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withSessionName

          +
          StsCredentialsProvider.Builder withSessionName​(String sessionName)
          +
          +
          Parameters:
          +
          sessionName - the name to associate with the session.
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withDurationSeconds

          +
          StsCredentialsProvider.Builder withDurationSeconds​(int durationSeconds)
          +
          +
          Parameters:
          +
          durationSeconds - number of seconds from authentication that the session is valid for.
          +
          Returns:
          +
          the current builder
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          StsCredentialsProvider build()
          +
          Create a sts credentials provider using the configuration applied to this builder.
          +
          +
          Returns:
          +
          A new sts credentials provider.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/StsCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/StsCredentialsProvider.html new file mode 100644 index 000000000..fda993c72 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/StsCredentialsProvider.html @@ -0,0 +1,358 @@ + + + + + +StsCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class StsCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class StsCredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps a provider that gets credentials from Security Token Service (STS).
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static StsCredentialsProvider create()
          +
          Create a sts credentials provider.
          +
          +
          Returns:
          +
          A sts credentials provider.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static StsCredentialsProvider.Builder builder()
          +
          Get a builder for creating a custom sts credentials provider.
          +
          +
          Returns:
          +
          A builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/StsWebIdentityCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/StsWebIdentityCredentialsProvider.Builder.html new file mode 100644 index 000000000..ccc8e714b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/StsWebIdentityCredentialsProvider.Builder.html @@ -0,0 +1,314 @@ + + + + + +StsWebIdentityCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Interface StsWebIdentityCredentialsProvider.Builder

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      StsWebIdentityCredentialsProvider
      +
      +
      +
      public static interface StsWebIdentityCredentialsProvider.Builder
      +
      A builder for creating an STS web identity credentials provider.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withClientBootstrap

          +
          StsWebIdentityCredentialsProvider.Builder withClientBootstrap​(ClientBootstrap clientBootstrap)
          +
          Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider. The default is a bootstrap which uses the static default event loop group and host + resolver.
          +
          +
          Parameters:
          +
          clientBootstrap - client bootstrap to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          StsWebIdentityCredentialsProvider.Builder withTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context to use for any secure network connections made while sourcing credentials.
          +
          +
          Parameters:
          +
          tlsContext - the tls context to use when establishing network connections
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          StsWebIdentityCredentialsProvider build()
          +
          Create an STS web identity credentials provider using the configuration applied to this builder.
          +
          +
          Returns:
          +
          A new STS web identity credentials provider.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/StsWebIdentityCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/StsWebIdentityCredentialsProvider.html new file mode 100644 index 000000000..1f12383e5 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/StsWebIdentityCredentialsProvider.html @@ -0,0 +1,359 @@ + + + + + +StsWebIdentityCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class StsWebIdentityCredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class StsWebIdentityCredentialsProvider
+extends CredentialsProvider
      +
      Sts with web identity credentials provider sources a set of temporary security credentials for users who have been + authenticated in a mobile or web application with a web identity provider.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/X509CredentialsProvider.X509CredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/X509CredentialsProvider.X509CredentialsProviderBuilder.html new file mode 100644 index 000000000..99744b05e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/X509CredentialsProvider.X509CredentialsProviderBuilder.html @@ -0,0 +1,469 @@ + + + + + +X509CredentialsProvider.X509CredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class X509CredentialsProvider.X509CredentialsProviderBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      X509CredentialsProvider
      +
      +
      +
      public static class X509CredentialsProvider.X509CredentialsProviderBuilder
+extends Object
      +
      A builder class for the 509 provider and its options
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          X509CredentialsProviderBuilder

          +
          public X509CredentialsProviderBuilder()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withClientBootstrap

          +
          public X509CredentialsProvider.X509CredentialsProviderBuilder withClientBootstrap​(ClientBootstrap clientBootstrap)
          +
          Sets the client bootstrap (host resolver and event loop group) to use when making the connections + required by this provider.
          +
          +
          Parameters:
          +
          clientBootstrap - client bootstrap to use
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          public X509CredentialsProvider.X509CredentialsProviderBuilder withTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context initialized with a x509 certificate and private key suitable for + queries against the account's iot credential provider endpoint
          +
          +
          Parameters:
          +
          tlsContext - the tls context to use when establishing the http connection to iot
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          withEndpoint

          +
          public X509CredentialsProvider.X509CredentialsProviderBuilder withEndpoint​(String endpoint)
          +
          Sets the endpoint to fetch credentials from. This is a per-account value that can be determined + via the cli: 'aws iot describe-endpoint --endpoint-type iot:CredentialProvider'
          +
          +
          Parameters:
          +
          endpoint - credentials provider endpoint
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          withProxyOptions

          +
          public X509CredentialsProvider.X509CredentialsProviderBuilder withProxyOptions​(HttpProxyOptions proxyOptions)
          +
          Sets the proxy configuration to use when making the http request that fetches session + credentials from the IoT x509 credentials provider service
          +
          +
          Parameters:
          +
          proxyOptions - proxy configuration for the credentials fetching http request
          +
          Returns:
          +
          The current builder
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public X509CredentialsProvider build()
          +
          Creates a new X509 credentials provider, based on this builder's configuration
          +
          +
          Returns:
          +
          a new X509 credentials provider
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/X509CredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/X509CredentialsProvider.html new file mode 100644 index 000000000..01634a318 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/X509CredentialsProvider.html @@ -0,0 +1,287 @@ + + + + + +X509CredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.credentials
    +

    Class X509CredentialsProvider

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class X509CredentialsProvider
+extends CredentialsProvider
      +
      A class that wraps a credentials provider that sources session credentials from IoT's x509 credentials + service.
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CachedCredentialsProvider.CachedCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CachedCredentialsProvider.CachedCredentialsProviderBuilder.html new file mode 100644 index 000000000..6025ffeef --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CachedCredentialsProvider.CachedCredentialsProviderBuilder.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider.CachedCredentialsProviderBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CachedCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CachedCredentialsProvider.html new file mode 100644 index 000000000..170acdf13 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CachedCredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.CachedCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.CognitoCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.CognitoCredentialsProviderBuilder.html new file mode 100644 index 000000000..26709c5c1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.CognitoCredentialsProviderBuilder.html @@ -0,0 +1,242 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoCredentialsProviderBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.CognitoLoginTokenPair.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.CognitoLoginTokenPair.html new file mode 100644 index 000000000..e90320f37 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.CognitoLoginTokenPair.html @@ -0,0 +1,212 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoLoginTokenPair (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider.CognitoLoginTokenPair

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.html new file mode 100644 index 000000000..044cc225d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CognitoCredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.CognitoCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/Credentials.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/Credentials.html new file mode 100644 index 000000000..4376ff8b2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/Credentials.html @@ -0,0 +1,368 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.Credentials (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.Credentials

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CredentialsProvider.html new file mode 100644 index 000000000..f3683aef2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/CredentialsProvider.html @@ -0,0 +1,399 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.CredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.CredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder.html new file mode 100644 index 000000000..7246a7b49 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DefaultChainCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DefaultChainCredentialsProvider.html new file mode 100644 index 000000000..aaecf60d9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DefaultChainCredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.DefaultChainCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsHandler.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsHandler.html new file mode 100644 index 000000000..46627b9f9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsHandler.html @@ -0,0 +1,197 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsProvider.DelegateCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsProvider.DelegateCredentialsProviderBuilder.html new file mode 100644 index 000000000..f447f8f8a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsProvider.DelegateCredentialsProviderBuilder.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider.DelegateCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider.DelegateCredentialsProviderBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsProvider.html new file mode 100644 index 000000000..437755d97 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/DelegateCredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.DelegateCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/EcsCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/EcsCredentialsProvider.Builder.html new file mode 100644 index 000000000..46a7ad3b9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/EcsCredentialsProvider.Builder.html @@ -0,0 +1,227 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider.Builder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/EcsCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/EcsCredentialsProvider.html new file mode 100644 index 000000000..e09d46869 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/EcsCredentialsProvider.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.EcsCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/ProfileCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/ProfileCredentialsProvider.Builder.html new file mode 100644 index 000000000..61a9c3360 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/ProfileCredentialsProvider.Builder.html @@ -0,0 +1,233 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider.Builder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/ProfileCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/ProfileCredentialsProvider.html new file mode 100644 index 000000000..c647e2028 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/ProfileCredentialsProvider.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.ProfileCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StaticCredentialsProvider.StaticCredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StaticCredentialsProvider.StaticCredentialsProviderBuilder.html new file mode 100644 index 000000000..b2ab38454 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StaticCredentialsProvider.StaticCredentialsProviderBuilder.html @@ -0,0 +1,218 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider.StaticCredentialsProviderBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StaticCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StaticCredentialsProvider.html new file mode 100644 index 000000000..7601f6174 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StaticCredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.StaticCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsCredentialsProvider.Builder.html new file mode 100644 index 000000000..df6fc8973 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsCredentialsProvider.Builder.html @@ -0,0 +1,234 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider.Builder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsCredentialsProvider.html new file mode 100644 index 000000000..4f2fc51e9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsCredentialsProvider.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.StsCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsWebIdentityCredentialsProvider.Builder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsWebIdentityCredentialsProvider.Builder.html new file mode 100644 index 000000000..5c38bbe61 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsWebIdentityCredentialsProvider.Builder.html @@ -0,0 +1,212 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider.Builder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider.Builder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsWebIdentityCredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsWebIdentityCredentialsProvider.html new file mode 100644 index 000000000..68f9cee8f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/StsWebIdentityCredentialsProvider.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.StsWebIdentityCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/X509CredentialsProvider.X509CredentialsProviderBuilder.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/X509CredentialsProvider.X509CredentialsProviderBuilder.html new file mode 100644 index 000000000..f706e555d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/X509CredentialsProvider.X509CredentialsProviderBuilder.html @@ -0,0 +1,235 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider.X509CredentialsProviderBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/class-use/X509CredentialsProvider.html b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/X509CredentialsProvider.html new file mode 100644 index 000000000..cf1dda450 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/class-use/X509CredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.credentials.X509CredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/package-summary.html b/docs/software/amazon/awssdk/crt/auth/credentials/package-summary.html new file mode 100644 index 000000000..d9c0e5eeb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/package-summary.html @@ -0,0 +1,324 @@ + + + + + +software.amazon.awssdk.crt.auth.credentials (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.auth.credentials

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/package-tree.html b/docs/software/amazon/awssdk/crt/auth/credentials/package-tree.html new file mode 100644 index 000000000..8b70c01ff --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/package-tree.html @@ -0,0 +1,201 @@ + + + + + +software.amazon.awssdk.crt.auth.credentials Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.auth.credentials

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/credentials/package-use.html b/docs/software/amazon/awssdk/crt/auth/credentials/package-use.html new file mode 100644 index 000000000..8f713448c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/credentials/package-use.html @@ -0,0 +1,411 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.auth.credentials (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.auth.credentials

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigner.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigner.html new file mode 100644 index 000000000..ea7fc9206 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigner.html @@ -0,0 +1,443 @@ + + + + + +AwsSigner (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Class AwsSigner

    +
    +
    + +
    +
      +
    • +
      +
      public class AwsSigner
+extends Object
      +
      Static class for a variety of AWS signing APIs.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsSigner

          +
          public AwsSigner()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          signRequest

          +
          public static CompletableFuture<HttpRequest> signRequest​(HttpRequest request,
+                                                         AwsSigningConfig config)
          +
          Signs an http request according to the supplied signing configuration
          +
          +
          Parameters:
          +
          request - http request to sign
          +
          config - signing configuration
          +
          Returns:
          +
          future which will contain the signed request
          +
          +
          • +
        + + + +
          +
        • +

          signChunk

          +
          public static CompletableFuture<byte[]> signChunk​(HttpRequestBodyStream chunkBody,
+                                                  byte[] previousSignature,
+                                                  AwsSigningConfig config)
          +
          Signs a body chunk according to the supplied signing configuration
          +
          +
          Parameters:
          +
          chunkBody - stream of bytes that make up the chunk
          +
          previousSignature - the signature of the previous component of the request: either the request itself for + the first chunk, or the previous chunk otherwise
          +
          config - signing configuration
          +
          Returns:
          +
          future which will contain the signature of the chunk. The signature *MUST* be written directly into + the chunk metadata.
          +
          +
          • +
        + + + +
          +
        • +

          sign

          +
          public static CompletableFuture<AwsSigningResult> sign​(HttpRequest request,
+                                                       AwsSigningConfig config)
          +
          Signs an http request according to the supplied signing configuration
          +
          +
          Parameters:
          +
          request - http request to sign
          +
          config - signing configuration
          +
          Returns:
          +
          future which will contain a signing result, which provides easier access to all signing-related + result properties
          +
          +
          • +
        + + + +
          +
        • +

          sign

          +
          public static CompletableFuture<AwsSigningResult> sign​(HttpRequestBodyStream chunkBody,
+                                                       byte[] previousSignature,
+                                                       AwsSigningConfig config)
          +
          Signs a body chunk according to the supplied signing configuration
          +
          +
          Parameters:
          +
          chunkBody - stream of bytes that make up the chunk
          +
          previousSignature - the signature of the previous component of the request: either the request itself for + the first chunk, or the previous chunk otherwise
          +
          config - signing configuration
          +
          Returns:
          +
          future which will contain a signing result, which provides easier access to all signing-related + result properties
          +
          +
          • +
        + + + +
          +
        • +

          sign

          +
          public static CompletableFuture<AwsSigningResult> sign​(List<HttpHeader> headers,
+                                                       byte[] previousSignature,
+                                                       AwsSigningConfig config)
          +
          Signs a body chunk according to the supplied signing configuration
          +
          +
          Parameters:
          +
          headers - list of headers to be sent in the trailer.
          +
          previousSignature - the signature of the previous component of the + request: either the request itself for the first + chunk, or the previous chunk otherwise
          +
          config - signing configuration
          +
          Returns:
          +
          future which will contain a signing result, which provides easier + access to all signing-related result properties
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignatureType.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignatureType.html new file mode 100644 index 000000000..db0d7fbbf --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignatureType.html @@ -0,0 +1,486 @@ + + + + + +AwsSigningConfig.AwsSignatureType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Enum AwsSigningConfig.AwsSignatureType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          HTTP_REQUEST_VIA_HEADERS

          +
          public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_VIA_HEADERS
          +
          A signature for a full http request should be computed, with header updates applied to the signing result.
          +
          • +
        + + + +
          +
        • +

          HTTP_REQUEST_VIA_QUERY_PARAMS

          +
          public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_VIA_QUERY_PARAMS
          +
          A signature for a full http request should be computed, with query param updates applied to the signing result.
          +
          • +
        + + + + + + + +
          +
        • +

          HTTP_REQUEST_EVENT

          +
          public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_EVENT
          +
          Compute a signature for an event stream event. + + This option is not yet supported.
          +
          • +
        + + + +
          +
        • +

          HTTP_REQUEST_TRAILING_HEADERS

          +
          public static final AwsSigningConfig.AwsSignatureType HTTP_REQUEST_TRAILING_HEADERS
          +
          Compute a signature for a payloads trailing headers.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AwsSigningConfig.AwsSignatureType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AwsSigningConfig.AwsSignatureType c : AwsSigningConfig.AwsSignatureType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AwsSigningConfig.AwsSignatureType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          Gets the native enum value as an integer that is associated with this Java enum value
          +
          +
          Returns:
          +
          this value's associated native enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static AwsSigningConfig.AwsSignatureType getEnumValueFromInteger​(int value)
          +
          Creates a Java enum value from a native enum value as an integer
          +
          +
          Parameters:
          +
          value - native enum value
          +
          Returns:
          +
          the corresponding Java enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignedBodyHeaderType.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignedBodyHeaderType.html new file mode 100644 index 000000000..522e91bce --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignedBodyHeaderType.html @@ -0,0 +1,436 @@ + + + + + +AwsSigningConfig.AwsSignedBodyHeaderType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Enum AwsSigningConfig.AwsSignedBodyHeaderType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AwsSigningConfig.AwsSignedBodyHeaderType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AwsSigningConfig.AwsSignedBodyHeaderType c : AwsSigningConfig.AwsSignedBodyHeaderType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AwsSigningConfig.AwsSignedBodyHeaderType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          Gets the native enum value as an integer that is associated with this Java enum value
          +
          +
          Returns:
          +
          this value's associated native enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static AwsSigningConfig.AwsSignedBodyHeaderType getEnumValueFromInteger​(int value)
          +
          Creates a Java enum value from a native enum value as an integer
          +
          +
          Parameters:
          +
          value - native enum value
          +
          Returns:
          +
          the corresponding Java enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignedBodyValue.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignedBodyValue.html new file mode 100644 index 000000000..e7852395e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSignedBodyValue.html @@ -0,0 +1,431 @@ + + + + + +AwsSigningConfig.AwsSignedBodyValue (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Class AwsSigningConfig.AwsSignedBodyValue

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      AwsSigningConfig
      +
      +
      +
      public class AwsSigningConfig.AwsSignedBodyValue
+extends Object
      +
      A set of string constants for various canonical request payload values. If signed body header type is not NONE + then the value will also be reflected in X-Amz-Content-Sha256
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsSignedBodyValue

          +
          public AwsSignedBodyValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSigningAlgorithm.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSigningAlgorithm.html new file mode 100644 index 000000000..3f42415db --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.AwsSigningAlgorithm.html @@ -0,0 +1,452 @@ + + + + + +AwsSigningConfig.AwsSigningAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Enum AwsSigningConfig.AwsSigningAlgorithm

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AwsSigningConfig.AwsSigningAlgorithm[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AwsSigningConfig.AwsSigningAlgorithm c : AwsSigningConfig.AwsSigningAlgorithm.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AwsSigningConfig.AwsSigningAlgorithm valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          Trivial Java Enum value to native enum value conversion function
          +
          +
          Returns:
          +
          integer associated with this enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static AwsSigningConfig.AwsSigningAlgorithm getEnumValueFromInteger​(int value)
          +
          Creates a Java enum value from a native enum value as an integer
          +
          +
          Parameters:
          +
          value - native enum value
          +
          Returns:
          +
          the corresponding Java enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.html new file mode 100644 index 000000000..4be3e8a59 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningConfig.html @@ -0,0 +1,1023 @@ + + + + + +AwsSigningConfig (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Class AwsSigningConfig

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class AwsSigningConfig
+extends CrtResource
      +
      A class representing configuration related to signing something "signable" (an http request, a body chunk, a + stream event) via an AWS signing process.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsSigningConfig

          +
          public AwsSigningConfig()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clone

          +
          public AwsSigningConfig clone()
          +
          Creates a new signing configuration from this one.
          +
          +
          Returns:
          +
          a clone of this signing configuration
          +
          +
          • +
        + + + +
          +
        • +

          setAlgorithm

          +
          public void setAlgorithm​(AwsSigningConfig.AwsSigningAlgorithm algorithm)
          +
          Sets what version of the AWS signing process should be used
          +
          +
          Parameters:
          +
          algorithm - desired version of the AWS signing process
          +
          +
          • +
        + + + +
          +
        • +

          getAlgorithm

          +
          public AwsSigningConfig.AwsSigningAlgorithm getAlgorithm()
          +
          Gets what version of the AWS signing procecss will be used
          +
          +
          Returns:
          +
          what version of the AWS signing procecss will be used
          +
          +
          • +
        + + + +
          +
        • +

          setSignatureType

          +
          public void setSignatureType​(AwsSigningConfig.AwsSignatureType signatureType)
          +
          Sets what sort of signature should be computed
          +
          +
          Parameters:
          +
          signatureType - what kind of signature to compute
          +
          +
          • +
        + + + +
          +
        • +

          getSignatureType

          +
          public AwsSigningConfig.AwsSignatureType getSignatureType()
          +
          Gets what kind of signature will be computed
          +
          +
          Returns:
          +
          what kind of signature will be computed
          +
          +
          • +
        + + + +
          +
        • +

          setRegion

          +
          public void setRegion​(String region)
          +
          Sets what to use for region when signing. Depending on the algorithm, this may not be an actual region name + and so no validation is done on this parameter. In sigv4a, this value is used for the "region-set" concept.
          +
          +
          Parameters:
          +
          region - region value to use when signing
          +
          +
          • +
        + + + +
          +
        • +

          getRegion

          +
          public String getRegion()
          +
          Gets what will be used for the region or region-set concept during signing.
          +
          +
          Returns:
          +
          what will be used for the region or region-set concept during signing
          +
          +
          • +
        + + + +
          +
        • +

          setService

          +
          public void setService​(String service)
          +
          Sets what service signing name to use.
          +
          +
          Parameters:
          +
          service - signing name of the service that this signing calculation should use
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public String getService()
          +
          Gets what service signing name will be used
          +
          +
          Returns:
          +
          what service signing name will be used
          +
          +
          • +
        + + + +
          +
        • +

          setTime

          +
          public void setTime​(long time)
          +
          Sets the point in time that signing should be relative to. Not Instant for Android API level support reasons. + Additionally, for http requests, X-Amz-Date will be added to the request using this time point.
          +
          +
          Parameters:
          +
          time - point in time, as milliseconds since epoch, that signing should be relative to
          +
          +
          • +
        + + + +
          +
        • +

          getTime

          +
          public long getTime()
          +
          Gets the point in time (in milliseconds since epoch) that signing will be done relative to
          +
          +
          Returns:
          +
          the point in time (in milliseconds since epoch) that signing will be done relative to
          +
          +
          • +
        + + + +
          +
        • +

          setCredentialsProvider

          +
          public void setCredentialsProvider​(CredentialsProvider credentialsProvider)
          +
          Sets the provider to use to source credentials from before signing.
          +
          +
          Parameters:
          +
          credentialsProvider - provider to retrieve credentials from prior to signing
          +
          +
          • +
        + + + +
          +
        • +

          getCredentialsProvider

          +
          public CredentialsProvider getCredentialsProvider()
          +
          Gets the provider to source credentials from before signing
          +
          +
          Returns:
          +
          the provider to source credentials from before signing
          +
          +
          • +
        + + + +
          +
        • +

          setCredentials

          +
          public void setCredentials​(Credentials credentials)
          +
          Sets the credentials to use for signing. Overrides the provider setting if non-null.
          +
          +
          Parameters:
          +
          credentials - credentials to use for signing
          +
          +
          • +
        + + + +
          +
        • +

          getCredentials

          +
          public Credentials getCredentials()
          +
          Gets the credentials to use for signing.
          +
          +
          Returns:
          +
          credentials to use for signing
          +
          +
          • +
        + + + +
          +
        • +

          setShouldSignHeader

          +
          public void setShouldSignHeader​(Predicate<String> shouldSignHeader)
          +
          Sets a header-name signing predicate filter. Headers that do not pass the filter will not be signed.
          +
          +
          Parameters:
          +
          shouldSignHeader - header-name signing predicate filter
          +
          +
          • +
        + + + +
          +
        • +

          getShouldSignHeader

          +
          public Predicate<String> getShouldSignHeader()
          +
          Gets the header-name signing predicate filter to use
          +
          +
          Returns:
          +
          the header-name signing predicate filter to use
          +
          +
          • +
        + + + +
          +
        • +

          setUseDoubleUriEncode

          +
          public void setUseDoubleUriEncode​(boolean useDoubleUriEncode)
          +
          Sets whether or not signing should uri encode urls as part of canonical request construction. + We assume the uri will be encoded once in preparation for transmission. Certain services + do not decode before checking signature, requiring us to actually double-encode the uri in the canonical + request in order to pass a signature check.
          +
          +
          Parameters:
          +
          useDoubleUriEncode - should signing uri encode urls in the canonical request
          +
          +
          • +
        + + + +
          +
        • +

          getUseDoubleUriEncode

          +
          public boolean getUseDoubleUriEncode()
          +
          Gets whether or not signing will uri encode urls during canonical request construction
          +
          +
          Returns:
          +
          whether or not signing will uri encode urls during canonical request construction
          +
          +
          • +
        + + + +
          +
        • +

          setShouldNormalizeUriPath

          +
          public void setShouldNormalizeUriPath​(boolean shouldNormalizeUriPath)
          +
          Sets whether or not the uri path should be normalized during canonical request construction
          +
          +
          Parameters:
          +
          shouldNormalizeUriPath - whether or not the uri path should be normalized during canonical request construction
          +
          +
          • +
        + + + +
          +
        • +

          getShouldNormalizeUriPath

          +
          public boolean getShouldNormalizeUriPath()
          +
          Gets whether or not the uri path should be normalized during canonical request construction
          +
          +
          Returns:
          +
          whether or not the uri path should be normalized during canonical request construction
          +
          +
          • +
        + + + +
          +
        • +

          setOmitSessionToken

          +
          public void setOmitSessionToken​(boolean omitSessionToken)
          +
          Sets whether or not X-Amz-Session-Token should be added to the canonical request when signing with session + credentials. + + "X-Amz-Security-Token" is added during signing, as a header or + query param, when credentials have a session token. + If false (the default), this parameter is included in the canonical request. + If true, this parameter is still added, but omitted from the canonical request.
          +
          +
          Parameters:
          +
          omitSessionToken - whether or not X-Amz-Session-Token should be added to the canonical request when signing with session + credentials
          +
          +
          • +
        + + + +
          +
        • +

          getOmitSessionToken

          +
          public boolean getOmitSessionToken()
          +
          Gets whether or not X-Amz-Session-Token should be added to the canonical request when signing with session + credentials.
          +
          +
          Returns:
          +
          whether or not X-Amz-Session-Token should be added to the canonical request when signing with session + credentials
          +
          +
          • +
        + + + +
          +
        • +

          setSignedBodyValue

          +
          public void setSignedBodyValue​(String signedBodyValue)
          +
          Sets the payload hash override value to use in canonical request construction. If the signed body header type is + not set to null, then the designated header will also take on this value. If this value is NULL, then the signer + will compute the SHA256 of the body stream and use that instead.
          +
          +
          Parameters:
          +
          signedBodyValue - payload hash override value to use in canonical request construction
          +
          +
          • +
        + + + +
          +
        • +

          getSignedBodyValue

          +
          public String getSignedBodyValue()
          +
          Gets the payload hash override to use in canonical request construction.
          +
          +
          Returns:
          +
          the payload hash override to use in canonical request construction
          +
          +
          • +
        + + + +
          +
        • +

          setSignedBodyHeader

          +
          public void setSignedBodyHeader​(AwsSigningConfig.AwsSignedBodyHeaderType signedBodyHeader)
          +
          Sets what signed body header should hold the payload hash (or override value).
          +
          +
          Parameters:
          +
          signedBodyHeader - what signed body header should hold the payload hash (or override value)
          +
          +
          • +
        + + + +
          +
        • +

          getSignedBodyHeader

          +
          public AwsSigningConfig.AwsSignedBodyHeaderType getSignedBodyHeader()
          +
          Gets what signed body header should hold the payload hash (or override value).
          +
          +
          Returns:
          +
          what signed body header should hold the payload hash (or override value)
          +
          +
          • +
        + + + +
          +
        • +

          setExpirationInSeconds

          +
          public void setExpirationInSeconds​(long expirationInSeconds)
          +
          Sets the expiration time in seconds when using query param signing (pre-signed url). The appropriate query param + will be added to the URL when building the canonical and signed requests.
          +
          +
          Parameters:
          +
          expirationInSeconds - time in seconds that a pre-signed url will be valid for
          +
          +
          • +
        + + + +
          +
        • +

          getExpirationInSeconds

          +
          public long getExpirationInSeconds()
          +
          Gets the expiration time in seconds to use when signing to make a pre-signed url.
          +
          +
          Returns:
          +
          the expiration time in seconds for a pre-signed url
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultS3SigningConfig

          +
          public static AwsSigningConfig getDefaultS3SigningConfig​(String region,
+                                                         CredentialsProvider credentialsProvider)
          +
          Helper to get the default signing Config for S3.
          +
          +
          Parameters:
          +
          region - The region to sign with
          +
          credentialsProvider - The provider while signing request.
          +
          Returns:
          +
          the default signing config for S3
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningResult.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningResult.html new file mode 100644 index 000000000..2bb038343 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningResult.html @@ -0,0 +1,349 @@ + + + + + +AwsSigningResult (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Class AwsSigningResult

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.signing.AwsSigningResult
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class AwsSigningResult
+extends Object
      +
      Wrapper that holds signing-related output. Depending on the signing configuration, not all members may be + assigned and some members, like signature, may have a variable format.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsSigningResult

          +
          public AwsSigningResult()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSignedRequest

          +
          public HttpRequest getSignedRequest()
          +
          Gets the signed http request from the result
          +
          +
          Returns:
          +
          the signed http request, or NULL if an http request was not signed
          +
          +
          • +
        + + + +
          +
        • +

          getSignature

          +
          public byte[] getSignature()
          +
          Gets the signature value from the result. Depending on the requested signature type and algorithm, this value + will be in one of the following formats: + + (1) HTTP_REQUEST_VIA_HEADERS - hex encoding of the binary signature value + (2) HTTP_REQUEST_VIA_QUERY_PARAMS - hex encoding of the binary signature value + (3) HTTP_REQUEST_CHUNK/SIGV4 - hex encoding of the binary signature value + (4) HTTP_REQUEST_CHUNK/SIGV4_ASYMMETRIC - '*'-padded hex encoding of the binary signature value + (5) HTTP_REQUEST_EVENT - binary signature value (NYI)
          +
          +
          Returns:
          +
          the signature value from the signing process
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningUtils.html b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningUtils.html new file mode 100644 index 000000000..bff5775b3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/AwsSigningUtils.html @@ -0,0 +1,340 @@ + + + + + +AwsSigningUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.auth.signing
    +

    Class AwsSigningUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.auth.signing.AwsSigningUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class AwsSigningUtils
+extends Object
      +
      Internal utility/testing functions for verifying sigv4a signatures.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsSigningUtils

          +
          public AwsSigningUtils()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          verifySigv4aEcdsaSignature

          +
          public static boolean verifySigv4aEcdsaSignature​(HttpRequest request,
+                                                 String expectedCanonicalRequest,
+                                                 AwsSigningConfig config,
+                                                 byte[] hexEncodedSignature,
+                                                 String verifierPubX,
+                                                 String verifierPubY)
          +
          • +
        + + + +
          +
        • +

          verifyRawSha256EcdsaSignature

          +
          public static boolean verifyRawSha256EcdsaSignature​(byte[] stringToSign,
+                                                    byte[] hexEncodedSignature,
+                                                    String verifierPubX,
+                                                    String verifierPubY)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigner.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigner.html new file mode 100644 index 000000000..674bb271f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigner.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigner (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigner

    +
    +
    No usage of software.amazon.awssdk.crt.auth.signing.AwsSigner
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignatureType.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignatureType.html new file mode 100644 index 000000000..11b011268 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignatureType.html @@ -0,0 +1,236 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignatureType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignedBodyHeaderType.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignedBodyHeaderType.html new file mode 100644 index 000000000..092ec918c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignedBodyHeaderType.html @@ -0,0 +1,236 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyHeaderType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignedBodyValue.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignedBodyValue.html new file mode 100644 index 000000000..d31492f49 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSignedBodyValue.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue

    +
    +
    No usage of software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSignedBodyValue
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSigningAlgorithm.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSigningAlgorithm.html new file mode 100644 index 000000000..949e737c8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.AwsSigningAlgorithm.html @@ -0,0 +1,236 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningConfig.AwsSigningAlgorithm

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.html new file mode 100644 index 000000000..a482fd97b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningConfig.html @@ -0,0 +1,323 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningConfig (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningConfig

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningResult.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningResult.html new file mode 100644 index 000000000..e7f15e398 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningResult.html @@ -0,0 +1,216 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningResult (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningResult

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningUtils.html b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningUtils.html new file mode 100644 index 000000000..006a5ff1a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/class-use/AwsSigningUtils.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.auth.signing.AwsSigningUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.auth.signing.AwsSigningUtils

    +
    +
    No usage of software.amazon.awssdk.crt.auth.signing.AwsSigningUtils
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/package-summary.html b/docs/software/amazon/awssdk/crt/auth/signing/package-summary.html new file mode 100644 index 000000000..0aac2cc24 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/package-summary.html @@ -0,0 +1,219 @@ + + + + + +software.amazon.awssdk.crt.auth.signing (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.auth.signing

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AwsSigner +
      Static class for a variety of AWS signing APIs.
      +
      AwsSigningConfig +
      A class representing configuration related to signing something "signable" (an http request, a body chunk, a + stream event) via an AWS signing process.
      +
      AwsSigningResult +
      Wrapper that holds signing-related output.
      +
      AwsSigningUtils +
      Internal utility/testing functions for verifying sigv4a signatures.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      AwsSigningConfig.AwsSignatureType +
      What sort of signature should be computed from the signable?
      +
      AwsSigningConfig.AwsSignedBodyHeaderType +
      Controls if signing adds a header containing the canonical request's body value
      +
      AwsSigningConfig.AwsSigningAlgorithm +
      What version of the AWS signing process should we use.
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/package-tree.html b/docs/software/amazon/awssdk/crt/auth/signing/package-tree.html new file mode 100644 index 000000000..1a052bf83 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/package-tree.html @@ -0,0 +1,190 @@ + + + + + +software.amazon.awssdk.crt.auth.signing Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.auth.signing

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/auth/signing/package-use.html b/docs/software/amazon/awssdk/crt/auth/signing/package-use.html new file mode 100644 index 000000000..3338550cb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/auth/signing/package-use.html @@ -0,0 +1,237 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.auth.signing (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.auth.signing

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/EccKeyPair.AwsEccCurve.html b/docs/software/amazon/awssdk/crt/cal/EccKeyPair.AwsEccCurve.html new file mode 100644 index 000000000..8123236bc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/EccKeyPair.AwsEccCurve.html @@ -0,0 +1,437 @@ + + + + + +EccKeyPair.AwsEccCurve (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.cal
    +

    Enum EccKeyPair.AwsEccCurve

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          AWS_ECDSA_P256

          +
          public static final EccKeyPair.AwsEccCurve AWS_ECDSA_P256
          +
          Nist standard P256 elliptic curve
          +
          • +
        + + + +
          +
        • +

          AWS_ECDSA_P384

          +
          public static final EccKeyPair.AwsEccCurve AWS_ECDSA_P384
          +
          Nist standard P384 elliptic curve
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static EccKeyPair.AwsEccCurve[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (EccKeyPair.AwsEccCurve c : EccKeyPair.AwsEccCurve.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static EccKeyPair.AwsEccCurve valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          Gets the native enum value as an integer that is associated with this Java enum value
          +
          +
          Returns:
          +
          this value's associated native enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static EccKeyPair.AwsEccCurve getEnumValueFromInteger​(int value)
          +
          Creates a Java enum value from a native enum value as an integer
          +
          +
          Parameters:
          +
          value - native enum value
          +
          Returns:
          +
          the corresponding Java enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/EccKeyPair.html b/docs/software/amazon/awssdk/crt/cal/EccKeyPair.html new file mode 100644 index 000000000..54fe78d0e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/EccKeyPair.html @@ -0,0 +1,359 @@ + + + + + +EccKeyPair (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.cal
    +

    Class EccKeyPair

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class EccKeyPair
+extends CrtResource
      +
      This class puts an opaque wrapper around aws_ecc_key_pair from aws-c-cal. Currently, it is only intended to be + cached and returned to native code by a signing invocation. + + If there's a compelling reason, we can add accessors and conversions to/from Java's KeyPair.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          newDeriveFromCredentials

          +
          public static EccKeyPair newDeriveFromCredentials​(Credentials credentials,
+                                                  EccKeyPair.AwsEccCurve curve)
          +
          Derives the associated ECC key from a pair of AWS credentials according to the sigv4a ecc key + derivation specification.
          +
          +
          Parameters:
          +
          credentials - AWS credentials to derive the associated key for
          +
          curve - ECC curve to use (only P256 is currently supported)
          +
          Returns:
          +
          derived ecc key pair associated with the AWS credentials
          +
          +
          • +
        + + + +
          +
        • +

          signMessage

          +
          public byte[] signMessage​(byte[] message)
          +
          Sign a message using the ECC key pair via ECDSA
          +
          +
          Parameters:
          +
          message - message to sign
          +
          Returns:
          +
          the ECDSA signature of the message
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/class-use/EccKeyPair.AwsEccCurve.html b/docs/software/amazon/awssdk/crt/cal/class-use/EccKeyPair.AwsEccCurve.html new file mode 100644 index 000000000..e65614609 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/class-use/EccKeyPair.AwsEccCurve.html @@ -0,0 +1,231 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.cal.EccKeyPair.AwsEccCurve

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/class-use/EccKeyPair.html b/docs/software/amazon/awssdk/crt/cal/class-use/EccKeyPair.html new file mode 100644 index 000000000..bc3392b23 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/class-use/EccKeyPair.html @@ -0,0 +1,199 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.cal.EccKeyPair (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.cal.EccKeyPair

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/package-summary.html b/docs/software/amazon/awssdk/crt/cal/package-summary.html new file mode 100644 index 000000000..21788b02f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/package-summary.html @@ -0,0 +1,189 @@ + + + + + +software.amazon.awssdk.crt.cal (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.cal

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      EccKeyPair +
      This class puts an opaque wrapper around aws_ecc_key_pair from aws-c-cal.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      EccKeyPair.AwsEccCurve +
      Enum for supported ECC curves + Needs to stay in sync with aws_ecc_curve_name
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/package-tree.html b/docs/software/amazon/awssdk/crt/cal/package-tree.html new file mode 100644 index 000000000..f8b857f1c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/package-tree.html @@ -0,0 +1,184 @@ + + + + + +software.amazon.awssdk.crt.cal Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.cal

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/cal/package-use.html b/docs/software/amazon/awssdk/crt/cal/package-use.html new file mode 100644 index 000000000..e127ce77e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/cal/package-use.html @@ -0,0 +1,195 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.cal (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.cal

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/CRC32.html b/docs/software/amazon/awssdk/crt/checksums/CRC32.html new file mode 100644 index 000000000..a11841b1c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/CRC32.html @@ -0,0 +1,435 @@ + + + + + +CRC32 (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.checksums
    +

    Class CRC32

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Cloneable, Checksum
      +
      +
      +
      public class CRC32
+extends Object
+implements Checksum, Cloneable
      +
      CRT implementation of the Java Checksum interface for making CRC32 checksum calculations
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CRC32() +
        Default constructor
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Objectclone() 
        longgetValue() +
        Returns the current checksum value.
        +
        voidreset() +
        Resets the checksum to its initial value.
        +
        voidupdate​(byte[] b) +
        Updates the current checksum with the specified array of bytes.
        +
        voidupdate​(byte[] b, + int off, + int len) +
        Updates the current checksum with the specified array of bytes.
        +
        voidupdate​(int b) +
        Updates the current checksum with the specified byte.
        +
        + +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CRC32

          +
          public CRC32()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clone

          +
          public Object clone()
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public long getValue()
          +
          Returns the current checksum value.
          +
          +
          Specified by:
          +
          getValue in interface Checksum
          +
          Returns:
          +
          the current checksum value.
          +
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          Resets the checksum to its initial value.
          +
          +
          Specified by:
          +
          reset in interface Checksum
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(byte[] b,
+                   int off,
+                   int len)
          +
          Updates the current checksum with the specified array of bytes.
          +
          +
          Specified by:
          +
          update in interface Checksum
          +
          Parameters:
          +
          b - the byte array to update the checksum with
          +
          off - the starting offset within b of the data to use
          +
          len - the number of bytes to use in the update
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(byte[] b)
          +
          Updates the current checksum with the specified array of bytes.
          +
          +
          Parameters:
          +
          b - the byte array to update the checksum with
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(int b)
          +
          Updates the current checksum with the specified byte.
          +
          +
          Specified by:
          +
          update in interface Checksum
          +
          Parameters:
          +
          b - the byte to update the checksum with
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/CRC32C.html b/docs/software/amazon/awssdk/crt/checksums/CRC32C.html new file mode 100644 index 000000000..3971965d5 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/CRC32C.html @@ -0,0 +1,423 @@ + + + + + +CRC32C (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.checksums
    +

    Class CRC32C

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Cloneable, Checksum
      +
      +
      +
      public class CRC32C
+extends Object
+implements Checksum, Cloneable
      +
      CRT implementation of the Java Checksum interface for making Crc32c checksum calculations
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CRC32C

          +
          public CRC32C()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clone

          +
          public Object clone()
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public long getValue()
          +
          Returns the current checksum value.
          +
          +
          Specified by:
          +
          getValue in interface Checksum
          +
          Returns:
          +
          the current checksum value.
          +
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          Resets the checksum to its initial value.
          +
          +
          Specified by:
          +
          reset in interface Checksum
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(byte[] b,
+                   int off,
+                   int len)
          +
          Updates the current checksum with the specified array of bytes.
          +
          +
          Specified by:
          +
          update in interface Checksum
          +
          Parameters:
          +
          b - the byte array to update the checksum with
          +
          off - the starting offset within b of the data to use
          +
          len - the number of bytes to use in the update
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(byte[] b)
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(int b)
          +
          +
          Specified by:
          +
          update in interface Checksum
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/CRC64NVME.html b/docs/software/amazon/awssdk/crt/checksums/CRC64NVME.html new file mode 100644 index 000000000..5c3867653 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/CRC64NVME.html @@ -0,0 +1,435 @@ + + + + + +CRC64NVME (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.checksums
    +

    Class CRC64NVME

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Cloneable, Checksum
      +
      +
      +
      public class CRC64NVME
+extends Object
+implements Checksum, Cloneable
      +
      CRT implementation of the Java Checksum interface for making CRC64NVME checksum calculations
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CRC64NVME() +
        Default constructor
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Objectclone() 
        longgetValue() +
        Returns the current checksum value.
        +
        voidreset() +
        Resets the checksum to its initial value.
        +
        voidupdate​(byte[] b) +
        Updates the current checksum with the specified array of bytes.
        +
        voidupdate​(byte[] b, + int off, + int len) +
        Updates the current checksum with the specified array of bytes.
        +
        voidupdate​(int b) +
        Updates the current checksum with the specified byte.
        +
        + +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CRC64NVME

          +
          public CRC64NVME()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          clone

          +
          public Object clone()
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public long getValue()
          +
          Returns the current checksum value.
          +
          +
          Specified by:
          +
          getValue in interface Checksum
          +
          Returns:
          +
          the current checksum value.
          +
          +
          • +
        + + + +
          +
        • +

          reset

          +
          public void reset()
          +
          Resets the checksum to its initial value.
          +
          +
          Specified by:
          +
          reset in interface Checksum
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(byte[] b,
+                   int off,
+                   int len)
          +
          Updates the current checksum with the specified array of bytes.
          +
          +
          Specified by:
          +
          update in interface Checksum
          +
          Parameters:
          +
          b - the byte array to update the checksum with
          +
          off - the starting offset within b of the data to use
          +
          len - the number of bytes to use in the update
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(byte[] b)
          +
          Updates the current checksum with the specified array of bytes.
          +
          +
          Parameters:
          +
          b - the byte array to update the checksum with
          +
          +
          • +
        + + + +
          +
        • +

          update

          +
          public void update​(int b)
          +
          Updates the current checksum with the specified byte.
          +
          +
          Specified by:
          +
          update in interface Checksum
          +
          Parameters:
          +
          b - the byte to update the checksum with
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/class-use/CRC32.html b/docs/software/amazon/awssdk/crt/checksums/class-use/CRC32.html new file mode 100644 index 000000000..d86860191 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/class-use/CRC32.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.checksums.CRC32 (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.checksums.CRC32

    +
    +
    No usage of software.amazon.awssdk.crt.checksums.CRC32
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/class-use/CRC32C.html b/docs/software/amazon/awssdk/crt/checksums/class-use/CRC32C.html new file mode 100644 index 000000000..88bdaf77c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/class-use/CRC32C.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.checksums.CRC32C (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.checksums.CRC32C

    +
    +
    No usage of software.amazon.awssdk.crt.checksums.CRC32C
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/class-use/CRC64NVME.html b/docs/software/amazon/awssdk/crt/checksums/class-use/CRC64NVME.html new file mode 100644 index 000000000..90334bcb6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/class-use/CRC64NVME.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.checksums.CRC64NVME (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.checksums.CRC64NVME

    +
    +
    No usage of software.amazon.awssdk.crt.checksums.CRC64NVME
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/package-summary.html b/docs/software/amazon/awssdk/crt/checksums/package-summary.html new file mode 100644 index 000000000..1dc5ea941 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/package-summary.html @@ -0,0 +1,183 @@ + + + + + +software.amazon.awssdk.crt.checksums (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.checksums

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CRC32 +
      CRT implementation of the Java Checksum interface for making CRC32 checksum calculations
      +
      CRC32C +
      CRT implementation of the Java Checksum interface for making Crc32c checksum calculations
      +
      CRC64NVME +
      CRT implementation of the Java Checksum interface for making CRC64NVME checksum calculations
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/package-tree.html b/docs/software/amazon/awssdk/crt/checksums/package-tree.html new file mode 100644 index 000000000..343a34fbd --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/package-tree.html @@ -0,0 +1,168 @@ + + + + + +software.amazon.awssdk.crt.checksums Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.checksums

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/checksums/package-use.html b/docs/software/amazon/awssdk/crt/checksums/package-use.html new file mode 100644 index 000000000..7563879b9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/checksums/package-use.html @@ -0,0 +1,151 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.checksums (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.checksums

    +
    +
    No usage of software.amazon.awssdk.crt.checksums
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/AsyncCallback.html b/docs/software/amazon/awssdk/crt/class-use/AsyncCallback.html new file mode 100644 index 000000000..314bafd8f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/AsyncCallback.html @@ -0,0 +1,196 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.AsyncCallback (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.AsyncCallback

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/CRT.UnknownPlatformException.html b/docs/software/amazon/awssdk/crt/class-use/CRT.UnknownPlatformException.html new file mode 100644 index 000000000..108cc51a9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/CRT.UnknownPlatformException.html @@ -0,0 +1,200 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.CRT.UnknownPlatformException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.CRT.UnknownPlatformException

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/CRT.html b/docs/software/amazon/awssdk/crt/class-use/CRT.html new file mode 100644 index 000000000..275fc6372 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/CRT.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.CRT (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.CRT

    +
    +
    No usage of software.amazon.awssdk.crt.CRT
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/CrtPlatform.html b/docs/software/amazon/awssdk/crt/class-use/CrtPlatform.html new file mode 100644 index 000000000..2d56f50af --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/CrtPlatform.html @@ -0,0 +1,195 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.CrtPlatform (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.CrtPlatform

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/CrtResource.ResourceInstance.html b/docs/software/amazon/awssdk/crt/class-use/CrtResource.ResourceInstance.html new file mode 100644 index 000000000..522782a05 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/CrtResource.ResourceInstance.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.CrtResource.ResourceInstance (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.CrtResource.ResourceInstance

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/CrtResource.html b/docs/software/amazon/awssdk/crt/class-use/CrtResource.html new file mode 100644 index 000000000..8e7d3e840 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/CrtResource.html @@ -0,0 +1,751 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.CrtResource (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.CrtResource

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/CrtRuntimeException.html b/docs/software/amazon/awssdk/crt/class-use/CrtRuntimeException.html new file mode 100644 index 000000000..4279b7b52 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/CrtRuntimeException.html @@ -0,0 +1,416 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.CrtRuntimeException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.CrtRuntimeException

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/Log.LogLevel.html b/docs/software/amazon/awssdk/crt/class-use/Log.LogLevel.html new file mode 100644 index 000000000..70f03726e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/Log.LogLevel.html @@ -0,0 +1,251 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.Log.LogLevel (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.Log.LogLevel

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/Log.LogSubject.html b/docs/software/amazon/awssdk/crt/class-use/Log.LogSubject.html new file mode 100644 index 000000000..685382b08 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/Log.LogSubject.html @@ -0,0 +1,224 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.Log.LogSubject (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.Log.LogSubject

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/Log.html b/docs/software/amazon/awssdk/crt/class-use/Log.html new file mode 100644 index 000000000..0a149fa29 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/Log.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.Log (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.Log

    +
    +
    No usage of software.amazon.awssdk.crt.Log
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/Process.html b/docs/software/amazon/awssdk/crt/class-use/Process.html new file mode 100644 index 000000000..435fbf0f7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/Process.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.Process (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.Process

    +
    +
    No usage of software.amazon.awssdk.crt.Process
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/SystemInfo.CpuInfo.html b/docs/software/amazon/awssdk/crt/class-use/SystemInfo.CpuInfo.html new file mode 100644 index 000000000..6938d908a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/SystemInfo.CpuInfo.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.SystemInfo.CpuInfo (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.SystemInfo.CpuInfo

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/class-use/SystemInfo.html b/docs/software/amazon/awssdk/crt/class-use/SystemInfo.html new file mode 100644 index 000000000..e0d0ac156 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/class-use/SystemInfo.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.SystemInfo (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.SystemInfo

    +
    +
    No usage of software.amazon.awssdk.crt.SystemInfo
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ClientConnection.html b/docs/software/amazon/awssdk/crt/eventstream/ClientConnection.html new file mode 100644 index 000000000..0f0109830 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ClientConnection.html @@ -0,0 +1,477 @@ + + + + + +ClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ClientConnection

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ClientConnection
+extends CrtResource
      +
      Wrapper around an event stream rpc client initiated connection.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          closeConnection

          +
          public void closeConnection​(int shutdownErrorCode)
          +
          Closes the connection if it hasn't been closed already.
          +
          +
          Parameters:
          +
          shutdownErrorCode - aws-c-* error code to shutdown with. Specify 0 for success.
          +
          +
          • +
        + + + +
          +
        • +

          isOpen

          +
          public boolean isOpen()
          +
          +
          Returns:
          +
          true if the connection is open, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          sendProtocolMessage

          +
          public CompletableFuture<Void> sendProtocolMessage​(List<Header> headers,
+                                                   byte[] payload,
+                                                   MessageType messageType,
+                                                   int messageFlags)
          +
          Sends a protocol message on the connection. Returns a completable future for synchronizing on the message + flushing to the underlying transport.
          +
          +
          Parameters:
          +
          headers - List of event-stream headers. Can be null.
          +
          payload - Payload to send for the message. Can be null.
          +
          messageType - Message type for the rpc message.
          +
          messageFlags - Union of message flags from MessageFlags.getByteValue()
          +
          Returns:
          +
          completable future for synchronizing on the message flushing to the underlying transport.
          +
          +
          • +
        + + + +
          +
        • +

          sendProtocolMessage

          +
          public void sendProtocolMessage​(List<Header> headers,
+                                byte[] payload,
+                                MessageType messageType,
+                                int messageFlags,
+                                MessageFlushCallback callback)
          +
          Sends a protocol message on the connection. Callback will be invoked upon the message flushing to the underlying + transport
          +
          +
          Parameters:
          +
          headers - List of event-stream headers. Can be null.
          +
          payload - Payload to send for the message. Can be null.
          +
          messageType - Message type for the rpc message.
          +
          messageFlags - Union of message flags from MessageFlags.getByteValue()
          +
          callback - will be invoked upon the message flushing to the underlying transport
          +
          +
          • +
        + + + +
          +
        • +

          newStream

          +
          public ClientConnectionContinuation newStream​(ClientConnectionContinuationHandler continuationHandler)
          +
          Create a new stream. Activate() must be called on the stream for it to actually initiate the new stream.
          +
          +
          Parameters:
          +
          continuationHandler - handler to process continuation messages and state changes.
          +
          Returns:
          +
          The new continuation object.
          +
          +
          • +
        + + + +
          +
        • +

          connect

          +
          public static CompletableFuture<Void> connect​(String hostName,
+                                              int port,
+                                              SocketOptions socketOptions,
+                                              ClientTlsContext tlsContext,
+                                              ClientBootstrap bootstrap,
+                                              ClientConnectionHandler connectionHandler)
          +
          Initiates a new outgoing event-stream-rpc connection. The future will be completed once the connection either + succeeds or fails.
          +
          +
          Parameters:
          +
          hostName - hostname to connect to, this can be an IPv4 address, IPv6 address, a local socket address, or a + dns name.
          +
          port - port to connect to hostName with. For local socket address, this value is ignored. + For 32bit values exceeding Integer.MAX_VALUE use two's complement (i.e. -1 == 0xFFFFFFFF).
          +
          socketOptions - socketOptions to use.
          +
          tlsContext - (optional) tls context to use for using SSL/TLS in the connection.
          +
          bootstrap - clientBootstrap object to run the connection on.
          +
          connectionHandler - handler to process connection messages and state changes.
          +
          Returns:
          +
          The future will be completed once the connection either succeeds or fails.
          +
          +
          • +
        + + + +
          +
        • +

          getClosedFuture

          +
          public CompletableFuture<Integer> getClosedFuture()
          +
          +
          Returns:
          +
          a future for syncing on Connection closed.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionContinuation.html b/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionContinuation.html new file mode 100644 index 000000000..80a1d7346 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionContinuation.html @@ -0,0 +1,428 @@ + + + + + +ClientConnectionContinuation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ClientConnectionContinuation

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ClientConnectionContinuation
+extends CrtResource
      +
      Java wrapper for event-stream-rpc client continuation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          activate

          +
          public void activate​(String operationName,
+                     List<Header> headers,
+                     byte[] payload,
+                     MessageType messageType,
+                     int messageFlags,
+                     MessageFlushCallback callback)
          +
          Initiates a new client stream. Sends new message for the new stream.
          +
          +
          Parameters:
          +
          operationName - name for the operation to be invoked by the peer endpoint.
          +
          headers - headers for the event-stream message, may be null or empty.
          +
          payload - payload for the event-stream message, may be null or empty.
          +
          messageType - messageType for the message. Must be ApplicationMessage or ApplicationError
          +
          messageFlags - union of flags for MessageFlags.getByteValue()
          +
          callback - callback to be invoked upon the message being flushed to the underlying transport.
          +
          +
          • +
        + + + +
          +
        • +

          activate

          +
          public CompletableFuture<Void> activate​(String operationName,
+                                        List<Header> headers,
+                                        byte[] payload,
+                                        MessageType messageType,
+                                        int messageFlags)
          +
          Sends the initial message on a continuation, and begins the message flow for a stream.
          +
          +
          Parameters:
          +
          operationName - name of the operation to invoke on the server.
          +
          headers - list of additional event stream headers to include on the message.
          +
          payload - payload for the message
          +
          messageType - message type. Must be either ApplicationMessage or ApplicationError
          +
          messageFlags - message flags for the message.
          +
          Returns:
          +
          Completeable future for syncing with the connection completing or failing.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage​(List<Header> headers,
+                        byte[] payload,
+                        MessageType messageType,
+                        int messageFlags,
+                        MessageFlushCallback callback)
          +
          Sends message on the continuation
          +
          +
          Parameters:
          +
          headers - list of additional event stream headers to include on the message.
          +
          payload - payload for the message
          +
          messageType - message type. Must be either ApplicationMessage or ApplicationError
          +
          messageFlags - message flags for the message, use TerminateStream to cause this message + to close the continuation after sending.
          +
          callback - completion callback to be invoked when the message is synced to the underlying + transport.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public CompletableFuture<Void> sendMessage​(List<Header> headers,
+                                           byte[] payload,
+                                           MessageType messageType,
+                                           int messageFlags)
          +
          Sends message on the continuation
          +
          +
          Parameters:
          +
          headers - list of additional event stream headers to include on the message.
          +
          payload - payload for the message
          +
          messageType - message type. Must be either ApplicationMessage or ApplicationError
          +
          messageFlags - message flags for the message, use TerminateStream to cause this message + to close the continuation after sending.
          +
          Returns:
          +
          Future for syncing when the message is flushed to the transport or fails.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionContinuationHandler.html b/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionContinuationHandler.html new file mode 100644 index 000000000..190e47ae5 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionContinuationHandler.html @@ -0,0 +1,338 @@ + + + + + +ClientConnectionContinuationHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ClientConnectionContinuationHandler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.eventstream.ClientConnectionContinuationHandler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public abstract class ClientConnectionContinuationHandler
+extends Object
+implements AutoCloseable
      +
      Handler interface for responding to continuation events. It's auto closable. + By default, onContinuationClosed() releases the underlying resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientConnectionContinuationHandler

          +
          public ClientConnectionContinuationHandler()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getContinuationClosedFuture

          +
          public CompletableFuture<Void> getContinuationClosedFuture()
          +
          +
          Returns:
          +
          a future that will be completed upon the continuation being closed.
          +
          +
          • +
        + + + +
          +
        • +

          close

          +
          public void close()
          +
          +
          Specified by:
          +
          close in interface AutoCloseable
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionHandler.html b/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionHandler.html new file mode 100644 index 000000000..a5f63294a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ClientConnectionHandler.html @@ -0,0 +1,338 @@ + + + + + +ClientConnectionHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ClientConnectionHandler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.eventstream.ClientConnectionHandler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public abstract class ClientConnectionHandler
+extends Object
+implements AutoCloseable
      +
      Handler for EventStream ClientConnections. It's marked AutoClosable. + By default onConnectionClosed, calls the close() function on this object.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientConnectionHandler

          +
          public ClientConnectionHandler()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConnectionClosedFuture

          +
          public CompletableFuture<Integer> getConnectionClosedFuture()
          +
          +
          Returns:
          +
          a future for syncing on Connection closed.
          +
          +
          • +
        + + + +
          +
        • +

          close

          +
          public void close()
          +
          +
          Specified by:
          +
          close in interface AutoCloseable
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/Header.html b/docs/software/amazon/awssdk/crt/eventstream/Header.html new file mode 100644 index 000000000..a12371cef --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/Header.html @@ -0,0 +1,843 @@ + + + + + +Header (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class Header

    +
    +
    + +
    +
      +
    • +
      +
      public class Header
+extends Object
      +
      Event-stream header. This object can be represented in many types, so before + using + the getValueAs*() functions, check the value of getHeaderType() and then + decide + which getValueAs*() function to call based on the returned type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  boolean value)
          +
          Create a header with name of boolean value
          +
          +
          Parameters:
          +
          name - name for the header.
          +
          value - value for the header.
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  byte value)
          +
          Create a header with name of byte or int8 value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  String value)
          +
          Create a header with name of String value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  short value)
          +
          Create a header with name of short or int16 value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  int value)
          +
          Create a header with name of int or int32 value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  long value)
          +
          Create a header with name of long or int64 value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  Date value)
          +
          Create a header with name of Date (assumed to be UTC) value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  byte[] value)
          +
          Create a header with name of byte[] value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          createHeader

          +
          public static Header createHeader​(String name,
+                                  UUID value)
          +
          Create a header with name of UUID value
          +
          +
          Parameters:
          +
          name - name for the header
          +
          value - value for the header
          +
          Returns:
          +
          new Header instance
          +
          +
          • +
        + + + +
          +
        • +

          fromByteBuffer

          +
          public static Header fromByteBuffer​(ByteBuffer buffer)
          +
          Marshals buffer into a Header instance
          +
          +
          Parameters:
          +
          buffer - buffer to read the header data from
          +
          Returns:
          +
          New instance of Header
          +
          +
          • +
        + + + +
          +
        • +

          writeToByteBuffer

          +
          public void writeToByteBuffer​(ByteBuffer buffer)
          +
          Writes the value of this header into a buffer, using the wire representation + of + the header.
          +
          +
          Parameters:
          +
          buffer - buffer to write this header into
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public String getName()
          +
          Gets the name of the header as a (UTF-8) string
          +
          +
          Returns:
          +
          utf-8 encoded string for the header name
          +
          +
          • +
        + + + +
          +
        • +

          getHeaderType

          +
          public HeaderType getHeaderType()
          +
          Gets the header type of the value.
          +
          +
          Returns:
          +
          HeaderType for this header
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsBoolean

          +
          public boolean getValueAsBoolean()
          +
          Gets the value as a boolean. This assumes you've already checked + getHeaderType() + returns BooleanTrue or BooleanFalse
          +
          +
          Returns:
          +
          the value as a boolean
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsByte

          +
          public byte getValueAsByte()
          +
          Gets the value as a byte or int8. This assumes you've already checked + getHeaderType() + returns Byte
          +
          +
          Returns:
          +
          the value as a byte
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsShort

          +
          public short getValueAsShort()
          +
          Gets the value as a short or int16. This assumes you've already checked + getHeaderType() + returns Int16
          +
          +
          Returns:
          +
          the value as a short
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsInt

          +
          public int getValueAsInt()
          +
          Gets the value as an int or int32. This assumes you've already checked + getHeaderType() + returns Int32
          +
          +
          Returns:
          +
          the value as a int
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsLong

          +
          public long getValueAsLong()
          +
          Gets the value as a long or int64. This assumes you've already checked + getHeaderType() + returns Int64
          +
          +
          Returns:
          +
          the value as a long
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsTimestamp

          +
          public Date getValueAsTimestamp()
          +
          Gets the value as a Date. This assumes you've already checked getHeaderType() + returns TimeStamp
          +
          +
          Returns:
          +
          the value as a Date
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsBytes

          +
          public byte[] getValueAsBytes()
          +
          Gets the value as a byte[]. This assumes you've already checked + getHeaderType() + returns ByteBuf
          +
          +
          Returns:
          +
          the value as a byte[]
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsString

          +
          public String getValueAsString()
          +
          Gets the value as a utf-8 encoded string. + This assumes you've already checked getHeaderType() + returns String
          +
          +
          Returns:
          +
          the value as a utf-8 encoded string
          +
          +
          • +
        + + + +
          +
        • +

          getValueAsUUID

          +
          public UUID getValueAsUUID()
          +
          Gets the value as a UUID. This assumes you've already checked getHeaderType() + returns UUID
          +
          +
          Returns:
          +
          the value as a UUID
          +
          +
          • +
        + + + +
          +
        • +

          getTotalByteLength

          +
          public int getTotalByteLength()
          +
          +
          Returns:
          +
          the total binary wire representation length of this header.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(Object o)
          +
          +
          Overrides:
          +
          equals in class Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/HeaderType.html b/docs/software/amazon/awssdk/crt/eventstream/HeaderType.html new file mode 100644 index 000000000..2d4bd938d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/HeaderType.html @@ -0,0 +1,564 @@ + + + + + +HeaderType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Enum HeaderType

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable, Comparable<HeaderType>
      +
      +
      +
      public enum HeaderType
+extends Enum<HeaderType>
      +
      Java mirror of the native aws_event_stream_header_value_type enum, specifying properties of + the type of a header's value
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HeaderType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HeaderType c : HeaderType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HeaderType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getWireBytesOverhead

          +
          public int getWireBytesOverhead()
          +
          +
          Returns:
          +
          additional bytes needed to serialize the header's value, beyond the value's data itself
          +
          +
          • +
        + + + +
          +
        • +

          getEnumIntValue

          +
          public int getEnumIntValue()
          +
          +
          Returns:
          +
          the native integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          isVariableLength

          +
          public boolean isVariableLength()
          +
          +
          Returns:
          +
          true if encoding this type requires a variable number of bytes, false if a fixed number of bytes
          +
          +
          • +
        + + + +
          +
        • +

          getValueFromInt

          +
          public static HeaderType getValueFromInt​(int intValue)
          +
          Creates a Java header type enum from an associated native integer value
          +
          +
          Parameters:
          +
          intValue - native integer value
          +
          Returns:
          +
          a new Java header type value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/Message.html b/docs/software/amazon/awssdk/crt/eventstream/Message.html new file mode 100644 index 000000000..7a6e7210c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/Message.html @@ -0,0 +1,362 @@ + + + + + +Message (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class Message

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class Message
+extends CrtResource
      +
      Wrapper around an instance of aws-event-stream-message. It's auto closable, so be sure + to call close when finished with the object.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Message

          +
          public Message​(List<Header> headers,
+               byte[] payload)
          +
          Creates a message using headers and payload.
          +
          +
          Parameters:
          +
          headers - list of headers to include in the message's header block. Can be null.
          +
          payload - payload body to include in the message's payload block. Can be null.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMessageBuffer

          +
          public ByteBuffer getMessageBuffer()
          +
          Get the binary format of this message (i.e. for sending across the wire manually)
          +
          +
          Returns:
          +
          ByteBuffer wrapping the underlying message data. This buffer is only valid + as long as the message itself is valid.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/MessageFlags.html b/docs/software/amazon/awssdk/crt/eventstream/MessageFlags.html new file mode 100644 index 000000000..d82a77fa0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/MessageFlags.html @@ -0,0 +1,400 @@ + + + + + +MessageFlags (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Enum MessageFlags

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          ConnectionAccepted

          +
          public static final MessageFlags ConnectionAccepted
          +
          • +
        + + + +
          +
        • +

          TerminateStream

          +
          public static final MessageFlags TerminateStream
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static MessageFlags[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (MessageFlags c : MessageFlags.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static MessageFlags valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getByteValue

          +
          public int getByteValue()
          +
          +
          Returns:
          +
          the native enum value associated with this Java enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/MessageFlushCallback.html b/docs/software/amazon/awssdk/crt/eventstream/MessageFlushCallback.html new file mode 100644 index 000000000..a54e475f3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/MessageFlushCallback.html @@ -0,0 +1,262 @@ + + + + + +MessageFlushCallback (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Interface MessageFlushCallback

    +
    +
    +
    +
      +
    • +
      +
      public interface MessageFlushCallback
      +
      Functor interface for receiving message flush events.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onCallbackInvoked

          +
          void onCallbackInvoked​(int errorCode)
          +
          Invoked when a message has been flushed to the underlying transport mechanism.
          +
          +
          Parameters:
          +
          errorCode - If this is 0, the message was successfully written. Otherwise, + errorCode represents the reason the message flush failed.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/MessageType.html b/docs/software/amazon/awssdk/crt/eventstream/MessageType.html new file mode 100644 index 000000000..50197c096 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/MessageType.html @@ -0,0 +1,501 @@ + + + + + +MessageType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Enum MessageType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          ApplicationMessage

          +
          public static final MessageType ApplicationMessage
          +
          • +
        + + + +
          +
        • +

          ApplicationError

          +
          public static final MessageType ApplicationError
          +
          • +
        + + + + + + + +
          +
        • +

          PingResponse

          +
          public static final MessageType PingResponse
          +
          • +
        + + + +
          +
        • +

          Connect

          +
          public static final MessageType Connect
          +
          • +
        + + + +
          +
        • +

          ConnectAck

          +
          public static final MessageType ConnectAck
          +
          • +
        + + + +
          +
        • +

          ProtocolError

          +
          public static final MessageType ProtocolError
          +
          • +
        + + + +
          +
        • +

          ServerError

          +
          public static final MessageType ServerError
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static MessageType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (MessageType c : MessageType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static MessageType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValue

          +
          public byte getEnumValue()
          +
          +
          Returns:
          +
          the native enum value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          fromEnumValue

          +
          public static MessageType fromEnumValue​(int enumValue)
          +
          Create a MessageType enum value from a native enum value
          +
          +
          Parameters:
          +
          enumValue - native enum value
          +
          Returns:
          +
          a new MessageType enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/OperationRoutingServerConnectionHandler.html b/docs/software/amazon/awssdk/crt/eventstream/OperationRoutingServerConnectionHandler.html new file mode 100644 index 000000000..f5056c338 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/OperationRoutingServerConnectionHandler.html @@ -0,0 +1,299 @@ + + + + + +OperationRoutingServerConnectionHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class OperationRoutingServerConnectionHandler

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class OperationRoutingServerConnectionHandler
+extends ServerConnectionHandler
      +
      ServerConnectionHandler implementation that routes continuations to specific + operation specific message handlers
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ServerConnection.html b/docs/software/amazon/awssdk/crt/eventstream/ServerConnection.html new file mode 100644 index 000000000..054aa074e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ServerConnection.html @@ -0,0 +1,415 @@ + + + + + +ServerConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ServerConnection

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ServerConnection
+extends CrtResource
      +
      Wrapper around event-stream-rpc-server-connection. Note this class is AutoClosable. + By default the ServerConnectionHandler::onClosed callback calls close().
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isConnectionOpen

          +
          public boolean isConnectionOpen()
          +
          +
          Returns:
          +
          true if the connection is open. False otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          closeConnection

          +
          public void closeConnection​(int shutdownError)
          +
          Closes the connection with shutdownError
          +
          +
          Parameters:
          +
          shutdownError - error code to shutdown the connection with. If + shutting down cleanly, use 0.
          +
          +
          • +
        + + + +
          +
        • +

          sendProtocolMessage

          +
          public CompletableFuture<Void> sendProtocolMessage​(List<Header> headers,
+                                                   byte[] payload,
+                                                   MessageType messageType,
+                                                   int messageFlags)
          +
          Sends a protocol message on the connection. Returns a completable future for synchronizing on the message + flushing to the underlying transport.
          +
          +
          Parameters:
          +
          headers - List of event-stream headers. Can be null.
          +
          payload - Payload to send for the message. Can be null.
          +
          messageType - Message type for the rpc message.
          +
          messageFlags - Union of message flags from MessageFlags.getByteValue()
          +
          Returns:
          +
          completable future for synchronizing on the message flushing to the underlying transport.
          +
          +
          • +
        + + + +
          +
        • +

          sendProtocolMessage

          +
          public void sendProtocolMessage​(List<Header> headers,
+                                byte[] payload,
+                                MessageType messageType,
+                                int messageFlags,
+                                MessageFlushCallback callback)
          +
          Sends a protocol message on the connection. Returns a completable future for synchronizing on the message + flushing to the underlying transport.
          +
          +
          Parameters:
          +
          headers - List of event-stream headers. Can be null.
          +
          payload - Payload to send for the message. Can be null.
          +
          messageType - Message type for the rpc message.
          +
          messageFlags - Union of message flags from MessageFlags.getByteValue()
          +
          callback - invoked upon the message flushing to the underlying transport.
          +
          +
          • +
        + + + +
          +
        • +

          getClosedFuture

          +
          public CompletableFuture<Integer> getClosedFuture()
          +
          +
          Returns:
          +
          a future which completes upon the connection closing
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionContinuation.html b/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionContinuation.html new file mode 100644 index 000000000..8e705d9ad --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionContinuation.html @@ -0,0 +1,377 @@ + + + + + +ServerConnectionContinuation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ServerConnectionContinuation

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ServerConnectionContinuation
+extends CrtResource
      +
      Wrapper around aws-event-stream-rpc-server continuation. This class is marked AutoClosable. + Note that by default ServerConnectionContinuationHandler will invoke close() in + ServerConnectionContinuationHandler::onContinuationClosed().
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isClosed

          +
          public boolean isClosed()
          +
          +
          Returns:
          +
          true if the continuation has been closed. False otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public CompletableFuture<Void> sendMessage​(List<Header> headers,
+                                           byte[] payload,
+                                           MessageType messageType,
+                                           int messageFlags)
          +
          Sends message on the continuation
          +
          +
          Parameters:
          +
          headers - list of additional event stream headers to include on the message.
          +
          payload - payload for the message
          +
          messageType - message type. Must be either ApplicationMessage or ApplicationError
          +
          messageFlags - message flags for the message, use TerminateStream to cause this message + to close the continuation after sending.
          +
          Returns:
          +
          Future for syncing when the message is flushed to the transport or fails.
          +
          +
          • +
        + + + +
          +
        • +

          sendMessage

          +
          public void sendMessage​(List<Header> headers,
+                        byte[] payload,
+                        MessageType messageType,
+                        int messageFlags,
+                        MessageFlushCallback callback)
          +
          Sends message on the continuation
          +
          +
          Parameters:
          +
          headers - list of additional event stream headers to include on the message.
          +
          payload - payload for the message
          +
          messageType - message type. Must be either ApplicationMessage or ApplicationError
          +
          messageFlags - message flags for the message, use TerminateStream to cause this message + to close the continuation after sending.
          +
          callback - completion callback to be invoked when the message is synced to the underlying + transport.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionContinuationHandler.html b/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionContinuationHandler.html new file mode 100644 index 000000000..318085b92 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionContinuationHandler.html @@ -0,0 +1,298 @@ + + + + + +ServerConnectionContinuationHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ServerConnectionContinuationHandler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.eventstream.ServerConnectionContinuationHandler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public abstract class ServerConnectionContinuationHandler
+extends Object
+implements AutoCloseable
      +
      Handler interface for responding to continuation events. It's auto closable. + By default, onContinuationClosed() releases the underlying resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getContinuationClosedFuture

          +
          public CompletableFuture<Void> getContinuationClosedFuture()
          +
          +
          Returns:
          +
          a future that will be completed upon the continuation being closed.
          +
          +
          • +
        + + + +
          +
        • +

          close

          +
          public void close()
          +
          +
          Specified by:
          +
          close in interface AutoCloseable
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionHandler.html b/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionHandler.html new file mode 100644 index 000000000..f48e6a1eb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ServerConnectionHandler.html @@ -0,0 +1,284 @@ + + + + + +ServerConnectionHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ServerConnectionHandler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.eventstream.ServerConnectionHandler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      Direct Known Subclasses:
      +
      OperationRoutingServerConnectionHandler
      +
      +
      +
      public abstract class ServerConnectionHandler
+extends Object
+implements AutoCloseable
      +
      Handler for EventStream ServerConnections. It's marked AutoClosable. + By default onConnectionClosed, calls the close() function on this object.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ServerListener.html b/docs/software/amazon/awssdk/crt/eventstream/ServerListener.html new file mode 100644 index 000000000..8fbe68f6f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ServerListener.html @@ -0,0 +1,393 @@ + + + + + +ServerListener (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ServerListener

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ServerListener
+extends CrtResource
      +
      Event-stream-rpc server listener. Once it begins listening, it will provide + new connections as they arrive.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServerListener

          +
          public ServerListener​(String hostName,
+                      int port,
+                      SocketOptions socketOptions,
+                      ServerTlsContext tlsContext,
+                      ServerBootstrap serverBootstrap,
+                      ServerListenerHandler handler)
          +
          Instantiates a server listener. Once this function completes, the server is configured + and listening for new connections.
          +
          +
          Parameters:
          +
          hostName - name of the host to listen on. Can be a dns name, ip address, or unix + domain socket (or named pipe on windows) name.
          +
          port - port to listen on. Ignored for local domain sockets. + For 32bit values exceeding Integer.MAX_VALUE use two's complement (i.e. -1 == 0xFFFFFFFF).
          +
          socketOptions - socket options to apply to the listening socket.
          +
          tlsContext - optional tls context to apply to the connection if you want to use TLS.
          +
          serverBootstrap - bootstrap object for handling connections.
          +
          handler - functor interface for handling incoming connections and connection closures.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getBoundPort

          +
          public int getBoundPort()
          +
          +
          Returns:
          +
          the port which the listener socket is bound to. + Note that two's complement is used for 32bit values exceeding + Integer.MAX_VALUE (i.e. -1 == 0xFFFFFFFF).
          +
          +
          • +
        + + + +
          +
        • +

          getShutdownCompleteFuture

          +
          public CompletableFuture<Void> getShutdownCompleteFuture()
          +
          +
          Returns:
          +
          future to synchronize shutdown completion of this object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/ServerListenerHandler.html b/docs/software/amazon/awssdk/crt/eventstream/ServerListenerHandler.html new file mode 100644 index 000000000..0f890562d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/ServerListenerHandler.html @@ -0,0 +1,272 @@ + + + + + +ServerListenerHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.eventstream
    +

    Class ServerListenerHandler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.eventstream.ServerListenerHandler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public abstract class ServerListenerHandler
+extends Object
      +
      Handler interface for processing incoming event-stream-rpc connections and their lifetimes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServerListenerHandler

          +
          public ServerListenerHandler()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnection.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnection.html new file mode 100644 index 000000000..5dbfa5c2a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnection.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ClientConnection

    +
    +
    No usage of software.amazon.awssdk.crt.eventstream.ClientConnection
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionContinuation.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionContinuation.html new file mode 100644 index 000000000..f1528291b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionContinuation.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ClientConnectionContinuation

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionContinuationHandler.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionContinuationHandler.html new file mode 100644 index 000000000..a13719439 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionContinuationHandler.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ClientConnectionContinuationHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ClientConnectionContinuationHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionHandler.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionHandler.html new file mode 100644 index 000000000..08072e202 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ClientConnectionHandler.html @@ -0,0 +1,202 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ClientConnectionHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ClientConnectionHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/Header.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/Header.html new file mode 100644 index 000000000..b27da4467 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/Header.html @@ -0,0 +1,402 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.Header (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.Header

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/HeaderType.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/HeaderType.html new file mode 100644 index 000000000..1cbda353b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/HeaderType.html @@ -0,0 +1,219 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.HeaderType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.HeaderType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/Message.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/Message.html new file mode 100644 index 000000000..5c19a2be3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/Message.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.Message (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.Message

    +
    +
    No usage of software.amazon.awssdk.crt.eventstream.Message
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageFlags.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageFlags.html new file mode 100644 index 000000000..14d30b896 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageFlags.html @@ -0,0 +1,205 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.MessageFlags (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.MessageFlags

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageFlushCallback.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageFlushCallback.html new file mode 100644 index 000000000..90b2625f1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageFlushCallback.html @@ -0,0 +1,246 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.eventstream.MessageFlushCallback (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.eventstream.MessageFlushCallback

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageType.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageType.html new file mode 100644 index 000000000..cf56b666b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/MessageType.html @@ -0,0 +1,329 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.MessageType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.MessageType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/OperationRoutingServerConnectionHandler.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/OperationRoutingServerConnectionHandler.html new file mode 100644 index 000000000..230d97493 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/OperationRoutingServerConnectionHandler.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.OperationRoutingServerConnectionHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.OperationRoutingServerConnectionHandler

    +
    +
    No usage of software.amazon.awssdk.crt.eventstream.OperationRoutingServerConnectionHandler
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnection.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnection.html new file mode 100644 index 000000000..056087f63 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnection.html @@ -0,0 +1,196 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ServerConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ServerConnection

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionContinuation.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionContinuation.html new file mode 100644 index 000000000..84168ef51 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionContinuation.html @@ -0,0 +1,196 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ServerConnectionContinuation

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionContinuationHandler.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionContinuationHandler.html new file mode 100644 index 000000000..a81b8f127 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionContinuationHandler.html @@ -0,0 +1,196 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ServerConnectionContinuationHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ServerConnectionContinuationHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionHandler.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionHandler.html new file mode 100644 index 000000000..440814dbb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerConnectionHandler.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ServerConnectionHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ServerConnectionHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerListener.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerListener.html new file mode 100644 index 000000000..3d2f82ba9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerListener.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ServerListener (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ServerListener

    +
    +
    No usage of software.amazon.awssdk.crt.eventstream.ServerListener
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerListenerHandler.html b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerListenerHandler.html new file mode 100644 index 000000000..83107b6bc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/class-use/ServerListenerHandler.html @@ -0,0 +1,200 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.eventstream.ServerListenerHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.eventstream.ServerListenerHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/package-summary.html b/docs/software/amazon/awssdk/crt/eventstream/package-summary.html new file mode 100644 index 000000000..303408ad9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/package-summary.html @@ -0,0 +1,291 @@ + + + + + +software.amazon.awssdk.crt.eventstream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.eventstream

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      MessageFlushCallback +
      Functor interface for receiving message flush events.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ClientConnection +
      Wrapper around an event stream rpc client initiated connection.
      +
      ClientConnectionContinuation +
      Java wrapper for event-stream-rpc client continuation.
      +
      ClientConnectionContinuationHandler +
      Handler interface for responding to continuation events.
      +
      ClientConnectionHandler +
      Handler for EventStream ClientConnections.
      +
      Header +
      Event-stream header.
      +
      Message +
      Wrapper around an instance of aws-event-stream-message.
      +
      OperationRoutingServerConnectionHandler +
      ServerConnectionHandler implementation that routes continuations to specific + operation specific message handlers
      +
      ServerConnection +
      Wrapper around event-stream-rpc-server-connection.
      +
      ServerConnectionContinuation +
      Wrapper around aws-event-stream-rpc-server continuation.
      +
      ServerConnectionContinuationHandler +
      Handler interface for responding to continuation events.
      +
      ServerConnectionHandler +
      Handler for EventStream ServerConnections.
      +
      ServerListener +
      Event-stream-rpc server listener.
      +
      ServerListenerHandler +
      Handler interface for processing incoming event-stream-rpc connections and their lifetimes.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      HeaderType +
      Java mirror of the native aws_event_stream_header_value_type enum, specifying properties of + the type of a header's value
      +
      MessageFlags +
      Java mirror of the native aws_event_stream_rpc_message_flag enum, specifying rpc message-related flags
      +
      MessageType +
      Java mirror of the native aws_event_stream_rpc_message_type enum, specifying the type of rpc message
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/package-tree.html b/docs/software/amazon/awssdk/crt/eventstream/package-tree.html new file mode 100644 index 000000000..43cc375c4 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/package-tree.html @@ -0,0 +1,207 @@ + + + + + +software.amazon.awssdk.crt.eventstream Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.eventstream

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/eventstream/package-use.html b/docs/software/amazon/awssdk/crt/eventstream/package-use.html new file mode 100644 index 000000000..055660404 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/eventstream/package-use.html @@ -0,0 +1,261 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.eventstream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.eventstream

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2ClientConnection.Http2ErrorCode.html b/docs/software/amazon/awssdk/crt/http/Http2ClientConnection.Http2ErrorCode.html new file mode 100644 index 000000000..7ed64e44b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2ClientConnection.Http2ErrorCode.html @@ -0,0 +1,542 @@ + + + + + +Http2ClientConnection.Http2ErrorCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum Http2ClientConnection.Http2ErrorCode

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2ClientConnection.html b/docs/software/amazon/awssdk/crt/http/Http2ClientConnection.html new file mode 100644 index 000000000..2adb693bc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2ClientConnection.html @@ -0,0 +1,563 @@ + + + + + +Http2ClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2ClientConnection

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class Http2ClientConnection
+extends HttpClientConnection
      +
      This class wraps aws-c-http to provide the basic HTTP/2 request/response + functionality via the AWS Common Runtime. + + Http2ClientConnection represents a single connection to a HTTP/2 service + endpoint. + + This class is not thread safe and should not be called from different + threads.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Http2ClientConnection

          +
          public Http2ClientConnection​(long connectionBinding)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          updateSettings

          +
          public CompletableFuture<Void> updateSettings​(List<Http2ConnectionSetting> settings)
          +
          Send a SETTINGS frame. SETTINGS will be applied locally when SETTINGS ACK is + received from peer.
          +
          +
          Parameters:
          +
          settings - The array of settings to change. Note: each setting has its + boundary.
          +
          Returns:
          +
          When this future completes without exception, the peer has + acknowledged the settings and the change has been applied.
          +
          +
          • +
        + + + +
          +
        • +

          sendPing

          +
          public CompletableFuture<Long> sendPing​(byte[] pingData)
          +
          Send a PING frame. Round-trip-time is calculated when PING ACK is received + from peer.
          +
          +
          Parameters:
          +
          pingData - 8 Bytes data with the PING frame or null for not include data + in ping
          +
          Returns:
          +
          When this future completes without exception, the peer has + acknowledged the PING and future will be completed with the round + trip time in nano seconds for the connection.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          sendGoAway

          +
          public void sendGoAway​(Http2ClientConnection.Http2ErrorCode Http2ErrorCode,
+                       boolean allowMoreStreams,
+                       byte[] debugData)
          +
          Send a custom GOAWAY frame. + + Note that the connection automatically attempts to send a GOAWAY during + shutdown (unless a GOAWAY with a valid Last-Stream-ID has already been sent). + + This call can be used to gracefully warn the peer of an impending shutdown + (http2_error=0, allow_more_streams=true), or to customize the final GOAWAY + frame that is sent by this connection. + + The other end may not receive the goaway, if the connection already closed.
          +
          +
          Parameters:
          +
          Http2ErrorCode - The HTTP/2 error code (RFC-7540 section 7) to send. + `enum Http2ErrorCode` lists official codes.
          +
          allowMoreStreams - If true, new peer-initiated streams will continue to + be acknowledged and the GOAWAY's Last-Stream-ID will + be set to a max value. If false, new peer-initiated + streams will be ignored and the GOAWAY's + Last-Stream-ID will be set to the latest acknowledged + stream.
          +
          debugData - Optional debug data to send. Size must not exceed + 16KB. null is acceptable to not include debug data.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          updateConnectionWindow

          +
          public void updateConnectionWindow​(long incrementSize)
          +
          Increment the connection's flow-control window to keep data flowing. + + If the connection was created with `manualWindowManagement` set true, the + flow-control window of the connection will shrink as body data is received + for all the streams created on it. (headers, padding, and other metadata do + not affect the window). The initial connection flow-control window is 65,535. + Once the connection's flow-control window reaches to 0, all the streams on + the connection stop receiving any further data. + + If `manualWindowManagement` is false, this call will have no effect. The + connection maintains its flow-control windows such that no back-pressure is + applied and data arrives as fast as possible. + + If you are not connected, this call will have no effect. + + Crashes when the connection is not http2 connection. The limit of the Maximum + Size is 2**31 - 1. If the increment size cause the connection flow window + exceeds the Maximum size, this call will result in the connection lost.
          +
          +
          Parameters:
          +
          incrementSize - The size to increment for the connection's flow control + window
          +
          +
          • +
        + + + +
          +
        • +

          makeRequest

          +
          public Http2Stream makeRequest​(HttpRequestBase request,
+                               HttpStreamBaseResponseHandler streamHandler)
+                        throws CrtRuntimeException
          +
          Schedules an HttpRequest on the Native EventLoop for this + HttpClientConnection. The HTTP/1.1 request will be transformed to HTTP/2 + request under the hood.
          +
          +
          Overrides:
          +
          makeRequest in class HttpClientConnection
          +
          Parameters:
          +
          request - The Request to make to the Server.
          +
          streamHandler - The Stream Handler to be called from the Native + EventLoop
          +
          Returns:
          +
          The Http2Stream that represents this Request/Response Pair. It can be + closed at any time during the request/response, but must be closed by + the user thread making this request when it's done.
          +
          Throws:
          +
          CrtRuntimeException - if stream creation fails
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2ConnectionSetting.ID.html b/docs/software/amazon/awssdk/crt/http/Http2ConnectionSetting.ID.html new file mode 100644 index 000000000..c77c477d3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2ConnectionSetting.ID.html @@ -0,0 +1,452 @@ + + + + + +Http2ConnectionSetting.ID (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum Http2ConnectionSetting.ID

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Http2ConnectionSetting.ID[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Http2ConnectionSetting.ID c : Http2ConnectionSetting.ID.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Http2ConnectionSetting.ID valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2ConnectionSetting.html b/docs/software/amazon/awssdk/crt/http/Http2ConnectionSetting.html new file mode 100644 index 000000000..545ce5723 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2ConnectionSetting.html @@ -0,0 +1,380 @@ + + + + + +Http2ConnectionSetting (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2ConnectionSetting

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.Http2ConnectionSetting
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Http2ConnectionSetting
+extends Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2ConnectionSettingListBuilder.html b/docs/software/amazon/awssdk/crt/http/Http2ConnectionSettingListBuilder.html new file mode 100644 index 000000000..3d3fe102d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2ConnectionSettingListBuilder.html @@ -0,0 +1,472 @@ + + + + + +Http2ConnectionSettingListBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2ConnectionSettingListBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Http2ConnectionSettingListBuilder
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Http2ConnectionSettingListBuilder

          +
          public Http2ConnectionSettingListBuilder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          headerTableSize

          +
          public Http2ConnectionSettingListBuilder headerTableSize​(long headerTableSize)
          +
          The SETTINGS_HEADER_TABLE_SIZE. Allows the sender to inform the remote + endpoint of the maximum size of the header compression table used to decode + header blocks, in octets.
          +
          +
          Parameters:
          +
          headerTableSize - the maximum size of the header compression table used + (in octets)
          +
          Returns:
          +
          Http2ConnectionSettingListBuilder
          +
          +
          • +
        + + + + + + + +
          +
        • +

          maxConcurrentStreams

          +
          public Http2ConnectionSettingListBuilder maxConcurrentStreams​(long maxConcurrentStreams)
          +
          The SETTINGS_MAX_CONCURRENT_STREAMS. Indicates the maximum number of + concurrent streams that the sender will allow.
          +
          +
          Parameters:
          +
          maxConcurrentStreams - The maximum number of concurrent streams
          +
          Returns:
          +
          Http2ConnectionSettingListBuilder
          +
          +
          • +
        + + + +
          +
        • +

          initialWindowSize

          +
          public Http2ConnectionSettingListBuilder initialWindowSize​(long initialWindowSize)
          +
          The SETTINGS_INITIAL_WINDOW_SIZE. Indicates the sender's initial window size + (in octets) for stream-level flow control. The initial value is 2^16-1 + (65,535) octets.
          +
          +
          Parameters:
          +
          initialWindowSize - initial window size (in octets)
          +
          Returns:
          +
          Http2ConnectionSettingListBuilder
          +
          +
          • +
        + + + +
          +
        • +

          maxFrameSize

          +
          public Http2ConnectionSettingListBuilder maxFrameSize​(long maxFrameSize)
          +
          The SETTINGS_MAX_FRAME_SIZE. Indicates the size of the largest frame payload + that the sender is willing to receive, in octets.
          +
          +
          Parameters:
          +
          maxFrameSize - the size of the largest frame payload (in octets)
          +
          Returns:
          +
          Http2ConnectionSettingListBuilder
          +
          +
          • +
        + + + +
          +
        • +

          maxHeaderListSize

          +
          public Http2ConnectionSettingListBuilder maxHeaderListSize​(long maxHeaderListSize)
          +
          The SETTINGS_MAX_HEADER_LIST_SIZE. This advisory setting informs a peer of + the maximum size of header list that the sender is prepared to accept, in + octets. The value is based on the uncompressed size of header fields, + including the length of the name and value in octets plus an overhead of 32 + octets for each header field.
          +
          +
          Parameters:
          +
          maxHeaderListSize - the maximum size of header list (in octets)
          +
          Returns:
          +
          Http2ConnectionSettingListBuilder
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2Request.html b/docs/software/amazon/awssdk/crt/http/Http2Request.html new file mode 100644 index 000000000..d5fc29202 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2Request.html @@ -0,0 +1,312 @@ + + + + + +Http2Request (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2Request

    +
    +
    + +
    +
      +
    • +
      +
      public class Http2Request
+extends HttpRequestBase
      +
      Represents a single Client Request to be sent on a HTTP connection
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Http2Request

          +
          public Http2Request()
          +
          An empty HTTP/2 Request.
          +
          • +
        + + + +
          +
        • +

          Http2Request

          +
          public Http2Request​(HttpHeader[] headers,
+                    HttpRequestBodyStream bodyStream)
          +
          An empty HTTP/2 Request with headers and body stream.
          +
          +
          Parameters:
          +
          headers - set of http request headers to include, note: pseudo + headers should be set to make a good HTTP/2 request.
          +
          bodyStream - (optional) interface to an object that will stream out the + request body
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2Stream.html b/docs/software/amazon/awssdk/crt/http/Http2Stream.html new file mode 100644 index 000000000..f9d6820fd --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2Stream.html @@ -0,0 +1,323 @@ + + + + + +Http2Stream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2Stream

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class Http2Stream
+extends HttpStreamBase
      +
      An HttpStream represents a single HTTP/2 specific Http Request/Response.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          resetStream

          +
          public void resetStream​(Http2ClientConnection.Http2ErrorCode errorCode)
          +
          Reset the HTTP/2 stream. Note that if the stream closes before this async + call is fully processed, the RST_STREAM frame will not be sent.
          +
          +
          Parameters:
          +
          errorCode - aws_http2_error_code. Reason to reset the stream.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2StreamManager.html b/docs/software/amazon/awssdk/crt/http/Http2StreamManager.html new file mode 100644 index 000000000..3e5fb4352 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2StreamManager.html @@ -0,0 +1,407 @@ + + + + + +Http2StreamManager (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2StreamManager

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class Http2StreamManager
+extends CrtResource
      +
      Manages a Pool of HTTP/2 Streams. Creates and manages HTTP/2 connections + under the hood.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static Http2StreamManager create​(Http2StreamManagerOptions options)
          +
          Factory function for Http2StreamManager instances
          +
          +
          Parameters:
          +
          options - configuration options
          +
          Returns:
          +
          a new instance of an Http2StreamManager
          +
          +
          • +
        + + + +
          +
        • +

          acquireStream

          +
          public CompletableFuture<Http2Stream> acquireStream​(Http2Request request,
+                                                    HttpStreamBaseResponseHandler streamHandler)
          +
          Request a Http2Stream from StreamManager.
          +
          +
          Parameters:
          +
          request - The Request to make to the Server.
          +
          streamHandler - The Stream Handler to be called from the Native + EventLoop
          +
          Returns:
          +
          A future for a Http2Stream that will be completed when the stream is + acquired.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getMaxConnections

          +
          public int getMaxConnections()
          +
          +
          Returns:
          +
          maximum number of connections this connection manager will pool
          +
          +
          • +
        + + + +
          +
        • +

          getManagerMetrics

          +
          public HttpManagerMetrics getManagerMetrics()
          +
          +
          Returns:
          +
          concurrency metrics for the current manager
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/Http2StreamManagerOptions.html b/docs/software/amazon/awssdk/crt/http/Http2StreamManagerOptions.html new file mode 100644 index 000000000..c5f4313c9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/Http2StreamManagerOptions.html @@ -0,0 +1,822 @@ + + + + + +Http2StreamManagerOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class Http2StreamManagerOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.Http2StreamManagerOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Http2StreamManagerOptions
+extends Object
      +
      Contains all the configuration options for a Http2StreamManager + instance
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          DEFAULT_MAX_WINDOW_SIZE

          +
          public static final int DEFAULT_MAX_WINDOW_SIZE
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + + + + + +
          +
        • +

          DEFAULT_MAX_CONNECTIONS

          +
          public static final int DEFAULT_MAX_CONNECTIONS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          DEFAULT_CONNECTION_PING_TIMEOUT_MS

          +
          public static final int DEFAULT_CONNECTION_PING_TIMEOUT_MS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Http2StreamManagerOptions

          +
          public Http2StreamManagerOptions()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withInitialSettingsList

          +
          public Http2StreamManagerOptions withInitialSettingsList​(List<Http2ConnectionSetting> initialSettingsList)
          +
          For HTTP/2 stream manager only. + + The initial settings for the HTTP/2 connections made by stream manger. + `Http2ConnectionSettingListBuilder` can help to build the settings list. + + To control the initial stream-level flow-control window, set the + INITIAL_WINDOW_SIZE setting in the initial settings.
          +
          +
          Parameters:
          +
          initialSettingsList - The List of initial settings
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getInitialSettingsList

          +
          public List<Http2ConnectionSetting> getInitialSettingsList()
          +
          +
          Returns:
          +
          The List of initial settings
          +
          +
          • +
        + + + +
          +
        • +

          withIdealConcurrentStreamsPerConnection

          +
          public Http2StreamManagerOptions withIdealConcurrentStreamsPerConnection​(int idealConcurrentStreamsPerConnection)
          +
          For HTTP/2 stream manager only. + + The ideal number of concurrent streams for a connection. Stream manager will + try to create a new connection if one connection reaches this number. But, if + the max connections reaches, manager will reuse connections to create the + acquired steams as much as possible.
          +
          +
          Parameters:
          +
          idealConcurrentStreamsPerConnection - The ideal number of concurrent + streams for a connection
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getIdealConcurrentStreamsPerConnection

          +
          public int getIdealConcurrentStreamsPerConnection()
          +
          +
          Returns:
          +
          The ideal number of concurrent streams for a connection used for + manager
          +
          +
          • +
        + + + +
          +
        • +

          withMaxConcurrentStreamsPerConnection

          +
          public Http2StreamManagerOptions withMaxConcurrentStreamsPerConnection​(int maxConcurrentStreamsPerConnection)
          +
          Default is no limit, which will use the limit from the server. 0 will be + considered as using the default value. + The real number of concurrent streams per connection will be controlled by + the minimal value of the setting from other end and the value here.
          +
          +
          Parameters:
          +
          maxConcurrentStreamsPerConnection - The max number of concurrent + streams for a connection
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getMaxConcurrentStreamsPerConnection

          +
          public int getMaxConcurrentStreamsPerConnection()
          +
          +
          Returns:
          +
          The max number of concurrent streams for a connection set for + manager. + It could be different than the real limits, which is the minimal set + for manager and the settings from the other side.
          +
          +
          • +
        + + + +
          +
        • +

          isConnectionManualWindowManagement

          +
          public boolean isConnectionManualWindowManagement()
          +
          +
          Returns:
          +
          The connection level manual flow control enabled or not.
          +
          +
          • +
        + + + +
          +
        • +

          withConnectionManualWindowManagement

          +
          public Http2StreamManagerOptions withConnectionManualWindowManagement​(boolean connectionManualWindowManagement)
          +
          Set to true to manually manage the flow-control window of whole HTTP/2 + connection. + The stream level flow-control window is controlled by the + manualWindowManagement in connectionManagerOptions.
          +
          +
          Parameters:
          +
          connectionManualWindowManagement - Enable connection level manual flow + control or not.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionManagerOptions

          +
          public HttpClientConnectionManagerOptions getConnectionManagerOptions()
          +
          +
          Returns:
          +
          The connection manager options for the underlying connection manager.
          +
          +
          • +
        + + + +
          +
        • +

          withConnectionManagerOptions

          +
          public Http2StreamManagerOptions withConnectionManagerOptions​(HttpClientConnectionManagerOptions connectionManagerOptions)
          +
          Required. + + The configuration options for the connection manager under the hood. + It controls the connection specific thing for the stream manager. See + `HttpClientConnectionManagerOptions` for details. + + Note: + 1. the windowSize of connection manager will be ignored, as the initial + flow-control window size for HTTP/2 stream + is controlled by the initial settings. + 2. The expectedHttpVersion will also be ignored.
          +
          +
          Parameters:
          +
          connectionManagerOptions - The connection manager options for the + underlying connection manager
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          hasPriorKnowledge

          +
          public boolean hasPriorKnowledge()
          +
          +
          Returns:
          +
          Prior knowledge is used or not
          +
          +
          • +
        + + + +
          +
        • +

          withPriorKnowledge

          +
          public Http2StreamManagerOptions withPriorKnowledge​(boolean priorKnowledge)
          +
          Set to true to use prior knowledge to setup connection. + If any TLS was set, exception will be raised if prior knowledge is set during + validation. + If NO TLS was set, exception will be raised if prior knowledge is NOT set + during validation.
          +
          +
          Parameters:
          +
          priorKnowledge - Prior knowledge used or not.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          shouldCloseConnectionOnServerError

          +
          public boolean shouldCloseConnectionOnServerError()
          +
          +
          Returns:
          +
          Connection closed or not when server error happened (500/502/503/504 + response status code received).
          +
          +
          • +
        + + + +
          +
        • +

          withCloseConnectionOnServerError

          +
          public Http2StreamManagerOptions withCloseConnectionOnServerError​(boolean closeConnectionOnServerError)
          +
          Set to true to inform stream manager to close connection when response with + 500/502/503/504 received. + Stream manager will stop using the connection with server error will start a + new connection for other streams.
          +
          +
          Parameters:
          +
          closeConnectionOnServerError - Connection closed or not when server + error happened.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withConnectionPing

          +
          public Http2StreamManagerOptions withConnectionPing​(int periodMs,
+                                                    int timeoutMs)
          +
          Settings to control the period ping to be sent for connections held by stream + manager.
          +
          +
          Parameters:
          +
          periodMs - The period for all the connections held by stream manager to + send a PING in milliseconds. If you specify 0, manager will + NOT send any PING.
          +
          timeoutMs - Network connection will be closed if a ping response is not + received within this amount of time (milliseconds). If you + specify 0, a default value will be used. If this is larger + than periodMs, it will be capped to be equal.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionPingPeriodMs

          +
          public int getConnectionPingPeriodMs()
          +
          +
          Returns:
          +
          The period for all the connections held by stream manager to send a + PING in milliseconds.
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionPingTimeoutMs

          +
          public int getConnectionPingTimeoutMs()
          +
          +
          Returns:
          +
          The time for closing connection if ping not received within this + amount of time in milliseconds
          +
          +
          • +
        + + + +
          +
        • +

          validateOptions

          +
          public void validateOptions()
          +
          Validate the stream manager options are valid to use. Throw exceptions if + not.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpClientConnection.html b/docs/software/amazon/awssdk/crt/http/HttpClientConnection.html new file mode 100644 index 000000000..b3b102959 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpClientConnection.html @@ -0,0 +1,441 @@ + + + + + +HttpClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpClientConnection

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      Direct Known Subclasses:
      +
      Http2ClientConnection
      +
      +
      +
      public class HttpClientConnection
+extends CrtResource
      +
      This class wraps aws-c-http to provide the basic HTTP request/response functionality via the AWS Common Runtime. + + HttpClientConnection represents a single connection to a HTTP service endpoint. + + This class is not thread safe and should not be called from different threads.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          makeRequest

          +
          public HttpStream makeRequest​(HttpRequest request,
+                              HttpStreamResponseHandler streamHandler)
+                       throws CrtRuntimeException
          +
          Schedules an HttpRequest on the Native EventLoop for this HttpClientConnection specific to HTTP/1.1 connection.
          +
          +
          Parameters:
          +
          request - The Request to make to the Server.
          +
          streamHandler - The Stream Handler to be called from the Native EventLoop
          +
          Returns:
          +
          The HttpStream that represents this Request/Response Pair. It can be closed at any time during the + request/response, but must be closed by the user thread making this request when it's done.
          +
          Throws:
          +
          CrtRuntimeException - if stream creation fails
          +
          +
          • +
        + + + +
          +
        • +

          makeRequest

          +
          public HttpStreamBase makeRequest​(HttpRequestBase request,
+                                  HttpStreamBaseResponseHandler streamHandler)
+                           throws CrtRuntimeException
          +
          Schedules an HttpRequestBase on the Native EventLoop for this HttpClientConnection applies to both HTTP/2 and HTTP/1.1 connection.
          +
          +
          Parameters:
          +
          request - The Request to make to the Server.
          +
          streamHandler - The Stream Handler to be called from the Native EventLoop
          +
          Returns:
          +
          The HttpStream that represents this Request/Response Pair. It can be closed at any time during the + request/response, but must be closed by the user thread making this request when it's done.
          +
          Throws:
          +
          CrtRuntimeException - if stream creation fails
          +
          +
          • +
        + + + +
          +
        • +

          shutdown

          +
          public void shutdown()
          +
          Shuts down the underlying http connection. Even if this function is called, you still need to properly close + the connection as well in order to release the native resources.
          +
          • +
        + + + +
          +
        • +

          isOpen

          +
          public boolean isOpen()
          +
          Check the underlying http connection is still open or not.
          +
          +
          Returns:
          +
          true unless the underlying http connection is shutting down, or has been shutdown.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          isErrorRetryable

          +
          public static boolean isErrorRetryable​(HttpException exception)
          +
          Certain exceptions thrown by this HTTP API are from invalid boundary conditions + that, if the request isn't altered, will never succeed. This function returns + false if the exception is caused by such a condition. +

          + It does not mean the request that generated the error SHOULD be retried: + only that as far as this client is concerned, the request might, + possibly succeed with a subsequent attempt.

          +
          +
          Parameters:
          +
          exception - , an exception thrown by the CRT HTTP API--for any reason.
          +
          Returns:
          +
          true if the error that generated the exception makes sense for a retry, and + false otherwise.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpClientConnectionManager.html b/docs/software/amazon/awssdk/crt/http/HttpClientConnectionManager.html new file mode 100644 index 000000000..41f41458b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpClientConnectionManager.html @@ -0,0 +1,440 @@ + + + + + +HttpClientConnectionManager (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpClientConnectionManager

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class HttpClientConnectionManager
+extends CrtResource
      +
      Manages a Pool of Http Connections
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          acquireConnection

          +
          public CompletableFuture<HttpClientConnection> acquireConnection()
          +
          Request a HttpClientConnection from the Connection Pool.
          +
          +
          Returns:
          +
          A Future for a HttpClientConnection that will be completed when a connection is acquired.
          +
          +
          • +
        + + + +
          +
        • +

          releaseConnection

          +
          public void releaseConnection​(HttpClientConnection conn)
          +
          Releases this HttpClientConnection back into the Connection Pool, and allows another Request to acquire this connection.
          +
          +
          Parameters:
          +
          conn - Connection to release
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getMaxConnections

          +
          public int getMaxConnections()
          +
          +
          Returns:
          +
          maximum number of connections this connection manager will pool
          +
          +
          • +
        + + + +
          +
        • +

          getManagerMetrics

          +
          public HttpManagerMetrics getManagerMetrics()
          +
          +
          Returns:
          +
          concurrency metrics for the current manager
          +
          +
          • +
        + + + +
          +
        • +

          getWindowSize

          +
          public long getWindowSize()
          +
          +
          Returns:
          +
          size of the per-connection streaming read window for response handling
          +
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public URI getUri()
          +
          +
          Returns:
          +
          uri the connection manager is making connections to
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpClientConnectionManagerOptions.html b/docs/software/amazon/awssdk/crt/http/HttpClientConnectionManagerOptions.html new file mode 100644 index 000000000..44d697af6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpClientConnectionManagerOptions.html @@ -0,0 +1,1144 @@ + + + + + +HttpClientConnectionManagerOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpClientConnectionManagerOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HttpClientConnectionManagerOptions
+extends Object
      +
      Contains all the configuration options for a HttpConnectionPoolManager instance
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          DEFAULT_MAX_BUFFER_SIZE

          +
          public static final int DEFAULT_MAX_BUFFER_SIZE
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          DEFAULT_MAX_WINDOW_SIZE

          +
          public static final long DEFAULT_MAX_WINDOW_SIZE
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          DEFAULT_MAX_CONNECTIONS

          +
          public static final int DEFAULT_MAX_CONNECTIONS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpClientConnectionManagerOptions

          +
          public HttpClientConnectionManagerOptions()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withClientBootstrap

          +
          public HttpClientConnectionManagerOptions withClientBootstrap​(ClientBootstrap clientBootstrap)
          +
          Sets the client bootstrap instance to use to create the pool's connections
          +
          +
          Parameters:
          +
          clientBootstrap - ClientBootstrap to use
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getClientBootstrap

          +
          public ClientBootstrap getClientBootstrap()
          +
          Gets the client bootstrap instance to use to create the pool's connections
          +
          +
          Returns:
          +
          ClientBootstrap used by this connection manager
          +
          +
          • +
        + + + +
          +
        • +

          withSocketOptions

          +
          public HttpClientConnectionManagerOptions withSocketOptions​(SocketOptions socketOptions)
          +
          Sets the socket options to use for connections in the connection pool
          +
          +
          Parameters:
          +
          socketOptions - The socket options to use for all connections in the manager
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getSocketOptions

          +
          public SocketOptions getSocketOptions()
          +
          +
          Returns:
          +
          the socket options to use for connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          public HttpClientConnectionManagerOptions withTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context to use for connections in the connection pool
          +
          +
          Parameters:
          +
          tlsContext - The TlsContext to use
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getTlsContext

          +
          public TlsContext getTlsContext()
          +
          +
          Returns:
          +
          the tls context used by connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withTlsConnectionOptions

          +
          public HttpClientConnectionManagerOptions withTlsConnectionOptions​(TlsConnectionOptions tlsConnectionOptions)
          +
          Sets the connection-specific TLS options to use for connections in the connection pool. + Either TLS context or TLS connection options will be enough to set up TLS connection. + If both set, an exception will be raised.
          +
          +
          Parameters:
          +
          tlsConnectionOptions - The TlsConnectionOptions to use
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getTlsConnectionOptions

          +
          public TlsConnectionOptions getTlsConnectionOptions()
          +
          +
          Returns:
          +
          the tls context used by connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withWindowSize

          +
          public HttpClientConnectionManagerOptions withWindowSize​(long windowSize)
          +
          Sets the starting size of each HTTP stream's flow-control window. + This is only used when "manual window management" is enabled.
          +
          +
          Parameters:
          +
          windowSize - The initial window size for each HTTP stream
          +
          Returns:
          +
          this
          +
          See Also:
          +
          withManualWindowManagement(boolean)
          +
          +
          • +
        + + + +
          +
        • +

          getWindowSize

          +
          public long getWindowSize()
          +
          +
          Returns:
          +
          The starting size of each HTTP stream's flow-control window.
          +
          +
          • +
        + + + +
          +
        • +

          withBufferSize

          +
          public HttpClientConnectionManagerOptions withBufferSize​(int bufferSize)
          +
          Deprecated. +
          Sets the IO buffer size to use for connections in the connection pool
          +
          +
          +
          Parameters:
          +
          bufferSize - Size of I/O buffer per connection
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getBufferSize

          +
          public int getBufferSize()
          +
          Deprecated.
          +
          +
          Returns:
          +
          the IO buffer size to use for connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withUri

          +
          public HttpClientConnectionManagerOptions withUri​(URI uri)
          +
          Sets the URI to use for connections in the connection pool
          +
          +
          Parameters:
          +
          uri - The endpoint URI to connect to
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public URI getUri()
          +
          +
          Returns:
          +
          the URI to use for connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withPort

          +
          public HttpClientConnectionManagerOptions withPort​(int port)
          +
          Sets the port to connect to for connections in the connection pool. + For 32bit values exceeding Integer.MAX_VALUE use two's complement + (i.e. -1 == 0xFFFFFFFF).
          +
          +
          Parameters:
          +
          port - The port to connect to
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getPort

          +
          public int getPort()
          +
          +
          Returns:
          +
          the port to connect to for connections in the connection pool. + Returns -1 if none has been explicitly set. + Note that two's complement is used for 32bit values exceeding + Integer.MAX_VALUE (i.e. -1 == 0xFFFFFFFF).
          +
          +
          • +
        + + + +
          +
        • +

          withMaxConnections

          +
          public HttpClientConnectionManagerOptions withMaxConnections​(int maxConnections)
          +
          Sets the maximum number of connections allowed in the connection pool
          +
          +
          Parameters:
          +
          maxConnections - maximum number of connections to pool
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getMaxConnections

          +
          public int getMaxConnections()
          +
          +
          Returns:
          +
          the maximum number of connections allowed in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withProxyOptions

          +
          public HttpClientConnectionManagerOptions withProxyOptions​(HttpProxyOptions proxyOptions)
          +
          Sets the proxy options for connections in the connection pool
          +
          +
          Parameters:
          +
          proxyOptions - HttpProxyOptions for this connection manager, or null to disable proxying
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getProxyOptions

          +
          public HttpProxyOptions getProxyOptions()
          +
          +
          Returns:
          +
          the proxy options for connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          withProxyEnvironmentVariableSetting

          +
          public HttpClientConnectionManagerOptions withProxyEnvironmentVariableSetting​(HttpProxyEnvironmentVariableSetting httpProxyEnvironmentVariableSetting)
          +
          Optional. + Sets how proxy is fetched from the environment. + Reading proxy configuration from environment is disabled if this is NULL for backward compatibility. + Only works when proxyOptions is not set. The proxy settings follow the following precedence + 1. Configured Proxy Setting + 2. Environment (if enabled) + 3. No proxy
          +
          +
          Parameters:
          +
          httpProxyEnvironmentVariableSetting - for this connection manager
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getHttpProxyEnvironmentVariableSetting

          +
          public HttpProxyEnvironmentVariableSetting getHttpProxyEnvironmentVariableSetting()
          +
          +
          Returns:
          +
          the proxy environment variable setting
          +
          +
          • +
        + + + +
          +
        • +

          isManualWindowManagement

          +
          public boolean isManualWindowManagement()
          +
          +
          Returns:
          +
          true if manual window management is used, false otherwise
          +
          See Also:
          +
          withManualWindowManagement(boolean)
          +
          +
          • +
        + + + +
          +
        • +

          withManualWindowManagement

          +
          public HttpClientConnectionManagerOptions withManualWindowManagement​(boolean manualWindowManagement)
          +
          If set to true, then you must manage the read backpressure mechanism. You should + only use this if you're allowing http response body data to escape the callbacks. E.g. you're + putting the data into a queue for another thread to process and need to make sure the memory + usage is bounded (e.g. reactive streams). +

          + When enabled, each HttpStream has a flow-control window that shrinks as response body data is downloaded + (headers do not affect the window). withWindowSize(long) determines the starting size of each + HttpStream's window, in bytes. Data stops downloading whenever the window reaches zero. + Increment the window to keep data flowing by calling HttpStreamBase.incrementWindow(int), + or by returning a size from HttpStreamResponseHandler.onResponseBody(software.amazon.awssdk.crt.http.HttpStream, byte[]). + Maintain a larger window to keep up a high download throughput, + or use a smaller window to limit how much data could get buffered in memory.

          +
          +
          Parameters:
          +
          manualWindowManagement - true to enable manual window management, false to use automatic window management
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withExpectedHttpVersion

          +
          public HttpClientConnectionManagerOptions withExpectedHttpVersion​(HttpVersion expectedHttpVersion)
          +
          Set the expected protocol version of the connection to be made, default is HTTP/1.1
          +
          +
          Parameters:
          +
          expectedHttpVersion - The expected protocol version of the connection made
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getExpectedHttpVersion

          +
          public HttpVersion getExpectedHttpVersion()
          +
          +
          Returns:
          +
          Return the expected HTTP protocol version.
          +
          +
          • +
        + + + +
          +
        • +

          withMaxConnectionIdleInMilliseconds

          +
          public HttpClientConnectionManagerOptions withMaxConnectionIdleInMilliseconds​(long maxConnectionIdleInMilliseconds)
          +
          Sets maximum amount of time, in milliseconds, that the connection can be idle in the manager before + getting culled by the manager
          +
          +
          Parameters:
          +
          maxConnectionIdleInMilliseconds - How long to allow connections to be idle before reaping them
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionAcquisitionTimeoutInMilliseconds

          +
          public long getConnectionAcquisitionTimeoutInMilliseconds()
          +
          +
          Returns:
          +
          Return the connection acquisition timeout in miliseconds
          +
          +
          • +
        + + + +
          +
        • +

          withConnectionAcquisitionTimeoutInMilliseconds

          +
          public HttpClientConnectionManagerOptions withConnectionAcquisitionTimeoutInMilliseconds​(int connectionAcquisitionTimeoutInMilliseconds)
          +
          If set, HttpClientConnectionManager.acquireConnection() + will give up after waiting this long for a connection from the pool, + failing with error AWS_ERROR_HTTP_CONNECTION_MANAGER_ACQUISITION_TIMEOUT.
          +
          +
          Parameters:
          +
          connectionAcquisitionTimeoutInMilliseconds - timeout in milliseconds.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getMaxPendingConnectionAcquisitions

          +
          public long getMaxPendingConnectionAcquisitions()
          +
          +
          Returns:
          +
          Return the max pending connection acquisitions
          +
          +
          • +
        + + + +
          +
        • +

          withMaxPendingConnectionAcquisitions

          +
          public HttpClientConnectionManagerOptions withMaxPendingConnectionAcquisitions​(int maxPendingConnectionAcquisitions)
          +
          If set, HttpClientConnectionManager.acquireConnection() will fail with + AWS_ERROR_HTTP_CONNECTION_MANAGER_MAX_PENDING_ACQUISITIONS_EXCEEDED if there are already pending acquisitions + equal to `maxPendingConnectionAcquisitions`.
          +
          +
          Parameters:
          +
          maxPendingConnectionAcquisitions - maximum pending acquisitions allowed
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getMaxConnectionIdleInMilliseconds

          +
          public long getMaxConnectionIdleInMilliseconds()
          +
          +
          Returns:
          +
          How long to allow connections to be idle before reaping them
          +
          +
          • +
        + + + +
          +
        • +

          withMonitoringOptions

          +
          public HttpClientConnectionManagerOptions withMonitoringOptions​(HttpMonitoringOptions monitoringOptions)
          +
          Sets the monitoring options for connections in the connection pool
          +
          +
          Parameters:
          +
          monitoringOptions - Monitoring options for this connection manager, or null to disable monitoring
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getMonitoringOptions

          +
          public HttpMonitoringOptions getMonitoringOptions()
          +
          +
          Returns:
          +
          the monitoring options for connections in the connection pool
          +
          +
          • +
        + + + +
          +
        • +

          validateOptions

          +
          public void validateOptions()
          +
          Validate the connection manager options are valid to use. Throw exceptions if not.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpException.html b/docs/software/amazon/awssdk/crt/http/HttpException.html new file mode 100644 index 000000000..456837629 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpException.html @@ -0,0 +1,356 @@ + + + + + +HttpException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable
      +
      +
      +
      public class HttpException
+extends RuntimeException
      +
      This exception will be thrown by any exceptional cases encountered within the + JNI bindings to the AWS Common Runtime
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpException

          +
          public HttpException​(int errorCode)
          +
          Constructs a new HttpException
          +
          +
          Parameters:
          +
          errorCode - native error code representing the error source/reason
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getErrorCode

          +
          public int getErrorCode()
          +
          Returns the error code captured when the exception occurred. This can be fed to CRT.awsErrorString() to + get a user-friendly error string
          +
          +
          Returns:
          +
          The error code associated with this exception
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpHeader.html b/docs/software/amazon/awssdk/crt/http/HttpHeader.html new file mode 100644 index 000000000..0be411f38 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpHeader.html @@ -0,0 +1,489 @@ + + + + + +HttpHeader (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpHeader

    +
    +
    + +
    +
      +
    • +
      +
      public class HttpHeader
+extends Object
      +
      A wrapper class for http header key-value pairs
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpHeader

          +
          public HttpHeader​(String name,
+                  String value)
          +
          +
          Parameters:
          +
          name - header name
          +
          value - header value
          +
          +
          • +
        + + + +
          +
        • +

          HttpHeader

          +
          public HttpHeader​(byte[] name,
+                  byte[] value)
          +
          +
          Parameters:
          +
          name - header name
          +
          value - header value
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public String getName()
          +
          +
          Returns:
          +
          the name of the header, converted to a UTF-8 string
          +
          +
          • +
        + + + +
          +
        • +

          getNameBytes

          +
          public byte[] getNameBytes()
          +
          +
          Returns:
          +
          the name of the header, in raw bytes
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public String getValue()
          +
          +
          Returns:
          +
          the value of the header, converted to a UTF-8 string
          +
          +
          • +
        + + + +
          +
        • +

          getValueBytes

          +
          public byte[] getValueBytes()
          +
          +
          Returns:
          +
          the value of the header, in raw bytes
          +
          +
          • +
        + + + + + + + +
          +
        • +

          loadHeadersListFromMarshalledHeadersBlob

          +
          public static List<HttpHeader> loadHeadersListFromMarshalledHeadersBlob​(ByteBuffer headersBlob)
          +
          Each header is marshalled as + [4-bytes BE name length] [variable length name value] [4-bytes BE value length] [variable length value value]
          +
          +
          Parameters:
          +
          headersBlob - Blob of encoded headers
          +
          Returns:
          +
          array of decoded headers
          +
          +
          • +
        + + + +
          +
        • +

          marshalHeadersForJni

          +
          public static byte[] marshalHeadersForJni​(List<HttpHeader> headers)
          +
          Lists of headers are marshalled as follows: + + each string field is: [4-bytes BE] [variable length bytes specified by the + previous field]
          +
          +
          Parameters:
          +
          headers - List of header name-value pairs
          +
          Returns:
          +
          encoded blob of headers
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpHeaderBlock.html b/docs/software/amazon/awssdk/crt/http/HttpHeaderBlock.html new file mode 100644 index 000000000..1e79fcf90 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpHeaderBlock.html @@ -0,0 +1,413 @@ + + + + + +HttpHeaderBlock (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum HttpHeaderBlock

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpHeaderBlock[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpHeaderBlock c : HttpHeaderBlock.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpHeaderBlock valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          the native enum value associated with this Java enum value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpManagerMetrics.html b/docs/software/amazon/awssdk/crt/http/HttpManagerMetrics.html new file mode 100644 index 000000000..26a01e96e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpManagerMetrics.html @@ -0,0 +1,315 @@ + + + + + +HttpManagerMetrics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpManagerMetrics

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.HttpManagerMetrics
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HttpManagerMetrics
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAvailableConcurrency

          +
          public long getAvailableConcurrency()
          +
          +
          Returns:
          +
          The number of additional concurrent requests that can be supported by the HTTP manager without needing to + establish additional connections to the target server. +

          + For connection manager, this value represents idle connections. + For stream manager, this value represents the number of streams that are possible to be made without creating new + connections, although the implementation can create new connection without fully filling it.

          +
          +
          • +
        + + + +
          +
        • +

          getPendingConcurrencyAcquires

          +
          public long getPendingConcurrencyAcquires()
          +
          +
          Returns:
          +
          The number of requests that are awaiting concurrency to be made available from the HTTP manager.
          +
          +
          • +
        + + + +
          +
        • +

          getLeasedConcurrency

          +
          public long getLeasedConcurrency()
          +
          +
          Returns:
          +
          the amount of concurrency units currently out for lease. For http 1.1 this will be connections while + for http2 this will be number of streams leased out.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpMonitoringOptions.html b/docs/software/amazon/awssdk/crt/http/HttpMonitoringOptions.html new file mode 100644 index 000000000..aba896a30 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpMonitoringOptions.html @@ -0,0 +1,387 @@ + + + + + +HttpMonitoringOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpMonitoringOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.HttpMonitoringOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HttpMonitoringOptions
+extends Object
      +
      This class provides access to basic http connection monitoring controls in lieu of the more traditional + timeouts. + + The user can set a throughput threshold (in bytes per second) for the a connection to be considered healthy. If + the connection falls below this threshold for a configurable amount of time, then the connection is considered + unhealthy and shut down. Throughput/health is only measured when the connection has work (read or write) that + needs to be done.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpMonitoringOptions

          +
          public HttpMonitoringOptions()
          +
          Creates a new set of monitoring options
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setMinThroughputBytesPerSecond

          +
          public void setMinThroughputBytesPerSecond​(long minThroughputBytesPerSecond)
          +
          Sets a throughput threshold for connections. Throughput below this value will be considered unhealthy.
          +
          +
          Parameters:
          +
          minThroughputBytesPerSecond - minimum amount of throughput, in bytes per second, for a connection to be + considered healthy.
          +
          +
          • +
        + + + +
          +
        • +

          getMinThroughputBytesPerSecond

          +
          public long getMinThroughputBytesPerSecond()
          +
          +
          Returns:
          +
          minimum amount of throughput, in bytes per second, for a connection to be considered healthy.
          +
          +
          • +
        + + + +
          +
        • +

          setAllowableThroughputFailureIntervalSeconds

          +
          public void setAllowableThroughputFailureIntervalSeconds​(int allowableThroughputFailureIntervalSeconds)
          +
          Sets how long, in seconds, a connection is allowed to be unhealthy before getting shut down. Must be at + least two.
          +
          +
          Parameters:
          +
          allowableThroughputFailureIntervalSeconds - How long, in seconds, a connection is allowed to be unhealthy + before getting shut down.
          +
          +
          • +
        + + + +
          +
        • +

          getAllowableThroughputFailureIntervalSeconds

          +
          public int getAllowableThroughputFailureIntervalSeconds()
          +
          +
          Returns:
          +
          How long, in seconds, a connection is allowed to be unhealthy before getting shut down. Must be at + least two.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.html b/docs/software/amazon/awssdk/crt/http/HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.html new file mode 100644 index 000000000..7ed429a75 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.html @@ -0,0 +1,410 @@ + + + + + +HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType c : HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpProxyEnvironmentVariableSetting.html b/docs/software/amazon/awssdk/crt/http/HttpProxyEnvironmentVariableSetting.html new file mode 100644 index 000000000..e922a4999 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpProxyEnvironmentVariableSetting.html @@ -0,0 +1,448 @@ + + + + + +HttpProxyEnvironmentVariableSetting (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpProxyEnvironmentVariableSetting

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class HttpProxyEnvironmentVariableSetting
+extends Object
      +
      This class provides access to Http proxy environment variable configuration + setting
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpProxyEnvironmentVariableSetting

          +
          public HttpProxyEnvironmentVariableSetting()
          +
          Creates a new set of environment variable proxy setting + By Default environmentVariableType is set to Enable.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setConnectionType

          +
          public void setConnectionType​(HttpProxyOptions.HttpProxyConnectionType connectionType)
          +
          (Optional) + Sets the proxy connection type. Defaults to HttpProxyConnectionType.Legacy
          +
          +
          Parameters:
          +
          connectionType - what kind of connection to establish
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setEnvironmentVariableType

          +
          public void setEnvironmentVariableType​(HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType environmentVariableType)
          +
          (Optional) + Enable/Disable reading from environment variable for Proxy config. Defaults to Enabled
          +
          +
          Parameters:
          +
          environmentVariableType - enable or disable env proxy
          +
          +
          • +
        + + + +
          +
        • +

          setTlsConnectionOptions

          +
          public void setTlsConnectionOptions​(TlsConnectionOptions tlsConnectionOptions)
          +
          (Optional) + Sets the tls connection options for the proxy connection
          +
          +
          Parameters:
          +
          tlsConnectionOptions - tls connection options for the proxy connection
          +
          +
          • +
        + + + +
          +
        • +

          getTlsConnectionOptions

          +
          public TlsConnectionOptions getTlsConnectionOptions()
          +
          +
          Returns:
          +
          the tls connection options for the proxy connection
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.HttpProxyAuthorizationType.html b/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.HttpProxyAuthorizationType.html new file mode 100644 index 000000000..f36dfe26e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.HttpProxyAuthorizationType.html @@ -0,0 +1,406 @@ + + + + + +HttpProxyOptions.HttpProxyAuthorizationType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum HttpProxyOptions.HttpProxyAuthorizationType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpProxyOptions.HttpProxyAuthorizationType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpProxyOptions.HttpProxyAuthorizationType c : HttpProxyOptions.HttpProxyAuthorizationType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpProxyOptions.HttpProxyAuthorizationType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.HttpProxyConnectionType.html b/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.HttpProxyConnectionType.html new file mode 100644 index 000000000..c82a13a35 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.HttpProxyConnectionType.html @@ -0,0 +1,427 @@ + + + + + +HttpProxyOptions.HttpProxyConnectionType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum HttpProxyOptions.HttpProxyConnectionType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpProxyOptions.HttpProxyConnectionType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpProxyOptions.HttpProxyConnectionType c : HttpProxyOptions.HttpProxyConnectionType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpProxyOptions.HttpProxyConnectionType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.html b/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.html new file mode 100644 index 000000000..4d296ebe5 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpProxyOptions.html @@ -0,0 +1,611 @@ + + + + + +HttpProxyOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpProxyOptions

    +
    +
    + +
    +
      +
    • +
      +
      public class HttpProxyOptions
+extends Object
      +
      This class provides access to Http proxy configuration options
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpProxyOptions

          +
          public HttpProxyOptions()
          +
          Creates a new set of proxy options
          +
          +
          Throws:
          +
          CrtRuntimeException - If the system is unable to allocate space for a http proxy options instance
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setConnectionType

          +
          public void setConnectionType​(HttpProxyOptions.HttpProxyConnectionType connectionType)
          +
          Sets the proxy connection type
          +
          +
          Parameters:
          +
          connectionType - what kind of connection to establish
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setHost

          +
          public void setHost​(String host)
          +
          Sets the proxy host to connect through
          +
          +
          Parameters:
          +
          host - proxy to connect through
          +
          +
          • +
        + + + +
          +
        • +

          getHost

          +
          public String getHost()
          +
          +
          Returns:
          +
          the proxy host to connect through
          +
          +
          • +
        + + + +
          +
        • +

          setPort

          +
          public void setPort​(int port)
          +
          Sets the proxy port to connect through. + For 32bit values exceeding Integer.MAX_VALUE use two's complement (i.e. -1 == 0xFFFFFFFF).
          +
          +
          Parameters:
          +
          port - proxy port to connect through
          +
          +
          • +
        + + + +
          +
        • +

          getPort

          +
          public int getPort()
          +
          +
          Returns:
          +
          the proxy port to connect through. + Note that two's complement is used for 32bit values exceeding + Integer.MAX_VALUE (i.e. -1 == 0xFFFFFFFF).
          +
          +
          • +
        + + + +
          +
        • +

          setAuthorizationType

          +
          public void setAuthorizationType​(HttpProxyOptions.HttpProxyAuthorizationType authorizationType)
          +
          Sets the proxy authorization type
          +
          +
          Parameters:
          +
          authorizationType - what kind of authentication, if any, to use
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setAuthorizationUsername

          +
          public void setAuthorizationUsername​(String username)
          +
          Sets the username to use for authorization; only applicable to basic authentication
          +
          +
          Parameters:
          +
          username - username to use with basic authentication
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizationUsername

          +
          public String getAuthorizationUsername()
          +
          +
          Returns:
          +
          the username to use for authorization
          +
          +
          • +
        + + + +
          +
        • +

          setAuthorizationPassword

          +
          public void setAuthorizationPassword​(String password)
          +
          Sets the password to use for authorization; only applicable to basic authentication
          +
          +
          Parameters:
          +
          password - password to use with basic authentication
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizationPassword

          +
          public String getAuthorizationPassword()
          +
          +
          Returns:
          +
          the password to use for authorization
          +
          +
          • +
        + + + +
          +
        • +

          setTlsContext

          +
          public void setTlsContext​(TlsContext tlsContext)
          +
          Sets the tls context for the proxy connection
          +
          +
          Parameters:
          +
          tlsContext - tls context for the proxy connection
          +
          +
          • +
        + + + +
          +
        • +

          getTlsContext

          +
          public TlsContext getTlsContext()
          +
          +
          Returns:
          +
          the tls context for the proxy connection
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpRequest.html b/docs/software/amazon/awssdk/crt/http/HttpRequest.html new file mode 100644 index 000000000..904cd1732 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpRequest.html @@ -0,0 +1,399 @@ + + + + + +HttpRequest (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpRequest

    +
    +
    + +
    +
      +
    • +
      +
      public class HttpRequest
+extends HttpRequestBase
      +
      Represents a single Client Request to be sent on a HTTP connection
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpRequest

          +
          public HttpRequest​(String method,
+                   String encodedPath)
          +
          +
          Parameters:
          +
          method - http verb to use
          +
          encodedPath - path of the http request
          +
          +
          • +
        + + + +
          +
        • +

          HttpRequest

          +
          public HttpRequest​(String method,
+                   String encodedPath,
+                   HttpHeader[] headers,
+                   HttpRequestBodyStream bodyStream)
          +
          +
          Parameters:
          +
          method - http verb to use
          +
          encodedPath - path of the http request
          +
          headers - set of http request headers to include
          +
          bodyStream - (optional) interface to an object that will stream out the + request body
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMethod

          +
          public String getMethod()
          +
          +
          Returns:
          +
          the HTTP method of this request
          +
          +
          • +
        + + + +
          +
        • +

          getEncodedPath

          +
          public String getEncodedPath()
          +
          +
          Returns:
          +
          the encoded path of this request
          +
          +
          • +
        + + + +
          +
        • +

          setEncodedPath

          +
          public void setEncodedPath​(String encodedPath)
          +
          Sets the request's encoded path
          +
          +
          Parameters:
          +
          encodedPath - the new encoded path
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpRequestBase.html b/docs/software/amazon/awssdk/crt/http/HttpRequestBase.html new file mode 100644 index 000000000..361cb8dfe --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpRequestBase.html @@ -0,0 +1,345 @@ + + + + + +HttpRequestBase (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpRequestBase

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpRequestBodyStream.html b/docs/software/amazon/awssdk/crt/http/HttpRequestBodyStream.html new file mode 100644 index 000000000..367b8f970 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpRequestBodyStream.html @@ -0,0 +1,315 @@ + + + + + +HttpRequestBodyStream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Interface HttpRequestBodyStream

    +
    +
    +
    +
      +
    • +
      +
      public interface HttpRequestBodyStream
      +
      Interface that Native code knows how to call when handling Http Request bodies
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Default Methods 
        Modifier and TypeMethodDescription
        default longgetLength() +
        Called from native when the processing needs to know the length of the stream.
        +
        default booleanresetPosition() +
        Called from native when the processing needs the stream to rewind itself back to its beginning.
        +
        default booleansendRequestBody​(ByteBuffer bodyBytesOut) +
        Called from Native when the Http Request has a Body (Eg PUT/POST requests).
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          sendRequestBody

          +
          default boolean sendRequestBody​(ByteBuffer bodyBytesOut)
          +
          Called from Native when the Http Request has a Body (Eg PUT/POST requests). + Note that this function may be called many times as Native sends the Request Body. + + Do NOT keep a reference to this ByteBuffer past the lifetime of this function call. The CommonRuntime reserves + the right to use DirectByteBuffers pointing to memory that only lives as long as the function call.
          +
          +
          Parameters:
          +
          bodyBytesOut - The Buffer to write the Request Body Bytes to.
          +
          Returns:
          +
          True if Request body is complete, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          resetPosition

          +
          default boolean resetPosition()
          +
          Called from native when the processing needs the stream to rewind itself back to its beginning. + If the stream does not support rewinding or the rewind fails, false should be returned + + Signing requires a rewindable stream, but basic http does not.
          +
          +
          Returns:
          +
          True if the stream was successfully rewound, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getLength

          +
          default long getLength()
          +
          Called from native when the processing needs to know the length of the stream. + If the stream does not know/support length, 0 should be returned. + + Signing requires a rewindable stream, but basic http does not.
          +
          +
          Returns:
          +
          Stream length, or 0 if unknown stream or length is unsupported
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpStream.HttpStreamWriteChunkCompletionCallback.html b/docs/software/amazon/awssdk/crt/http/HttpStream.HttpStreamWriteChunkCompletionCallback.html new file mode 100644 index 000000000..81a4c7e1e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpStream.HttpStreamWriteChunkCompletionCallback.html @@ -0,0 +1,258 @@ + + + + + +HttpStream.HttpStreamWriteChunkCompletionCallback (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Interface HttpStream.HttpStreamWriteChunkCompletionCallback

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      HttpStream
      +
      +
      +
      public static interface HttpStream.HttpStreamWriteChunkCompletionCallback
      +
      Completion interface for writing chunks to an http stream
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onChunkCompleted

          +
          void onChunkCompleted​(int errorCode)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpStream.html b/docs/software/amazon/awssdk/crt/http/HttpStream.html new file mode 100644 index 000000000..252fc97df --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpStream.html @@ -0,0 +1,374 @@ + + + + + +HttpStream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpStream

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class HttpStream
+extends HttpStreamBase
      +
      An HttpStream represents a single HTTP/1.1 specific Http Request/Response.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          writeChunk

          +
          public void writeChunk​(byte[] chunkData,
+                       boolean isFinalChunk,
+                       HttpStream.HttpStreamWriteChunkCompletionCallback chunkCompletionCallback)
          +
          Use only for Http 1.1 Chunked Encoding. + You must call activate() before using this function.
          +
          +
          Parameters:
          +
          chunkData - chunk of data to send.
          +
          isFinalChunk - if set to true, this will terminate the + request stream.
          +
          chunkCompletionCallback - Invoked upon the data being flushed to the + wire or an error occurring.
          +
          +
          • +
        + + + +
          +
        • +

          writeChunk

          +
          public CompletableFuture<Void> writeChunk​(byte[] chunkData,
+                                          boolean isFinalChunk)
          +
          Use only for Http 1.1 Chunked Encoding. + You must call activate() before using this function.
          +
          +
          Parameters:
          +
          chunkData - chunk of data to send.
          +
          isFinalChunk - if set to true, this will terminate the request stream.
          +
          Returns:
          +
          completable future which will complete upon the data being flushed to + the wire or an error occurring.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpStreamBase.html b/docs/software/amazon/awssdk/crt/http/HttpStreamBase.html new file mode 100644 index 000000000..b938a726f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpStreamBase.html @@ -0,0 +1,370 @@ + + + + + +HttpStreamBase (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpStreamBase

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      Direct Known Subclasses:
      +
      Http2Stream, HttpStream
      +
      +
      +
      public class HttpStreamBase
+extends CrtResource
      +
      An base class represents a single Http Request/Response for both HTTP/1.1 and + HTTP/2 and wraps the native resources from the aws-c-http library. + + Can be used to update the Window size, or to abort the stream early in the + middle of sending/receiving Http Bodies.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          incrementWindow

          +
          public void incrementWindow​(int windowSize)
          +
          Increment the flow-control window, so that response data continues downloading. +

          + If HttpClientConnectionManagerOptions.withManualWindowManagement(boolean) was set true, + each HTTP stream has a flow-control window that shrinks as response + body data is downloaded (headers do not affect the size of the window). + HttpClientConnectionManagerOptions.withWindowSize(long) sets the starting size for each HTTP stream's window. + Whenever the window reaches zero, data stops downloading. + Increment the window to keep data flowing. + Maintain a larger window to keep up a high download throughput, + parts cannot download in parallel unless the window is large enough to hold multiple parts. + Maintain a smaller window to limit the amount of data buffered in memory. +

          + If manual window management is disabled this call has no effect.

          +
          +
          Parameters:
          +
          windowSize - How many bytes to increment the sliding window by.
          +
          See Also:
          +
          HttpClientConnectionManagerOptions.withManualWindowManagement(boolean)
          +
          +
          • +
        + + + +
          +
        • +

          activate

          +
          public void activate()
          +
          Activates the client stream.
          +
          • +
        + + + +
          +
        • +

          getResponseStatusCode

          +
          public int getResponseStatusCode()
          +
          Retrieves the Http Response Status Code
          +
          +
          Returns:
          +
          The Http Response Status Code
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpStreamBaseResponseHandler.html b/docs/software/amazon/awssdk/crt/http/HttpStreamBaseResponseHandler.html new file mode 100644 index 000000000..8160f8c5e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpStreamBaseResponseHandler.html @@ -0,0 +1,402 @@ + + + + + +HttpStreamBaseResponseHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Interface HttpStreamBaseResponseHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface HttpStreamBaseResponseHandler
      +
      Interface that Native code knows how to call when handling Http Responses + + Maps 1-1 to the Native Http API here: + https://github.com/awslabs/aws-c-http/blob/master/include/aws/http/request_response.h
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onResponseHeaders

          +
          void onResponseHeaders​(HttpStreamBase stream,
+                       int responseStatusCode,
+                       int blockType,
+                       HttpHeader[] nextHeaders)
          +
          Called from Native when new Http Headers have been received. + Note that this function may be called multiple times as HTTP headers are + received.
          +
          +
          Parameters:
          +
          stream - The HttpStreamBase object
          +
          responseStatusCode - The HTTP Response Status Code
          +
          blockType - The HTTP header block type
          +
          nextHeaders - The headers received in the latest IO event.
          +
          +
          • +
        + + + +
          +
        • +

          onResponseHeadersDone

          +
          default void onResponseHeadersDone​(HttpStreamBase stream,
+                                   int blockType)
          +
          Called from Native once all HTTP Headers are processed. Will not be called if + there are no Http Headers in the + response. Guaranteed to be called exactly once if there is at least 1 Header.
          +
          +
          Parameters:
          +
          stream - The HttpStreamBase object
          +
          blockType - The type of the header block, corresponds to + HttpHeaderBlock
          +
          +
          • +
        + + + +
          +
        • +

          onResponseBody

          +
          default int onResponseBody​(HttpStreamBase stream,
+                           byte[] bodyBytesIn)
          +
          Called when new Response Body bytes have been received. Note that this + function may be called multiple times over + the lifetime of an HttpClientConnection as bytes are received. + + Users must read all data from bodyBytesIn before returning. If + "bodyBytesIn.remaining() > 0" after this method + returns, then Native will assume there was a processing failure and abort the + connection. + + Do NOT keep a reference to this ByteBuffer past the lifetime of this function + call. The CommonRuntime reserves + the right to use DirectByteBuffers pointing to memory that only lives as long + as the function call. + + Sliding Window: + The Native HttpClientConnection EventLoop will keep sending data until the + end of the sliding Window is reached. + The user application is responsible for setting the initial Window size + appropriately when creating the + HttpClientConnection, and for incrementing the sliding window appropriately + throughout the lifetime of the HttpStream. + + For more info, see: + - https://en.wikipedia.org/wiki/Sliding_window_protocol
          +
          +
          Parameters:
          +
          stream - The HttpStreamBase the body was delivered to
          +
          bodyBytesIn - The HTTP Body Bytes received in the last IO Event.
          +
          Returns:
          +
          The number of bytes to move the sliding window by. Repeatedly + returning zero will eventually cause the + sliding window to fill up and data to stop flowing until the user + slides the window back open.
          +
          +
          • +
        + + + +
          +
        • +

          onMetrics

          +
          default void onMetrics​(HttpStreamBase stream,
+                       HttpStreamMetrics metrics)
          +
          Called right before stream is complete, whether successful or unsuccessful.
          +
          +
          Parameters:
          +
          stream - The HTTP stream to which the metrics apply
          +
          metrics - The [HttpStreamMetrics] containing metrics for the given stream
          +
          +
          • +
        + + + +
          +
        • +

          onResponseComplete

          +
          void onResponseComplete​(HttpStreamBase stream,
+                        int errorCode)
          +
          Called from Native when the Response has completed.
          +
          +
          Parameters:
          +
          stream - completed HttpStreamBase
          +
          errorCode - resultant errorCode for the response
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpStreamMetrics.html b/docs/software/amazon/awssdk/crt/http/HttpStreamMetrics.html new file mode 100644 index 000000000..30cd32a18 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpStreamMetrics.html @@ -0,0 +1,373 @@ + + + + + +HttpStreamMetrics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Class HttpStreamMetrics

    +
    +
    + +
    +
      +
    • +
      +
      public class HttpStreamMetrics
+extends Object
      +
      Holds tracing metrics for an HTTP stream. Maps to `struct aws_http_stream_metrics` in **aws-c-http**'s + **request_response.h**.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSendStartTimestampNs

          +
          public long getSendStartTimestampNs()
          +
          • +
        + + + +
          +
        • +

          getSendEndTimestampNs

          +
          public long getSendEndTimestampNs()
          +
          • +
        + + + +
          +
        • +

          getSendingDurationNs

          +
          public long getSendingDurationNs()
          +
          • +
        + + + +
          +
        • +

          getReceiveStartTimestampNs

          +
          public long getReceiveStartTimestampNs()
          +
          • +
        + + + +
          +
        • +

          getReceiveEndTimestampNs

          +
          public long getReceiveEndTimestampNs()
          +
          • +
        + + + +
          +
        • +

          getReceivingDurationNs

          +
          public long getReceivingDurationNs()
          +
          • +
        + + + +
          +
        • +

          getStreamId

          +
          public int getStreamId()
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpStreamResponseHandler.html b/docs/software/amazon/awssdk/crt/http/HttpStreamResponseHandler.html new file mode 100644 index 000000000..2cecf85f6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpStreamResponseHandler.html @@ -0,0 +1,385 @@ + + + + + +HttpStreamResponseHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Interface HttpStreamResponseHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface HttpStreamResponseHandler
      +
      Interface that Native code knows how to call when handling Http Responses for HTTP/1.1 only. + You can use HttpStreamBaseResponseHandler instead to adapt both HTTP/1.1 and HTTP/2 + + Maps 1-1 to the Native Http API here: https://github.com/awslabs/aws-c-http/blob/master/include/aws/http/request_response.h
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onResponseHeaders

          +
          void onResponseHeaders​(HttpStream stream,
+                       int responseStatusCode,
+                       int blockType,
+                       HttpHeader[] nextHeaders)
          +
          Called from Native when new Http Headers have been received. + Note that this function may be called multiple times as HTTP headers are received.
          +
          +
          Parameters:
          +
          stream - The HttpStream object
          +
          responseStatusCode - The HTTP Response Status Code
          +
          blockType - The HTTP header block type
          +
          nextHeaders - The headers received in the latest IO event.
          +
          +
          • +
        + + + +
          +
        • +

          onResponseHeadersDone

          +
          default void onResponseHeadersDone​(HttpStream stream,
+                                   int blockType)
          +
          Called from Native once all HTTP Headers are processed. Will not be called if there are no Http Headers in the + response. Guaranteed to be called exactly once if there is at least 1 Header.
          +
          +
          Parameters:
          +
          stream - The HttpStream object
          +
          blockType - The type of the header block, corresponds to HttpHeaderBlock
          +
          +
          • +
        + + + +
          +
        • +

          onResponseBody

          +
          default int onResponseBody​(HttpStream stream,
+                           byte[] bodyBytesIn)
          +
          Called when new Response Body bytes have been received. Note that this function may be called multiple times over + the lifetime of an HttpClientConnection as bytes are received. +

          + Note that if HttpClientConnectionManagerOptions.withManualWindowManagement(boolean) was set true, + you must manage the flow-control window. + The flow-control window shrinks as you receive body data via this callback. + Whenever the flow-control window reaches zero, data will stop downloading. + To keep data flowing, you must increment the window by returning a number + from this method, or by calling HttpStreamBase.incrementWindow(int).

          +
          +
          Parameters:
          +
          stream - The HTTP Stream the body was delivered to
          +
          bodyBytesIn - The HTTP Body Bytes received in the last IO Event.
          +
          Returns:
          +
          The number of bytes to increment the window by + (calling HttpStreamBase.incrementWindow(int) has the same effect). + This value is ignored if "manual window management" is disabled.
          +
          See Also:
          +
          HttpClientConnectionManagerOptions.withManualWindowManagement(boolean)
          +
          +
          • +
        + + + +
          +
        • +

          onMetrics

          +
          default void onMetrics​(HttpStream stream,
+                       HttpStreamMetrics metrics)
          +
          Called right before stream is complete, whether successful or unsuccessful.
          +
          +
          Parameters:
          +
          stream - The HTTP stream to which the metrics apply
          +
          metrics - The [HttpStreamMetrics] containing metrics for the given stream
          +
          +
          • +
        + + + +
          +
        • +

          onResponseComplete

          +
          void onResponseComplete​(HttpStream stream,
+                        int errorCode)
          +
          Called from Native when the Response has completed.
          +
          +
          Parameters:
          +
          stream - completed stream
          +
          errorCode - resultant errorCode for the response
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/HttpVersion.html b/docs/software/amazon/awssdk/crt/http/HttpVersion.html new file mode 100644 index 000000000..692b50bb7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/HttpVersion.html @@ -0,0 +1,435 @@ + + + + + +HttpVersion (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.http
    +

    Enum HttpVersion

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpVersion[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpVersion c : HttpVersion.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpVersion valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static HttpVersion getEnumValueFromInteger​(int value)
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2ClientConnection.Http2ErrorCode.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2ClientConnection.Http2ErrorCode.html new file mode 100644 index 000000000..d74fc2733 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2ClientConnection.Http2ErrorCode.html @@ -0,0 +1,237 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2ClientConnection.Http2ErrorCode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2ClientConnection.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2ClientConnection.html new file mode 100644 index 000000000..fbbe2f99d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2ClientConnection.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2ClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2ClientConnection

    +
    +
    No usage of software.amazon.awssdk.crt.http.Http2ClientConnection
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSetting.ID.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSetting.ID.html new file mode 100644 index 000000000..66c0fd2e3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSetting.ID.html @@ -0,0 +1,226 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2ConnectionSetting.ID

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSetting.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSetting.html new file mode 100644 index 000000000..5654b8791 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSetting.html @@ -0,0 +1,239 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2ConnectionSetting (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2ConnectionSetting

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSettingListBuilder.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSettingListBuilder.html new file mode 100644 index 000000000..52db103b3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2ConnectionSettingListBuilder.html @@ -0,0 +1,244 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2ConnectionSettingListBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2Request.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2Request.html new file mode 100644 index 000000000..3eee6b91e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2Request.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2Request (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2Request

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2Stream.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2Stream.html new file mode 100644 index 000000000..910256825 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2Stream.html @@ -0,0 +1,223 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2Stream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2Stream

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2StreamManager.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2StreamManager.html new file mode 100644 index 000000000..a8566fd92 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2StreamManager.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2StreamManager (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2StreamManager

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/Http2StreamManagerOptions.html b/docs/software/amazon/awssdk/crt/http/class-use/Http2StreamManagerOptions.html new file mode 100644 index 000000000..f7cd313fb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/Http2StreamManagerOptions.html @@ -0,0 +1,267 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.Http2StreamManagerOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.Http2StreamManagerOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnection.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnection.html new file mode 100644 index 000000000..00a54bc8a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnection.html @@ -0,0 +1,232 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpClientConnection

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnectionManager.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnectionManager.html new file mode 100644 index 000000000..06ca4a795 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnectionManager.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpClientConnectionManager (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpClientConnectionManager

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnectionManagerOptions.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnectionManagerOptions.html new file mode 100644 index 000000000..5cb744cd5 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpClientConnectionManagerOptions.html @@ -0,0 +1,345 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpClientConnectionManagerOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpException.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpException.html new file mode 100644 index 000000000..d3bd2bac6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpException.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpException

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpHeader.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpHeader.html new file mode 100644 index 000000000..58bcfc24f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpHeader.html @@ -0,0 +1,382 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpHeader (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpHeader

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpHeaderBlock.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpHeaderBlock.html new file mode 100644 index 000000000..caf19ffb1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpHeaderBlock.html @@ -0,0 +1,205 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpHeaderBlock (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpHeaderBlock

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpManagerMetrics.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpManagerMetrics.html new file mode 100644 index 000000000..af48a6ca0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpManagerMetrics.html @@ -0,0 +1,200 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpManagerMetrics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpManagerMetrics

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpMonitoringOptions.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpMonitoringOptions.html new file mode 100644 index 000000000..750ba573b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpMonitoringOptions.html @@ -0,0 +1,255 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpMonitoringOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpMonitoringOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.html new file mode 100644 index 000000000..a72ad37df --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType.html @@ -0,0 +1,228 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyEnvironmentVariableSetting.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyEnvironmentVariableSetting.html new file mode 100644 index 000000000..6ae4b5d61 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyEnvironmentVariableSetting.html @@ -0,0 +1,253 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpProxyEnvironmentVariableSetting

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.HttpProxyAuthorizationType.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.HttpProxyAuthorizationType.html new file mode 100644 index 000000000..89e2589d7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.HttpProxyAuthorizationType.html @@ -0,0 +1,227 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyAuthorizationType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.HttpProxyConnectionType.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.HttpProxyConnectionType.html new file mode 100644 index 000000000..dbfef2097 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.HttpProxyConnectionType.html @@ -0,0 +1,240 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpProxyOptions.HttpProxyConnectionType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.html new file mode 100644 index 000000000..08cfc393b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpProxyOptions.html @@ -0,0 +1,400 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpProxyOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpProxyOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpRequest.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpRequest.html new file mode 100644 index 000000000..35f833dac --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpRequest.html @@ -0,0 +1,479 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpRequest (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpRequest

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpRequestBase.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpRequestBase.html new file mode 100644 index 000000000..8dc78b547 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpRequestBase.html @@ -0,0 +1,231 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpRequestBase (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpRequestBase

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpRequestBodyStream.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpRequestBodyStream.html new file mode 100644 index 000000000..bb0de1ee8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpRequestBodyStream.html @@ -0,0 +1,257 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.http.HttpRequestBodyStream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.http.HttpRequestBodyStream

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpStream.HttpStreamWriteChunkCompletionCallback.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpStream.HttpStreamWriteChunkCompletionCallback.html new file mode 100644 index 000000000..c7e4532d6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpStream.HttpStreamWriteChunkCompletionCallback.html @@ -0,0 +1,199 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.http.HttpStream.HttpStreamWriteChunkCompletionCallback (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.http.HttpStream.HttpStreamWriteChunkCompletionCallback

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpStream.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpStream.html new file mode 100644 index 000000000..f9109c0f8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpStream.html @@ -0,0 +1,250 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpStream (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpStream

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamBase.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamBase.html new file mode 100644 index 000000000..2ddf3260d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamBase.html @@ -0,0 +1,274 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpStreamBase (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpStreamBase

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamBaseResponseHandler.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamBaseResponseHandler.html new file mode 100644 index 000000000..489b11f1f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamBaseResponseHandler.html @@ -0,0 +1,221 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.http.HttpStreamBaseResponseHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamMetrics.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamMetrics.html new file mode 100644 index 000000000..eee497dff --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamMetrics.html @@ -0,0 +1,206 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpStreamMetrics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpStreamMetrics

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamResponseHandler.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamResponseHandler.html new file mode 100644 index 000000000..23ccd5a98 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpStreamResponseHandler.html @@ -0,0 +1,198 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.http.HttpStreamResponseHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.http.HttpStreamResponseHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/class-use/HttpVersion.html b/docs/software/amazon/awssdk/crt/http/class-use/HttpVersion.html new file mode 100644 index 000000000..90b4e5968 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/class-use/HttpVersion.html @@ -0,0 +1,237 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.http.HttpVersion (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.http.HttpVersion

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/package-summary.html b/docs/software/amazon/awssdk/crt/http/package-summary.html new file mode 100644 index 000000000..defcc3b80 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/package-summary.html @@ -0,0 +1,385 @@ + + + + + +software.amazon.awssdk.crt.http (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.http

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/package-tree.html b/docs/software/amazon/awssdk/crt/http/package-tree.html new file mode 100644 index 000000000..5f1d48fdd --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/package-tree.html @@ -0,0 +1,240 @@ + + + + + +software.amazon.awssdk.crt.http Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.http

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/http/package-use.html b/docs/software/amazon/awssdk/crt/http/package-use.html new file mode 100644 index 000000000..1cb6144f3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/http/package-use.html @@ -0,0 +1,527 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.http (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.http

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/ClientBootstrap.html b/docs/software/amazon/awssdk/crt/io/ClientBootstrap.html new file mode 100644 index 000000000..08eec635d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/ClientBootstrap.html @@ -0,0 +1,404 @@ + + + + + +ClientBootstrap (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class ClientBootstrap

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class ClientBootstrap
+extends CrtResource
      +
      This class wraps the aws_client_bootstrap from aws-c-io to provide + a client context for all protocol stacks in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientBootstrap

          +
          public ClientBootstrap​(EventLoopGroup elg,
+                       HostResolver hr)
+                throws CrtRuntimeException
          +
          Creates a new ClientBootstrap. Most applications will only ever need one instance of this.
          +
          +
          Parameters:
          +
          hr - A HostResolver instance, most applications only ever have one
          +
          elg - An EventLoopGroup instance, most applications only ever have one
          +
          Throws:
          +
          CrtRuntimeException - If the provided EventLoopGroup is null or invalid, + or if the system is unable to allocate space for a native client bootstrap object
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          closeStaticDefault

          +
          public static void closeStaticDefault()
          +
          Closes the static ClientBootstrap, if it exists. Primarily intended for tests that use the static + default ClientBootstrap, before they call waitForNoResources().
          +
          • +
        + + + +
          +
        • +

          getOrCreateStaticDefault

          +
          public static ClientBootstrap getOrCreateStaticDefault()
          +
          This default will be used when a ClientBootstrap is not explicitly passed but is needed + to allow the process to function. An example of this would be in the MQTT connection creation workflow. + The default ClientBootstrap will use the default EventLoopGroup and HostResolver, creating them if + necessary. + + The default ClientBootstrap will be automatically managed and released when it's + resources are being freed, not requiring any manual memory management.
          +
          +
          Returns:
          +
          the static default ClientBootstrap
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/ClientTlsContext.html b/docs/software/amazon/awssdk/crt/io/ClientTlsContext.html new file mode 100644 index 000000000..024e47587 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/ClientTlsContext.html @@ -0,0 +1,325 @@ + + + + + +ClientTlsContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class ClientTlsContext

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class ClientTlsContext
+extends TlsContext
      +
      This class wraps the aws_tls_context from aws-c-io to provide access to TLS + configuration contexts in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientTlsContext

          +
          public ClientTlsContext​(TlsContextOptions options)
+                 throws CrtRuntimeException
          +
          Creates a new Client TlsContext. There are significant native resources + consumed to create a TlsContext, so most applications will only need to + create one and re-use it for all connections.
          +
          +
          Parameters:
          +
          options - A set of options for this context
          +
          Throws:
          +
          CrtRuntimeException - If the provided options are malformed or the + system is unable to allocate space for a native + tls context
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/DirectoryEntry.html b/docs/software/amazon/awssdk/crt/io/DirectoryEntry.html new file mode 100644 index 000000000..45831ab9b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/DirectoryEntry.html @@ -0,0 +1,542 @@ + + + + + +DirectoryEntry (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class DirectoryEntry

    +
    +
    + +
    +
      +
    • +
      +
      public class DirectoryEntry
+extends Object
      +
      Supplied during calls to DirectoryTraversal.traverse() as each entry is encountered.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DirectoryEntry

          +
          public DirectoryEntry()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withPath

          +
          public DirectoryEntry withPath​(String path)
          +
          Sets the absolute path of this entry
          +
          +
          Parameters:
          +
          path - path
          +
          Returns:
          +
          this entry object
          +
          +
          • +
        + + + +
          +
        • +

          getPath

          +
          public String getPath()
          +
          +
          Returns:
          +
          the absolute path of this entry
          +
          +
          • +
        + + + +
          +
        • +

          withRelativePath

          +
          public DirectoryEntry withRelativePath​(String relativePath)
          +
          Sets the path relative to the current working directory
          +
          +
          Parameters:
          +
          relativePath - relative path
          +
          Returns:
          +
          this entry object
          +
          +
          • +
        + + + +
          +
        • +

          getRelativePath

          +
          public String getRelativePath()
          +
          +
          Returns:
          +
          the path relative to the current working directory
          +
          +
          • +
        + + + +
          +
        • +

          withIsDirectory

          +
          public DirectoryEntry withIsDirectory​(boolean isDirectory)
          +
          Sets the isDirectory flag, meaning this entry corresponds to a directory
          +
          +
          Parameters:
          +
          isDirectory - isDirectory
          +
          Returns:
          +
          this entry object
          +
          +
          • +
        + + + +
          +
        • +

          isDirectory

          +
          public boolean isDirectory()
          +
          +
          Returns:
          +
          true if this entry corresponds to a directory
          +
          +
          • +
        + + + +
          +
        • +

          withIsSymLink

          +
          public DirectoryEntry withIsSymLink​(boolean isSymLink)
          +
          Sets the isSymLink flag, meaning this entry corresponds to a symbolic link
          +
          +
          Parameters:
          +
          isSymLink - isSymLink
          +
          Returns:
          +
          this entry object
          +
          +
          • +
        + + + +
          +
        • +

          isSymLink

          +
          public boolean isSymLink()
          +
          +
          Returns:
          +
          true if this entry corresponds to a symbolic link.
          +
          +
          • +
        + + + +
          +
        • +

          withIsFile

          +
          public DirectoryEntry withIsFile​(boolean isFile)
          +
          Sets the isFile flag, meaning this entry corresponds to a file
          +
          +
          Parameters:
          +
          isFile - isFile
          +
          Returns:
          +
          this entry object
          +
          +
          • +
        + + + +
          +
        • +

          isFile

          +
          public boolean isFile()
          +
          +
          Returns:
          +
          true if this entry corresponds to a file
          +
          +
          • +
        + + + +
          +
        • +

          withFileSize

          +
          public DirectoryEntry withFileSize​(long fileSize)
          +
          Sets the file size corresponding to this entry
          +
          +
          Parameters:
          +
          fileSize - file size in bytes
          +
          Returns:
          +
          this entry object
          +
          +
          • +
        + + + +
          +
        • +

          getFileSize

          +
          public long getFileSize()
          +
          +
          Returns:
          +
          the size of the file
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/DirectoryTraversal.html b/docs/software/amazon/awssdk/crt/io/DirectoryTraversal.html new file mode 100644 index 000000000..7b7cf2a4a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/DirectoryTraversal.html @@ -0,0 +1,343 @@ + + + + + +DirectoryTraversal (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class DirectoryTraversal

    +
    +
    + +
    +
      +
    • +
      +
      @Deprecated
+public final class DirectoryTraversal
+extends Object
      +
      Deprecated. +
      It is currently an EXPERIMENTAL feature meant for internal use only. It may be changed incompatibly + or removed in a future version.
      +
      +
      This class wraps the directory traversal implementation provided by the CRT.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DirectoryTraversal

          +
          public DirectoryTraversal()
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          traverse

          +
          public static void traverse​(String path,
+                            boolean recursive,
+                            DirectoryTraversalHandler handler)
          +
          Deprecated.
          +
          Traverse a directory starting at the path provided. + If you want the traversal to recurse the entire directory, pass recursive as true. Passing false for this parameter + will only iterate the contents of the directory, but will not descend into any directories it encounters. + + If recursive is set to true, the traversal is performed post-order, depth-first + (for practical reasons such as deleting a directory that contains subdirectories or files). + + The traversal iteration can be cancelled by the user by returning false from the callback. If the + traversal is cancelled either returning false from the callback or an unhandled exception is thrown + from the callback, the traverse method will throw a RuntimeException to notify user about incomplete + results.
          +
          +
          Parameters:
          +
          path - directory to traverse.
          +
          recursive - true to recurse the entire directory, false will only iterate the path specified
          +
          handler - callback to invoke for each file or directory found during the traversal.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/DirectoryTraversalHandler.html b/docs/software/amazon/awssdk/crt/io/DirectoryTraversalHandler.html new file mode 100644 index 000000000..8eea18a99 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/DirectoryTraversalHandler.html @@ -0,0 +1,263 @@ + + + + + +DirectoryTraversalHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Interface DirectoryTraversalHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface DirectoryTraversalHandler
      +
      Handler invoked during calls to DirectoryTraversal.traverse() as each entry is encountered.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onDirectoryEntry

          +
          boolean onDirectoryEntry​(DirectoryEntry directoryEntry)
          +
          Invoked during calls to DirectoryTraversal.traverse() as each entry is encountered.
          +
          +
          Parameters:
          +
          directoryEntry - Information about the directory entry encountered
          +
          Returns:
          +
          true to continue the traversal, or false to abort it
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/EventLoopGroup.html b/docs/software/amazon/awssdk/crt/io/EventLoopGroup.html new file mode 100644 index 000000000..4ccb4d295 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/EventLoopGroup.html @@ -0,0 +1,422 @@ + + + + + +EventLoopGroup (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class EventLoopGroup

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class EventLoopGroup
+extends CrtResource
      +
      This class wraps the aws_event_loop_group from aws-c-io to provide + access to an event loop for the MQTT protocol stack in the AWS Common + Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EventLoopGroup

          +
          public EventLoopGroup​(int numThreads)
+               throws CrtRuntimeException
          +
          Creates a new event loop group for the I/O subsystem to use to run non-blocking I/O requests
          +
          +
          Parameters:
          +
          numThreads - The number of threads that the event loop group may run tasks across. Usually 1.
          +
          Throws:
          +
          CrtRuntimeException - If the system is unable to allocate space for a native event loop group
          +
          +
          • +
        + + + +
          +
        • +

          EventLoopGroup

          +
          public EventLoopGroup​(int cpuGroup,
+                      int numThreads)
+               throws CrtRuntimeException
          +
          Creates a new event loop group for the I/O subsystem to use to run non-blocking I/O requests. When using this + constructor, the threads will be pinned to a particular cpuGroup (e.g. a particular NUMA node).
          +
          +
          Parameters:
          +
          cpuGroup - the index of the cpu group to bind to (for example NUMA node 0 would be 0, NUMA node 1 would be 1 etc...)
          +
          numThreads - The number of threads that the event loop group may run tasks across. Usually 1.
          +
          Throws:
          +
          CrtRuntimeException - If the system is unable to allocate space for a native event loop group
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          setStaticDefaultNumThreads

          +
          public static void setStaticDefaultNumThreads​(int numThreads)
          +
          Sets the number of threads for the static default event loop group, should it ever be created. Has no + effect if the static default event loop group has already been created.
          +
          +
          Parameters:
          +
          numThreads - number of threads for the static default event loop group
          +
          +
          • +
        + + + +
          +
        • +

          closeStaticDefault

          +
          public static void closeStaticDefault()
          +
          Closes the static EventLoopGroup, if it exists. Primarily intended for tests that use the static + default EventLoopGroup, before they call waitForNoResources().
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/ExponentialBackoffRetryOptions.JitterMode.html b/docs/software/amazon/awssdk/crt/io/ExponentialBackoffRetryOptions.JitterMode.html new file mode 100644 index 000000000..2f7142e63 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/ExponentialBackoffRetryOptions.JitterMode.html @@ -0,0 +1,430 @@ + + + + + +ExponentialBackoffRetryOptions.JitterMode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum ExponentialBackoffRetryOptions.JitterMode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ExponentialBackoffRetryOptions.JitterMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ExponentialBackoffRetryOptions.JitterMode c : ExponentialBackoffRetryOptions.JitterMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ExponentialBackoffRetryOptions.JitterMode valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/ExponentialBackoffRetryOptions.html b/docs/software/amazon/awssdk/crt/io/ExponentialBackoffRetryOptions.html new file mode 100644 index 000000000..a305e16df --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/ExponentialBackoffRetryOptions.html @@ -0,0 +1,492 @@ + + + + + +ExponentialBackoffRetryOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class ExponentialBackoffRetryOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class ExponentialBackoffRetryOptions
+extends Object
      +
      Configuration options for the exponential backoff retry strategy for http requests
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExponentialBackoffRetryOptions

          +
          public ExponentialBackoffRetryOptions()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withEventLoopGroup

          +
          public ExponentialBackoffRetryOptions withEventLoopGroup​(EventLoopGroup eventLoopGroup)
          +
          Configure the event loop group to use to schedule the backoff/retry tasks
          +
          +
          Parameters:
          +
          eventLoopGroup - event loop group to use
          +
          Returns:
          +
          this options object
          +
          +
          • +
        + + + +
          +
        • +

          getEventLoopGroup

          +
          public EventLoopGroup getEventLoopGroup()
          +
          +
          Returns:
          +
          The event loop group currently configured to do backoff/retry
          +
          +
          • +
        + + + +
          +
        • +

          withMaxRetries

          +
          public ExponentialBackoffRetryOptions withMaxRetries​(long maxRetries)
          +
          Configure the maximum number of retries to make while using a strategy sourced from these options
          +
          +
          Parameters:
          +
          maxRetries - maximum number of retries
          +
          Returns:
          +
          this options object
          +
          +
          • +
        + + + +
          +
        • +

          getMaxRetries

          +
          public long getMaxRetries()
          +
          +
          Returns:
          +
          the maximum number of retries to make while using a strategy sourced from these options
          +
          +
          • +
        + + + +
          +
        • +

          withBackoffScaleFactorMS

          +
          public ExponentialBackoffRetryOptions withBackoffScaleFactorMS​(long backoffScaleFactorMS)
          +
          Configures the initial (base) unscaled backoff interval in milliseconds
          +
          +
          Parameters:
          +
          backoffScaleFactorMS - the initial (base) unscaled backoff interval in milliseconds
          +
          Returns:
          +
          this options object
          +
          +
          • +
        + + + +
          +
        • +

          getBackoffScaleFactorMS

          +
          public long getBackoffScaleFactorMS()
          +
          +
          Returns:
          +
          the initial (base) unscaled backoff interval in milliseconds while using a strategy sourced from + these options
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getJitterMode

          +
          public ExponentialBackoffRetryOptions.JitterMode getJitterMode()
          +
          +
          Returns:
          +
          the type of jitter to apply to the backoff interval calculations while using a strategy sourced + from these options
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/HostResolver.html b/docs/software/amazon/awssdk/crt/io/HostResolver.html new file mode 100644 index 000000000..e71710314 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/HostResolver.html @@ -0,0 +1,399 @@ + + + + + +HostResolver (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class HostResolver

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class HostResolver
+extends CrtResource
      +
      Java wrapper around the native CRT host resolver, responsible for performing async dns lookups
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + + + +
          +
        • +

          HostResolver

          +
          public HostResolver​(EventLoopGroup elg,
+                    int maxEntries)
+             throws CrtRuntimeException
          +
          +
          Parameters:
          +
          elg - event loop group to pass to the host resolver. Not currently used but still mandatory.
          +
          maxEntries - maximum size of the name to address mapping cache
          +
          Throws:
          +
          CrtRuntimeException
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setStaticDefaultMaxEntries

          +
          public static void setStaticDefaultMaxEntries​(int maxEntries)
          +
          Sets the max number of cached host entries for the static default resolver, if it's ever created/used. Has no + effect if the static default host resolver has already been created.
          +
          +
          Parameters:
          +
          maxEntries - maximum number of host entries cached
          +
          +
          • +
        + + + +
          +
        • +

          closeStaticDefault

          +
          public static void closeStaticDefault()
          +
          Closes the static default host resolver, if it exists. Primarily intended for tests that use the static + default resolver, before they call waitForNoResources().
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/Pkcs11Lib.InitializeFinalizeBehavior.html b/docs/software/amazon/awssdk/crt/io/Pkcs11Lib.InitializeFinalizeBehavior.html new file mode 100644 index 000000000..f16e444ef --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/Pkcs11Lib.InitializeFinalizeBehavior.html @@ -0,0 +1,422 @@ + + + + + +Pkcs11Lib.InitializeFinalizeBehavior (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum Pkcs11Lib.InitializeFinalizeBehavior

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          DEFAULT

          +
          public static final Pkcs11Lib.InitializeFinalizeBehavior DEFAULT
          +
          Default behavior that accommodates most use cases. + + C_Initialize() is called on creation, and "already-initialized" + errors are ignored. C_Finalize() is never called, just in case + another part of your application is still using the PKCS#11 library.
          +
          • +
        + + + +
          +
        • +

          OMIT

          +
          public static final Pkcs11Lib.InitializeFinalizeBehavior OMIT
          +
          Skip calling C_Initialize() and C_Finalize(). + + Use this if your application has already initialized the PKCS#11 library, and + you do not want C_Initialize() called again.
          +
          • +
        + + + +
          +
        • +

          STRICT

          +
          public static final Pkcs11Lib.InitializeFinalizeBehavior STRICT
          +
          C_Initialize() is called on creation and C_Finalize() is + called on cleanup. + + If C_Initialize() reports that's it's already initialized, this is + treated as an error. Use this if you need perfect cleanup (ex: running + valgrind with --leak-check).
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Pkcs11Lib.InitializeFinalizeBehavior[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Pkcs11Lib.InitializeFinalizeBehavior c : Pkcs11Lib.InitializeFinalizeBehavior.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Pkcs11Lib.InitializeFinalizeBehavior valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/Pkcs11Lib.html b/docs/software/amazon/awssdk/crt/io/Pkcs11Lib.html new file mode 100644 index 000000000..c45f9b7de --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/Pkcs11Lib.html @@ -0,0 +1,361 @@ + + + + + +Pkcs11Lib (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class Pkcs11Lib

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class Pkcs11Lib
+extends CrtResource
      +
      Handle to a loaded PKCS#11 library. + + For most use cases, a single instance of Pkcs11Lib should be used for the + lifetime of your application.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Pkcs11Lib

          +
          public Pkcs11Lib​(String path)
          +
          Load and initialize a PKCS#11 library. + + C_Initialize() and C_Finalize() are called on the PKCS#11 + library in the DEFAULT way.
          +
          +
          Parameters:
          +
          path - path to PKCS#11 library.
          +
          +
          • +
        + + + +
          +
        • +

          Pkcs11Lib

          +
          public Pkcs11Lib​(String path,
+                 Pkcs11Lib.InitializeFinalizeBehavior initializeFinalizeBehavior)
          +
          Load a PKCS#11 library, specifying how C_Initialize() and + C_Finalize() will be called.
          +
          +
          Parameters:
          +
          path - path to PKCS#11 library.
          +
          initializeFinalizeBehavior - specifies how C_Initialize() and + C_Finalize() will be called on the + PKCS#11 library.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/ServerBootstrap.html b/docs/software/amazon/awssdk/crt/io/ServerBootstrap.html new file mode 100644 index 000000000..d7570fd8e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/ServerBootstrap.html @@ -0,0 +1,310 @@ + + + + + +ServerBootstrap (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class ServerBootstrap

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class ServerBootstrap
+extends CrtResource
      +
      This class wraps the aws_server_bootstrap from aws-c-io to provide + a server context for all protocol stacks in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServerBootstrap

          +
          public ServerBootstrap​(EventLoopGroup elg)
          +
          +
          Parameters:
          +
          elg - event loop group to map server connections into
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/ServerTlsContext.html b/docs/software/amazon/awssdk/crt/io/ServerTlsContext.html new file mode 100644 index 000000000..443f6ee8d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/ServerTlsContext.html @@ -0,0 +1,325 @@ + + + + + +ServerTlsContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class ServerTlsContext

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class ServerTlsContext
+extends TlsContext
      +
      This class wraps the aws_tls_context from aws-c-io to provide access to TLS + configuration contexts in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServerTlsContext

          +
          public ServerTlsContext​(TlsContextOptions options)
+                 throws CrtRuntimeException
          +
          Creates a new Server TlsContext. There are significant native resources + consumed to create a TlsContext, so most applications will only need to + create one and re-use it for all connections.
          +
          +
          Parameters:
          +
          options - A set of options for this context
          +
          Throws:
          +
          CrtRuntimeException - If the provided options are malformed or the + system is unable to allocate space for a native + tls context
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/SocketOptions.SocketDomain.html b/docs/software/amazon/awssdk/crt/io/SocketOptions.SocketDomain.html new file mode 100644 index 000000000..2ad1555be --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/SocketOptions.SocketDomain.html @@ -0,0 +1,408 @@ + + + + + +SocketOptions.SocketDomain (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum SocketOptions.SocketDomain

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SocketOptions.SocketDomain[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SocketOptions.SocketDomain c : SocketOptions.SocketDomain.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SocketOptions.SocketDomain valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/SocketOptions.SocketType.html b/docs/software/amazon/awssdk/crt/io/SocketOptions.SocketType.html new file mode 100644 index 000000000..486f17412 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/SocketOptions.SocketType.html @@ -0,0 +1,392 @@ + + + + + +SocketOptions.SocketType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum SocketOptions.SocketType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SocketOptions.SocketType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SocketOptions.SocketType c : SocketOptions.SocketType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SocketOptions.SocketType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/SocketOptions.html b/docs/software/amazon/awssdk/crt/io/SocketOptions.html new file mode 100644 index 000000000..11c15614c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/SocketOptions.html @@ -0,0 +1,589 @@ + + + + + +SocketOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class SocketOptions

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class SocketOptions
+extends CrtResource
      +
      This class wraps the aws_socket_options from aws-c-io to provide + access to TCP/UDP socket configuration in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + + + + + + + + + +
          +
        • +

          connectTimeoutMs

          +
          public int connectTimeoutMs
          +
          Sets the number of milliseconds before a connection will be considered timed out
          +
          • +
        + + + +
          +
        • +

          keepAliveIntervalSecs

          +
          public int keepAliveIntervalSecs
          +
          Sets the number of seconds between TCP keepalive packets being sent to the peer + 0 disables keepalive
          +
          • +
        + + + +
          +
        • +

          keepAliveTimeoutSecs

          +
          public int keepAliveTimeoutSecs
          +
          Sets the number of seconds to wait for a keepalive response before considering the connection timed out + 0 disables keepalive
          +
          • +
        + + + +
          +
        • +

          keepAliveMaxFailedProbes

          +
          public int keepAliveMaxFailedProbes
          +
          Sets the number of keep alive probes allowed to fail before the connection is considered lost. + If zero, OS defaults are used. + On Windows, this option is meaningless until Windows 10 1703.
          +
          • +
        + + + +
          +
        • +

          keepAlive

          +
          public boolean keepAlive
          +
          If true, enables periodic transmits of keepalive messages for detecting a disconnected peer.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SocketOptions

          +
          public SocketOptions()
          +
          Creates a new set of socket options
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setTcpKeepAlive

          +
          public void setTcpKeepAlive​(int keepAliveTimeoutSecs,
+                            int keepAliveIntervalSecs)
          +
          Enables TCP keepalive.
          +
          +
          Parameters:
          +
          keepAliveTimeoutSecs - Sets the number of seconds to wait for a keepalive response before considering the + connection timed out. 0 disables keepalive.
          +
          keepAliveIntervalSecs - Sets the number of seconds between TCP keepalive packets being sent to the peer. + 0 disables keepalive.
          +
          +
          • +
        + + + +
          +
        • +

          setTcpKeepAlive

          +
          public void setTcpKeepAlive​(int keepAliveTimeoutSecs,
+                            int keepAliveIntervalSecs,
+                            int keepAliveMaxFailedProbes)
          +
          Enables TCP keepalive.
          +
          +
          Parameters:
          +
          keepAliveTimeoutSecs - Sets the number of seconds to wait for a keepalive response before considering the + connection timed out. 0 disables keepalive.
          +
          keepAliveIntervalSecs - Sets the number of seconds between TCP keepalive packets being sent to the peer. + 0 disables keepalive.
          +
          keepAliveMaxFailedProbes - Sets the number of keep alive probes allowed to fail before the connection is considered lost. + If zero, OS defaults are used. + On Windows, this option is meaningless until Windows 10 1703.
          +
          +
          • +
        + + + +
          +
        • +

          getNativeHandle

          +
          public long getNativeHandle()
          +
          Description copied from class: CrtResource
          +
          returns the native handle associated with this CRTResource.
          +
          +
          Overrides:
          +
          getNativeHandle in class CrtResource
          +
          Returns:
          +
          native address
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/software/amazon/awssdk/crt/io/StandardRetryOptions.html b/docs/software/amazon/awssdk/crt/io/StandardRetryOptions.html new file mode 100644 index 000000000..21786e1b2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/StandardRetryOptions.html @@ -0,0 +1,378 @@ + + + + + +StandardRetryOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class StandardRetryOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.io.StandardRetryOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class StandardRetryOptions
+extends Object
      +
      Top-level configuration for http retries.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StandardRetryOptions

          +
          public StandardRetryOptions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withBackoffRetryOptions

          +
          public StandardRetryOptions withBackoffRetryOptions​(ExponentialBackoffRetryOptions backoffRetryOptions)
          +
          Sets the exponential backoff configuration
          +
          +
          Parameters:
          +
          backoffRetryOptions - exponential backoff configuration
          +
          Returns:
          +
          this options object
          +
          +
          • +
        + + + +
          +
        • +

          getBackoffRetryOptions

          +
          public ExponentialBackoffRetryOptions getBackoffRetryOptions()
          +
          +
          Returns:
          +
          current exponential backoff retry options
          +
          +
          • +
        + + + +
          +
        • +

          withInitialBucketCapacity

          +
          public StandardRetryOptions withInitialBucketCapacity​(long initialBucketCapacity)
          +
          Sets the initial capacity of the token bucket in the standard retry strategy
          +
          +
          Parameters:
          +
          initialBucketCapacity - initial token bucket capacity
          +
          Returns:
          +
          this options object
          +
          +
          • +
        + + + +
          +
        • +

          getInitialBucketCapacity

          +
          public long getInitialBucketCapacity()
          +
          +
          Returns:
          +
          current initial bucket capacity
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsCipherPreference.html b/docs/software/amazon/awssdk/crt/io/TlsCipherPreference.html new file mode 100644 index 000000000..527a3aaf6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsCipherPreference.html @@ -0,0 +1,534 @@ + + + + + +TlsCipherPreference (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum TlsCipherPreference

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable, Comparable<TlsCipherPreference>
      +
      +
      +
      public enum TlsCipherPreference
+extends Enum<TlsCipherPreference>
      +
      A TlsCipherPreference represents a hardcoded ordered list of TLS Ciphers to use when negotiating a TLS Connection. + + At present, the ability to configure arbitrary orderings of TLS Ciphers is not allowed, and only a curated list of + vetted TlsCipherPreference's are exposed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          TLS_CIPHER_SYSTEM_DEFAULT

          +
          public static final TlsCipherPreference TLS_CIPHER_SYSTEM_DEFAULT
          +
          Use whatever the System Default Preference is. This is usually the best option, as it will be automatically + updated as the underlying OS or platform changes, and will always be supported on all Platforms.
          +
          • +
        + + + +
          +
        • +

          TLS_CIPHER_KMS_PQ_TLSv1_0_2019_06

          +
          @Deprecated
+public static final TlsCipherPreference TLS_CIPHER_KMS_PQ_TLSv1_0_2019_06
          +
          Deprecated. +
          This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
          +
          +
          • +
        + + + +
          +
        • +

          TLS_CIPHER_PREF_KMS_PQ_SIKE_TLSv1_0_2019_11

          +
          @Deprecated
+public static final TlsCipherPreference TLS_CIPHER_PREF_KMS_PQ_SIKE_TLSv1_0_2019_11
          +
          Deprecated. +
          This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
          +
          +
          • +
        + + + +
          +
        • +

          TLS_CIPHER_PREF_KMS_PQ_TLSv1_0_2020_02

          +
          @Deprecated
+public static final TlsCipherPreference TLS_CIPHER_PREF_KMS_PQ_TLSv1_0_2020_02
          +
          Deprecated. +
          This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
          +
          +
          • +
        + + + +
          +
        • +

          TLS_CIPHER_PREF_KMS_PQ_SIKE_TLSv1_0_2020_02

          +
          @Deprecated
+public static final TlsCipherPreference TLS_CIPHER_PREF_KMS_PQ_SIKE_TLSv1_0_2020_02
          +
          Deprecated. +
          This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
          +
          +
          • +
        + + + +
          +
        • +

          TLS_CIPHER_PREF_KMS_PQ_TLSv1_0_2020_07

          +
          @Deprecated
+public static final TlsCipherPreference TLS_CIPHER_PREF_KMS_PQ_TLSv1_0_2020_07
          +
          Deprecated. +
          This TlsCipherPreference is no longer supported. Use TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05 instead.
          +
          +
          • +
        + + + +
          +
        • +

          TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05

          +
          public static final TlsCipherPreference TLS_CIPHER_PREF_PQ_TLSv1_0_2021_05
          +
          This TlsCipherPreference supports TLS 1.0 through TLS 1.3, and contains Kyber Round 3 as its highest priority + PQ algorithm. PQ algorithms in this preference list will be used in hybrid mode, and will be combined with a + classical ECDHE key exchange. + + NIST has announced that Kyber will be first post-quantum key-agreement algorithm that it will standardize. + However, the NIST standardization process might introduce minor changes that may cause the final Kyber standard + to differ from the Kyber Round 3 implementation available in this preference list. + + Since this TlsCipherPreference contains algorithms that have not yet been officially standardized by NIST, this + preference list, and any of the PQ algorithms in it, may stop being supported at any time. + + For more info see: + - https://tools.ietf.org/html/draft-campagna-tls-bike-sike-hybrid + - https://datatracker.ietf.org/doc/html/draft-ietf-tls-hybrid-design + - https://aws.amazon.com/blogs/security/how-to-tune-tls-for-hybrid-post-quantum-cryptography-with-kyber/ + - https://nvlpubs.nist.gov/nistpubs/ir/2022/NIST.IR.8413.pdf
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TlsCipherPreference[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TlsCipherPreference c : TlsCipherPreference.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TlsCipherPreference valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          isSupported

          +
          public boolean isSupported()
          +
          Not all Cipher Preferences are supported on all Platforms due to differences in the underlying TLS Libraries.
          +
          +
          Returns:
          +
          True if this TlsCipherPreference is currently supported on the current platform.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsConnectionOptions.html b/docs/software/amazon/awssdk/crt/io/TlsConnectionOptions.html new file mode 100644 index 000000000..408a97487 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsConnectionOptions.html @@ -0,0 +1,435 @@ + + + + + +TlsConnectionOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class TlsConnectionOptions

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class TlsConnectionOptions
+extends CrtResource
      +
      Connection-specific TLS options.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TlsConnectionOptions

          +
          public TlsConnectionOptions​(TlsContext tlsContext)
          +
          Initialize the connection-specific TLS options with TLSContext.
          +
          +
          Parameters:
          +
          tlsContext - the TLS configuration contexts in the AWS Common Runtime.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getNativeHandle

          +
          public long getNativeHandle()
          +
          Note: Once this gets invoked the native resource will not be able to changed.
          +
          +
          Overrides:
          +
          getNativeHandle in class CrtResource
          +
          Returns:
          +
          native address
          +
          +
          • +
        + + + +
          +
        • +

          withAlpnList

          +
          public TlsConnectionOptions withAlpnList​(String alpnList)
          +
          Sets alpn list in the form protocol1;protocol2;.... A maximum of 4 + protocols are supported. + alpnList is copied. This value is already inherited from TlsContext, but the + TlsContext is expensive, and should be used across as many connections as + possible. If you want to set this per connection, set it here.
          +
          +
          Parameters:
          +
          alpnList - Semi-colon delimited list of supported ALPN protocols
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withServerName

          +
          public TlsConnectionOptions withServerName​(String serverName)
          +
          Sets server name to use for the SNI extension (supported everywhere), as well + as x.509 validation. If you don't set this, your x.509 validation will likely + fail.
          +
          +
          Parameters:
          +
          serverName - The server name to use for the SNI extension
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withTimeoutMs

          +
          public TlsConnectionOptions withTimeoutMs​(int timeoutMs)
          +
          Set the TLS negotiation timeout
          +
          +
          Parameters:
          +
          timeoutMs - The time out in ms
          +
          Returns:
          +
          this
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsContext.html b/docs/software/amazon/awssdk/crt/io/TlsContext.html new file mode 100644 index 000000000..9416e3d5c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsContext.html @@ -0,0 +1,344 @@ + + + + + +TlsContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class TlsContext

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      Direct Known Subclasses:
      +
      ClientTlsContext, ServerTlsContext
      +
      +
      +
      public class TlsContext
+extends CrtResource
      +
      This class wraps the aws_tls_context from aws-c-io to provide + access to TLS configuration contexts in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TlsContext

          +
          public TlsContext​(TlsContextOptions options)
+           throws CrtRuntimeException
          +
          Creates a new Client TlsContext. There are significant native resources consumed to create a TlsContext, so most + applications will only need to create one and re-use it for all connections.
          +
          +
          Parameters:
          +
          options - A set of options for this context
          +
          Throws:
          +
          CrtRuntimeException - If the provided options are malformed or the system is unable + to allocate space for a native tls context
          +
          +
          • +
        + + + +
          +
        • +

          TlsContext

          +
          public TlsContext()
+           throws CrtRuntimeException
          +
          Creates a new Client TlsContext. There are significant native resources consumed to create a TlsContext, so most + applications will only need to create one and re-use it for all connections.
          +
          +
          Throws:
          +
          CrtRuntimeException
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsContextCustomKeyOperationOptions.html b/docs/software/amazon/awssdk/crt/io/TlsContextCustomKeyOperationOptions.html new file mode 100644 index 000000000..b1fdb4860 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsContextCustomKeyOperationOptions.html @@ -0,0 +1,419 @@ + + + + + +TlsContextCustomKeyOperationOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class TlsContextCustomKeyOperationOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class TlsContextCustomKeyOperationOptions
+extends Object
      +
      Top level configuration for the custom TLS key operations.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TlsContextCustomKeyOperationOptions

          +
          public TlsContextCustomKeyOperationOptions​(TlsKeyOperationHandler operationHandler)
          +
          Creates a new TlsContextCustomKeyOperationOptions and sets the TlsKeyOperationHandler that + will be invoked when there is a TLS key operation that needs to be performed. + + Through the TlsKeyOperationHandler you can add your own private key operations during the + mutual TLS handshake.
          +
          +
          Parameters:
          +
          operationHandler - The operation handler to use when performing a TLS key operation.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          withCertificateFileContents

          +
          public TlsContextCustomKeyOperationOptions withCertificateFileContents​(String contents)
          +
          Use this X.509 certificate (contents in memory). The certificate may be + specified by other means instead (ex: withCertificateFilePath(java.lang.String))
          +
          +
          Parameters:
          +
          contents - contents of PEM-formatted certificate file.
          +
          Returns:
          +
          The TlsContextCustomKeyOperationOptions after certificate contents
          +
          +
          • +
        + + + +
          +
        • +

          getCertificateFilePath

          +
          public String getCertificateFilePath()
          +
          Returns the path to the X.509 certificate file on disk if it has been set.
          +
          +
          Returns:
          +
          The path to the certificate file
          +
          +
          • +
        + + + +
          +
        • +

          getCertificateFileContents

          +
          public String getCertificateFileContents()
          +
          Returns the contents of the X.509 certificate if it has been set.
          +
          +
          Returns:
          +
          The contents of the certificate
          +
          +
          • +
        + + + +
          +
        • +

          getOperationHandler

          +
          public TlsKeyOperationHandler getOperationHandler()
          +
          Returns the TlsKeyOperationHandler assigned to this class.
          +
          +
          Returns:
          +
          The operation handler that will be used
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsContextOptions.TlsVersions.html b/docs/software/amazon/awssdk/crt/io/TlsContextOptions.TlsVersions.html new file mode 100644 index 000000000..a638d5bb9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsContextOptions.TlsVersions.html @@ -0,0 +1,453 @@ + + + + + +TlsContextOptions.TlsVersions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum TlsContextOptions.TlsVersions

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TlsContextOptions.TlsVersions[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TlsContextOptions.TlsVersions c : TlsContextOptions.TlsVersions.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TlsContextOptions.TlsVersions valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsContextOptions.html b/docs/software/amazon/awssdk/crt/io/TlsContextOptions.html new file mode 100644 index 000000000..a50455426 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsContextOptions.html @@ -0,0 +1,1180 @@ + + + + + +TlsContextOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class TlsContextOptions

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class TlsContextOptions
+extends CrtResource
      +
      This class wraps the aws_tls_connection_options from aws-c-io to provide + access to TLS configuration contexts in the AWS Common Runtime.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          minTlsVersion

          +
          public TlsContextOptions.TlsVersions minTlsVersion
          +
          Sets the minimum acceptable TLS version that the TlsContext will + allow. Not compatible with setCipherPreference() API. + + Select from TlsVersions, a good default is TlsVersions.TLS_VER_SYS_DEFAULTS + as this will update if the OS TLS is updated
          +
          • +
        + + + +
          +
        • +

          tlsCipherPreference

          +
          public TlsCipherPreference tlsCipherPreference
          +
          Sets the TLS Cipher Preferences that can be negotiated and used during the + TLS Connection. Not compatible with setMinimumTlsVersion() API.
          +
          • +
        + + + +
          +
        • +

          alpnList

          +
          public List<String> alpnList
          +
          Sets the ALPN protocol list that will be provided when a TLS connection + starts e.g. "x-amzn-mqtt-ca"
          +
          • +
        + + + +
          +
        • +

          verifyPeer

          +
          public boolean verifyPeer
          +
          Set whether or not the peer should be verified. Default is true for clients, + and false for servers. If you are in a development or debugging environment, + you can disable this to avoid or diagnose trust store issues. This should + always be true on clients in the wild. If you set this to true on a server, + it will validate every client connection.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getNativeHandle

          +
          public long getNativeHandle()
          +
          Description copied from class: CrtResource
          +
          returns the native handle associated with this CRTResource.
          +
          +
          Overrides:
          +
          getNativeHandle in class CrtResource
          +
          Returns:
          +
          native address
          +
          +
          • +
        + + + +
          +
        • +

          setCipherPreference

          +
          public void setCipherPreference​(TlsCipherPreference cipherPref)
          +
          Sets the TLS cipher preferences to use in contexts using this configuration
          +
          +
          Parameters:
          +
          cipherPref - cipher preferences to use
          +
          +
          • +
        + + + +
          +
        • +

          initMtlsFromPath

          +
          public void initMtlsFromPath​(String certificatePath,
+                             String privateKeyPath)
          +
          Sets the path to the certificate that identifies this mutual TLS (mTLS) host. Must be in PEM format.
          +
          +
          Parameters:
          +
          certificatePath - Path to PEM format certificate
          +
          privateKeyPath - Path to PEM format private key
          +
          +
          • +
        + + + +
          +
        • +

          initMtls

          +
          public void initMtls​(String certificate,
+                     String privateKey)
+              throws IllegalArgumentException
          +
          Sets the certificate/key pair that identifies this mutual TLS (mTLS) host. Must be in + PEM format.
          +
          +
          Parameters:
          +
          certificate - PEM armored certificate
          +
          privateKey - PEM armored private key
          +
          Throws:
          +
          IllegalArgumentException - If the certificate or privateKey are not in PEM format or if they contain chains
          +
          +
          • +
        + + + +
          +
        • +

          initMtlsPkcs12

          +
          public void initMtlsPkcs12​(String pkcs12Path,
+                           String pkcs12Password)
          +
          Apple platforms only - Initializes mutual TLS (mTLS) with PKCS12 file and password
          +
          +
          Parameters:
          +
          pkcs12Path - Path to PKCS12 file
          +
          pkcs12Password - PKCS12 password
          +
          +
          • +
        + + + +
          +
        • +

          isAlpnSupported

          +
          public static boolean isAlpnSupported()
          +
          Returns whether or not ALPN is supported on the current platform
          +
          +
          Returns:
          +
          true if ALPN is supported, false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          isCipherPreferenceSupported

          +
          public static boolean isCipherPreferenceSupported​(TlsCipherPreference cipherPref)
          +
          Returns whether or not the current platform can be configured to a specific TlsCipherPreference.
          +
          +
          Parameters:
          +
          cipherPref - The TlsCipherPreference to check
          +
          Returns:
          +
          True if the current platform does support this TlsCipherPreference, false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          overrideDefaultTrustStoreFromPath

          +
          public void overrideDefaultTrustStoreFromPath​(String caPath,
+                                              String caFile)
          +
          Helper function to provide a TlsContext-local trust store
          +
          +
          Parameters:
          +
          caPath - Path to the local trust store. Can be null.
          +
          caFile - Path to the root certificate. Must be in PEM format.
          +
          +
          • +
        + + + +
          +
        • +

          overrideDefaultTrustStore

          +
          public void overrideDefaultTrustStore​(String caRoot)
+                               throws IllegalArgumentException
          +
          Helper function to provide a TlsContext-local trust store
          +
          +
          Parameters:
          +
          caRoot - Buffer containing the root certificate chain. Must be in PEM format.
          +
          Throws:
          +
          IllegalArgumentException - if the CA Root PEM file is malformed
          +
          +
          • +
        + + + +
          +
        • +

          createDefaultClient

          +
          public static TlsContextOptions createDefaultClient()
          +
          Helper which creates a default set of TLS options for the current platform
          +
          +
          Returns:
          +
          A default configured set of options for a TLS client connection
          +
          +
          • +
        + + + +
          +
        • +

          createDefaultServer

          +
          public static TlsContextOptions createDefaultServer()
          +
          Helper which creates a default set of TLS options for the current platform
          +
          +
          Returns:
          +
          A default configured set of options for a TLS server connection
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtlsFromPath

          +
          public static TlsContextOptions createWithMtlsFromPath​(String certificatePath,
+                                                       String privateKeyPath)
          +
          Helper which creates mutual TLS (mTLS) options using a certificate and private key
          +
          +
          Parameters:
          +
          certificatePath - Path to a PEM format certificate
          +
          privateKeyPath - Path to a PEM format private key
          +
          Returns:
          +
          A set of options for setting up an mTLS connection
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtls

          +
          public static TlsContextOptions createWithMtls​(String certificate,
+                                               String privateKey)
+                                        throws IllegalArgumentException
          +
          Helper which creates mutual TLS (mTLS) options using a certificate and private key
          +
          +
          Parameters:
          +
          certificate - String containing a PEM format certificate
          +
          privateKey - String containing a PEM format private key
          +
          Returns:
          +
          A set of options for setting up an mTLS connection
          +
          Throws:
          +
          IllegalArgumentException - If either PEM fails to parse
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtlsPkcs12

          +
          public static TlsContextOptions createWithMtlsPkcs12​(String pkcs12Path,
+                                                     String pkcs12Password)
          +
          Apple platforms only - Helper which creates mutual TLS (mTLS) options using PKCS12
          +
          +
          Parameters:
          +
          pkcs12Path - The path to a PKCS12 file @see #setPkcs12Path(String)
          +
          pkcs12Password - The PKCS12 password @see #setPkcs12Password(String)
          +
          Returns:
          +
          A set of options for creating a PKCS12 mTLS connection
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtlsPkcs11

          +
          public static TlsContextOptions createWithMtlsPkcs11​(TlsContextPkcs11Options pkcs11Options)
          +
          Unix platforms only - Helper which creates mutual TLS (mTLS) options using a PKCS#11 library for private key operations.
          +
          +
          Parameters:
          +
          pkcs11Options - PKCS#11 options
          +
          Returns:
          +
          A set of options for creating a PKCS#11 mTLS connection
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtlsCustomKeyOperations

          +
          public static TlsContextOptions createWithMtlsCustomKeyOperations​(TlsContextCustomKeyOperationOptions custom)
          +
          Unix platforms only - Helper which creates mutual TLS (mTLS) options using the applied custom key operations. This + allows you to perform custom private key operations such as signing and decrypting. This is necessary if you + require an external library to handle private key operations.
          +
          +
          Parameters:
          +
          custom - The options for the custom private key operations
          +
          Returns:
          +
          A set of options for creating a custom key operation mTLS connection
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtlsWindowsCertStorePath

          +
          public static TlsContextOptions createWithMtlsWindowsCertStorePath​(String certificatePath)
          +
          Windows platforms only - Helper which creates mutual TLS (mTLS) options using a + certificate in a Windows certificate store.
          +
          +
          Parameters:
          +
          certificatePath - Path to certificate in a Windows certificate store. + The path must use backslashes and end with the + certificate's thumbprint. Example: + CurrentUser\MY\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6
          +
          Returns:
          +
          A set of options for setting up an mTLS connection
          +
          +
          • +
        + + + +
          +
        • +

          createWithMtlsJavaKeystore

          +
          public static TlsContextOptions createWithMtlsJavaKeystore​(KeyStore keyStore,
+                                                           String certificateAlias,
+                                                           String certificatePassword)
          +
          Helper which creates mutual TLS (mTLS) options using a certificate and private key + stored in a Java keystore. + Will throw an exception if there is no certificate and key at the given certificate alias, or there is some other + error accessing or using the passed-in Java keystore. + + Note: function assumes the passed keystore has already been loaded from a file by calling "keystore.load()" or similar.
          +
          +
          Parameters:
          +
          keyStore - The Java keystore to use. Assumed to be loaded with the desired certificate and key
          +
          certificateAlias - The alias of the certificate and key to use.
          +
          certificatePassword - The password of the certificate and key to use.
          +
          Returns:
          +
          A set of options for setting up an mTLS connection
          +
          Throws:
          +
          CrtRuntimeException - if the certificate alias does not exist or the certificate/key cannot be found in the certificate alias
          +
          +
          • +
        + + + +
          +
        • +

          withCipherPreference

          +
          public TlsContextOptions withCipherPreference​(TlsCipherPreference cipherPref)
          +
          Sets the ciphers that the TlsContext will be able to use
          +
          +
          Parameters:
          +
          cipherPref - The preference set of ciphers to use
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMinimumTlsVersion

          +
          public TlsContextOptions withMinimumTlsVersion​(TlsContextOptions.TlsVersions version)
          +
          Sets the minimum TLS version that the TlsContext will allow. Defaults to + OS defaults.
          +
          +
          Parameters:
          +
          version - Minimum acceptable TLS version
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withAlpnList

          +
          public TlsContextOptions withAlpnList​(String alpnList)
          +
          Sets the ALPN protocols list for any connections using this TlsContext
          +
          +
          Parameters:
          +
          alpnList - Semi-colon delimited list of supported ALPN protocols
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMtls

          +
          public TlsContextOptions withMtls​(String certificate,
+                                  String privateKey)
          +
          Enables mutual TLS (mTLS) on this TlsContext
          +
          +
          Parameters:
          +
          certificate - mTLS certificate, in PEM format
          +
          privateKey - mTLS private key, in PEM format
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMtlsFromPath

          +
          public TlsContextOptions withMtlsFromPath​(String certificatePath,
+                                          String privateKeyPath)
          +
          Enables mutual TLS (mTLS) on this TlsContext
          +
          +
          Parameters:
          +
          certificatePath - path to mTLS certificate, in PEM format
          +
          privateKeyPath - path to mTLS private key, in PEM format
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withCertificateAuthority

          +
          public TlsContextOptions withCertificateAuthority​(String caRoot)
          +
          Specifies the certificate authority to use. By default, the OS CA repository will be used.
          +
          +
          Parameters:
          +
          caRoot - Certificate Authority, in PEM format
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withCertificateAuthorityFromPath

          +
          public TlsContextOptions withCertificateAuthorityFromPath​(String caDirPath,
+                                                          String caFilePath)
          +
          Specifies the certificate authority to use.
          +
          +
          Parameters:
          +
          caDirPath - Path to certificate directory, e.g. /etc/ssl/certs
          +
          caFilePath - Path to ceritificate authority, in PEM format
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMtlsPkcs12

          +
          public TlsContextOptions withMtlsPkcs12​(String pkcs12Path,
+                                        String pkcs12Password)
          +
          Apple platforms only, specifies mutual TLS (mTLS) using PKCS#12
          +
          +
          Parameters:
          +
          pkcs12Path - Path to PKCS#12 certificate, in PEM format
          +
          pkcs12Password - PKCS#12 password
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMtlsPkcs11

          +
          public TlsContextOptions withMtlsPkcs11​(TlsContextPkcs11Options pkcs11Options)
          +
          Unix platforms only, specifies mutual TLS (mTLS) using a PKCS#11 library for private key operations.
          +
          +
          Parameters:
          +
          pkcs11Options - PKCS#11 options
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMtlsCustomKeyOperations

          +
          public TlsContextOptions withMtlsCustomKeyOperations​(TlsContextCustomKeyOperationOptions customKeyOperations)
          +
          Unix platforms only, specifies TLS options for custom private key operations. This + allows you to perform custom private key operations such as signing and decrypting.
          +
          +
          Parameters:
          +
          customKeyOperations - The custom private key operations
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withMtlsWindowsCertStorePath

          +
          public TlsContextOptions withMtlsWindowsCertStorePath​(String certificatePath)
          +
          Windows platforms only, specifies mutual TLS (mTLS) using a certificate in a Windows + certificate store.
          +
          +
          Parameters:
          +
          certificatePath - Path to certificate in a Windows certificate store. + The path must use backslashes and end with the + certificate's thumbprint. Example: + CurrentUser\MY\A11F8A9B5DF5B98BA3508FBCA575D09570E0D2C6
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withVerifyPeer

          +
          public TlsContextOptions withVerifyPeer​(boolean verify)
          +
          Sets whether or not TLS will validate the certificate from the peer. On clients, + this is enabled by default. On servers, this is disabled by default.
          +
          +
          Parameters:
          +
          verify - true to verify peers, false to ignore certs
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsContextPkcs11Options.html b/docs/software/amazon/awssdk/crt/io/TlsContextPkcs11Options.html new file mode 100644 index 000000000..4911a035e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsContextPkcs11Options.html @@ -0,0 +1,485 @@ + + + + + +TlsContextPkcs11Options (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class TlsContextPkcs11Options

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TlsContextPkcs11Options

          +
          public TlsContextPkcs11Options​(Pkcs11Lib pkcs11Lib)
          +
          Constructor
          +
          +
          Parameters:
          +
          pkcs11Lib - use this PKCS#11 library
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withUserPin

          +
          public TlsContextPkcs11Options withUserPin​(String pin)
          +
          Use this PIN to log the user into the PKCS#11 token. Leave unspecified to log + into a token with a "protected authentication path".
          +
          +
          Parameters:
          +
          pin - PIN
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withSlotId

          +
          public TlsContextPkcs11Options withSlotId​(long slotId)
          +
          Specify the slot ID containing a PKCS#11 token. If not specified, the token + will be chosen based on other criteria (such as token label).
          +
          +
          Parameters:
          +
          slotId - slot ID
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withTokenLabel

          +
          public TlsContextPkcs11Options withTokenLabel​(String label)
          +
          Specify the label of the PKCS#11 token to use. If not specified, the token + will be chosen based on other criteria (such as slot ID).
          +
          +
          Parameters:
          +
          label - label of token
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          withPrivateKeyObjectLabel

          +
          public TlsContextPkcs11Options withPrivateKeyObjectLabel​(String label)
          +
          Specify the label of the private key object on the PKCS#11 token. If not + specified, the key will be chosen based on other criteria (such as being the + only available private key on the token).
          +
          +
          Parameters:
          +
          label - label of private key object
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withCertificateFileContents

          +
          public TlsContextPkcs11Options withCertificateFileContents​(String contents)
          +
          Use this X.509 certificate (contents in memory). The certificate may be + specified by other means instead (ex: withCertificateFilePath(java.lang.String))
          +
          +
          Parameters:
          +
          contents - contents of PEM-formatted certificate file.
          +
          Returns:
          +
          this
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsHashAlgorithm.html b/docs/software/amazon/awssdk/crt/io/TlsHashAlgorithm.html new file mode 100644 index 000000000..dbdee50f8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsHashAlgorithm.html @@ -0,0 +1,463 @@ + + + + + +TlsHashAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum TlsHashAlgorithm

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable, Comparable<TlsHashAlgorithm>
      +
      +
      +
      public enum TlsHashAlgorithm
+extends Enum<TlsHashAlgorithm>
      +
      The hash algorithm of a TLS private key operation. Any custom private key operation handlers are expected to perform + operations on the input TLS data using the correct hash algorithm or fail the operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TlsHashAlgorithm[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TlsHashAlgorithm c : TlsHashAlgorithm.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TlsHashAlgorithm valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static TlsHashAlgorithm getEnumValueFromInteger​(int value)
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsKeyOperation.Type.html b/docs/software/amazon/awssdk/crt/io/TlsKeyOperation.Type.html new file mode 100644 index 000000000..1f8c8fa78 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsKeyOperation.Type.html @@ -0,0 +1,427 @@ + + + + + +TlsKeyOperation.Type (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum TlsKeyOperation.Type

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TlsKeyOperation.Type[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TlsKeyOperation.Type c : TlsKeyOperation.Type.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TlsKeyOperation.Type valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static TlsKeyOperation.Type getEnumValueFromInteger​(int value)
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsKeyOperation.html b/docs/software/amazon/awssdk/crt/io/TlsKeyOperation.html new file mode 100644 index 000000000..b1321a926 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsKeyOperation.html @@ -0,0 +1,417 @@ + + + + + +TlsKeyOperation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class TlsKeyOperation

    +
    +
    + +
    +
      +
    • +
      +
      public final class TlsKeyOperation
+extends Object
      +
      A class containing a mutual TLS (mTLS) Private Key operation that needs to be performed. + This class is passed to TlsKeyOperationHandler if a custom key operation is set. + + You MUST call either complete(output) or completeExceptionally(exception) + or the TLS connection will hang forever!
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getInput

          +
          public byte[] getInput()
          +
          Returns the input data from native that needs to be operated on using the private key. + You can determine the operation that needs to be performed on the data using the getType function.
          +
          +
          Returns:
          +
          The input data from native that needs to be operated on
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public TlsKeyOperation.Type getType()
          +
          Returns the operation that needs to be performed.
          +
          +
          Returns:
          +
          The operation that needs to be performed.
          +
          +
          • +
        + + + +
          +
        • +

          getSignatureAlgorithm

          +
          public TlsSignatureAlgorithm getSignatureAlgorithm()
          +
          Returns the TLS algorithm used in the signature.
          +
          +
          Returns:
          +
          The TLS algorithm used in the signature
          +
          +
          • +
        + + + +
          +
        • +

          getDigestAlgorithm

          +
          public TlsHashAlgorithm getDigestAlgorithm()
          +
          Returns the TLS Hash algorithm used in the digest.
          +
          +
          Returns:
          +
          The TLS Hash algorithm used in the digest
          +
          +
          • +
        + + + +
          +
        • +

          complete

          +
          public void complete​(byte[] output)
          +
          The function to call when you have modified the input data using the private key and are ready to + return it for use in the mutual TLS Handshake.
          +
          +
          Parameters:
          +
          output - The modified input data that has been modified by the custom key operation
          +
          +
          • +
        + + + +
          +
        • +

          completeExceptionally

          +
          public void completeExceptionally​(Throwable ex)
          +
          The function to call when you either have an exception and want to complete the operation with an + exception or you cannot complete the operation. This will mark the operation as complete with an + exception so it can be reacted to accordingly.
          +
          +
          Parameters:
          +
          ex - The exeception to complete with
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsKeyOperationHandler.html b/docs/software/amazon/awssdk/crt/io/TlsKeyOperationHandler.html new file mode 100644 index 000000000..11a6b73b9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsKeyOperationHandler.html @@ -0,0 +1,276 @@ + + + + + +TlsKeyOperationHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Interface TlsKeyOperationHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface TlsKeyOperationHandler
      +
      Interface for handling private key operations during the TLS handshake.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          performOperation

          +
          void performOperation​(TlsKeyOperation operation)
          +
          Invoked each time a private key operation needs to be performed. + + You MUST call either operation.complete(output) or + operation.completeExceptionally(exception) or the TLS connection will hang + forever. + + You may complete the operation synchronously, or async. You may complete the + operation on any thread. + + The function is always invoked from an IO event-loop thread. Therefore you + MUST NOT perform an async call and wait for it in a blocking way from within + this function. Such behavior is likely to deadlock your program. + + Additionally, this may be called from multiple times from multiple threads + at once, so keep this in mind if using a private key operation that has to + be single-threaded and synchronously called.
          +
          +
          Parameters:
          +
          operation - The operation to be acted on
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/TlsSignatureAlgorithm.html b/docs/software/amazon/awssdk/crt/io/TlsSignatureAlgorithm.html new file mode 100644 index 000000000..20ffd1718 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/TlsSignatureAlgorithm.html @@ -0,0 +1,424 @@ + + + + + +TlsSignatureAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Enum TlsSignatureAlgorithm

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable, Comparable<TlsSignatureAlgorithm>
      +
      +
      +
      public enum TlsSignatureAlgorithm
+extends Enum<TlsSignatureAlgorithm>
      +
      The signature of a TLS private key operation. Any custom private key operation handlers are expected to perform + operations on the input TLS data using the correct signature algorithm or fail the operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TlsSignatureAlgorithm[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TlsSignatureAlgorithm c : TlsSignatureAlgorithm.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TlsSignatureAlgorithm valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static TlsSignatureAlgorithm getEnumValueFromInteger​(int value)
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/Uri.html b/docs/software/amazon/awssdk/crt/io/Uri.html new file mode 100644 index 000000000..9b2f59881 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/Uri.html @@ -0,0 +1,456 @@ + + + + + +Uri (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.io
    +

    Class Uri

    +
    +
    + +
    +
      +
    • +
      +
      public class Uri
+extends Object
      +
      Wrapper around an http URI
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Uri

          +
          public Uri()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          appendEncodingUriPath

          +
          public static String appendEncodingUriPath​(String encoded,
+                                           String path)
          +
          Returns a concatenation of an encoded base, and the URI path encoding of a + string. This is the modified version of rfc3986 used by sigv4 signing.
          +
          +
          Parameters:
          +
          encoded - The encoded original path.
          +
          path - The path to be encoded and appended to the original path
          +
          Returns:
          +
          concatenation
          +
          +
          • +
        + + + +
          +
        • +

          encodeUriPath

          +
          public static String encodeUriPath​(String path)
          +
          Returns the URI path encoding of a string. This is the modified version of + rfc3986 used by sigv4 signing.
          +
          +
          Parameters:
          +
          path - The path to be encoded
          +
          Returns:
          +
          encoded path
          +
          +
          • +
        + + + +
          +
        • +

          appendEncodingUriParam

          +
          public static String appendEncodingUriParam​(String encoded,
+                                            String param)
          +
          Returns a concatenation of an encoded base, and the URI query param encoding + (passthrough alnum + '-' '_' '~' '.') of a UTF-8 string. For example, reading + "a b_c" would write "a%20b_c".
          +
          +
          Parameters:
          +
          encoded - The encoded original param.
          +
          param - The param to be encoded and appended to the original param
          +
          Returns:
          +
          concatenation
          +
          +
          • +
        + + + +
          +
        • +

          encodeUriParam

          +
          public static String encodeUriParam​(String param)
          +
          Returns the URI query param encoding (passthrough alnum + '-' '_' '~' '.') of + a UTF-8 string. For example, reading "a b_c" would write "a%20b_c".
          +
          +
          Parameters:
          +
          param - The param to be encoded and appended to the original param
          +
          Returns:
          +
          encoded param
          +
          +
          • +
        + + + +
          +
        • +

          appendDecodingUri

          +
          public static String appendDecodingUri​(String base,
+                                       String encoded)
          +
          Returns a concatenation of a decoded base, and the URI decoding of a UTF-8 + string, replacing %xx escapes by their single byte equivalent. For example, + reading "a%20b_c" would write "a b_c".
          +
          +
          Parameters:
          +
          base - The decoded base URI.
          +
          encoded - The encoded URI to be decoded and appended to the base URI.
          +
          Returns:
          +
          concatenation
          +
          +
          • +
        + + + +
          +
        • +

          decodeUri

          +
          public static String decodeUri​(String encoded)
          +
          Returns the URI decoding of a UTF-8 string, replacing %xx escapes by their + single byte equivalent. For example, reading "a%20b_c" would write "a b_c".
          +
          +
          Parameters:
          +
          encoded - The encoded URI to be decoded.
          +
          Returns:
          +
          decoded URI
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/ClientBootstrap.html b/docs/software/amazon/awssdk/crt/io/class-use/ClientBootstrap.html new file mode 100644 index 000000000..968d6a86c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/ClientBootstrap.html @@ -0,0 +1,471 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.ClientBootstrap (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.ClientBootstrap

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/ClientTlsContext.html b/docs/software/amazon/awssdk/crt/io/class-use/ClientTlsContext.html new file mode 100644 index 000000000..e7c305a67 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/ClientTlsContext.html @@ -0,0 +1,202 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.ClientTlsContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.ClientTlsContext

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/DirectoryEntry.html b/docs/software/amazon/awssdk/crt/io/class-use/DirectoryEntry.html new file mode 100644 index 000000000..ca3077c41 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/DirectoryEntry.html @@ -0,0 +1,249 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.DirectoryEntry (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.DirectoryEntry

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/DirectoryTraversal.html b/docs/software/amazon/awssdk/crt/io/class-use/DirectoryTraversal.html new file mode 100644 index 000000000..609e32cd0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/DirectoryTraversal.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.DirectoryTraversal (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.DirectoryTraversal

    +
    +
    No usage of software.amazon.awssdk.crt.io.DirectoryTraversal
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/DirectoryTraversalHandler.html b/docs/software/amazon/awssdk/crt/io/class-use/DirectoryTraversalHandler.html new file mode 100644 index 000000000..2aef3a357 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/DirectoryTraversalHandler.html @@ -0,0 +1,200 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.io.DirectoryTraversalHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.io.DirectoryTraversalHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/EventLoopGroup.html b/docs/software/amazon/awssdk/crt/io/class-use/EventLoopGroup.html new file mode 100644 index 000000000..9090b877e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/EventLoopGroup.html @@ -0,0 +1,241 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.EventLoopGroup (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.EventLoopGroup

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/ExponentialBackoffRetryOptions.JitterMode.html b/docs/software/amazon/awssdk/crt/io/class-use/ExponentialBackoffRetryOptions.JitterMode.html new file mode 100644 index 000000000..14ca3ce19 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/ExponentialBackoffRetryOptions.JitterMode.html @@ -0,0 +1,274 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions.JitterMode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/ExponentialBackoffRetryOptions.html b/docs/software/amazon/awssdk/crt/io/class-use/ExponentialBackoffRetryOptions.html new file mode 100644 index 000000000..5c3fb2ba7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/ExponentialBackoffRetryOptions.html @@ -0,0 +1,240 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.ExponentialBackoffRetryOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/HostResolver.html b/docs/software/amazon/awssdk/crt/io/class-use/HostResolver.html new file mode 100644 index 000000000..9e7ff9f55 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/HostResolver.html @@ -0,0 +1,196 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.HostResolver (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.HostResolver

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/Pkcs11Lib.InitializeFinalizeBehavior.html b/docs/software/amazon/awssdk/crt/io/class-use/Pkcs11Lib.InitializeFinalizeBehavior.html new file mode 100644 index 000000000..b225474db --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/Pkcs11Lib.InitializeFinalizeBehavior.html @@ -0,0 +1,222 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.Pkcs11Lib.InitializeFinalizeBehavior

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/Pkcs11Lib.html b/docs/software/amazon/awssdk/crt/io/class-use/Pkcs11Lib.html new file mode 100644 index 000000000..a206c6597 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/Pkcs11Lib.html @@ -0,0 +1,195 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.Pkcs11Lib (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.Pkcs11Lib

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/ServerBootstrap.html b/docs/software/amazon/awssdk/crt/io/class-use/ServerBootstrap.html new file mode 100644 index 000000000..4d2ba0b83 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/ServerBootstrap.html @@ -0,0 +1,200 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.ServerBootstrap (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.ServerBootstrap

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/ServerTlsContext.html b/docs/software/amazon/awssdk/crt/io/class-use/ServerTlsContext.html new file mode 100644 index 000000000..1f098926e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/ServerTlsContext.html @@ -0,0 +1,200 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.ServerTlsContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.ServerTlsContext

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.SocketDomain.html b/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.SocketDomain.html new file mode 100644 index 000000000..e6db77da1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.SocketDomain.html @@ -0,0 +1,222 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.SocketOptions.SocketDomain (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.SocketOptions.SocketDomain

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.SocketType.html b/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.SocketType.html new file mode 100644 index 000000000..8fba7b95e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.SocketType.html @@ -0,0 +1,222 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.SocketOptions.SocketType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.SocketOptions.SocketType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.html b/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.html new file mode 100644 index 000000000..3aba52f8f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/SocketOptions.html @@ -0,0 +1,355 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.SocketOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.SocketOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/StandardRetryOptions.html b/docs/software/amazon/awssdk/crt/io/class-use/StandardRetryOptions.html new file mode 100644 index 000000000..a8a8ed0e7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/StandardRetryOptions.html @@ -0,0 +1,245 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.StandardRetryOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.StandardRetryOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsCipherPreference.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsCipherPreference.html new file mode 100644 index 000000000..41c542000 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsCipherPreference.html @@ -0,0 +1,254 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsCipherPreference (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsCipherPreference

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsConnectionOptions.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsConnectionOptions.html new file mode 100644 index 000000000..568111685 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsConnectionOptions.html @@ -0,0 +1,268 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsConnectionOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsConnectionOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsContext.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsContext.html new file mode 100644 index 000000000..abf31e341 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsContext.html @@ -0,0 +1,474 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsContext

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsContextCustomKeyOperationOptions.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextCustomKeyOperationOptions.html new file mode 100644 index 000000000..85f0b5ed9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextCustomKeyOperationOptions.html @@ -0,0 +1,228 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsContextCustomKeyOperationOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsContextOptions.TlsVersions.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextOptions.TlsVersions.html new file mode 100644 index 000000000..66cd8743b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextOptions.TlsVersions.html @@ -0,0 +1,240 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsContextOptions.TlsVersions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsContextOptions.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextOptions.html new file mode 100644 index 000000000..0ecc9d5ea --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextOptions.html @@ -0,0 +1,383 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsContextOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsContextOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsContextPkcs11Options.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextPkcs11Options.html new file mode 100644 index 000000000..6ecf47769 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsContextPkcs11Options.html @@ -0,0 +1,256 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsContextPkcs11Options (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsContextPkcs11Options

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsHashAlgorithm.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsHashAlgorithm.html new file mode 100644 index 000000000..161b0e185 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsHashAlgorithm.html @@ -0,0 +1,217 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsHashAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsHashAlgorithm

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperation.Type.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperation.Type.html new file mode 100644 index 000000000..bc11c3e79 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperation.Type.html @@ -0,0 +1,217 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsKeyOperation.Type (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsKeyOperation.Type

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperation.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperation.html new file mode 100644 index 000000000..02657723b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperation.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsKeyOperation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsKeyOperation

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperationHandler.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperationHandler.html new file mode 100644 index 000000000..955fb3363 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsKeyOperationHandler.html @@ -0,0 +1,213 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.io.TlsKeyOperationHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.io.TlsKeyOperationHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/TlsSignatureAlgorithm.html b/docs/software/amazon/awssdk/crt/io/class-use/TlsSignatureAlgorithm.html new file mode 100644 index 000000000..07250921d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/TlsSignatureAlgorithm.html @@ -0,0 +1,217 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.TlsSignatureAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.TlsSignatureAlgorithm

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/class-use/Uri.html b/docs/software/amazon/awssdk/crt/io/class-use/Uri.html new file mode 100644 index 000000000..9e976d83f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/class-use/Uri.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.io.Uri (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.io.Uri

    +
    +
    No usage of software.amazon.awssdk.crt.io.Uri
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/package-summary.html b/docs/software/amazon/awssdk/crt/io/package-summary.html new file mode 100644 index 000000000..0afb715c6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/package-summary.html @@ -0,0 +1,377 @@ + + + + + +software.amazon.awssdk.crt.io (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.io

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      DirectoryTraversalHandler +
      Handler invoked during calls to DirectoryTraversal.traverse() as each entry is encountered.
      +
      TlsKeyOperationHandler +
      Interface for handling private key operations during the TLS handshake.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ClientBootstrap +
      This class wraps the aws_client_bootstrap from aws-c-io to provide + a client context for all protocol stacks in the AWS Common Runtime.
      +
      ClientTlsContext +
      This class wraps the aws_tls_context from aws-c-io to provide access to TLS + configuration contexts in the AWS Common Runtime.
      +
      DirectoryEntry +
      Supplied during calls to DirectoryTraversal.traverse() as each entry is encountered.
      +
      DirectoryTraversalDeprecated. +
      It is currently an EXPERIMENTAL feature meant for internal use only.
      +
      EventLoopGroup +
      This class wraps the aws_event_loop_group from aws-c-io to provide + access to an event loop for the MQTT protocol stack in the AWS Common + Runtime.
      +
      ExponentialBackoffRetryOptions +
      Configuration options for the exponential backoff retry strategy for http requests
      +
      HostResolver +
      Java wrapper around the native CRT host resolver, responsible for performing async dns lookups
      +
      Pkcs11Lib +
      Handle to a loaded PKCS#11 library.
      +
      ServerBootstrap +
      This class wraps the aws_server_bootstrap from aws-c-io to provide + a server context for all protocol stacks in the AWS Common Runtime.
      +
      ServerTlsContext +
      This class wraps the aws_tls_context from aws-c-io to provide access to TLS + configuration contexts in the AWS Common Runtime.
      +
      SocketOptions +
      This class wraps the aws_socket_options from aws-c-io to provide + access to TCP/UDP socket configuration in the AWS Common Runtime.
      +
      StandardRetryOptions +
      Top-level configuration for http retries.
      +
      TlsConnectionOptions +
      Connection-specific TLS options.
      +
      TlsContext +
      This class wraps the aws_tls_context from aws-c-io to provide + access to TLS configuration contexts in the AWS Common Runtime.
      +
      TlsContextCustomKeyOperationOptions +
      Top level configuration for the custom TLS key operations.
      +
      TlsContextOptions +
      This class wraps the aws_tls_connection_options from aws-c-io to provide + access to TLS configuration contexts in the AWS Common Runtime.
      +
      TlsContextPkcs11Options +
      Options for TLS using a PKCS#11 library for private key operations.
      +
      TlsKeyOperation +
      A class containing a mutual TLS (mTLS) Private Key operation that needs to be performed.
      +
      Uri +
      Wrapper around an http URI
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      ExponentialBackoffRetryOptions.JitterMode +
      What kind of jitter or randomization to apply to the backoff time interval + + https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
      +
      Pkcs11Lib.InitializeFinalizeBehavior +
      Controls how Pkcs11Lib calls C_Initialize() and C_Finalize() + on the PKCS#11 library.
      +
      SocketOptions.SocketDomain +
      Socket communications domain
      +
      SocketOptions.SocketType +
      Socket type
      +
      TlsCipherPreference +
      A TlsCipherPreference represents a hardcoded ordered list of TLS Ciphers to use when negotiating a TLS Connection.
      +
      TlsContextOptions.TlsVersions 
      TlsHashAlgorithm +
      The hash algorithm of a TLS private key operation.
      +
      TlsKeyOperation.Type +
      The type of TlsKeyOperation that needs to be performed by the TlsKeyOperationHandler interface.
      +
      TlsSignatureAlgorithm +
      The signature of a TLS private key operation.
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/package-tree.html b/docs/software/amazon/awssdk/crt/io/package-tree.html new file mode 100644 index 000000000..a96638b6a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/package-tree.html @@ -0,0 +1,220 @@ + + + + + +software.amazon.awssdk.crt.io Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.io

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/io/package-use.html b/docs/software/amazon/awssdk/crt/io/package-use.html new file mode 100644 index 000000000..7e890af54 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/io/package-use.html @@ -0,0 +1,580 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.io (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.io

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttClient.html b/docs/software/amazon/awssdk/crt/mqtt/MqttClient.html new file mode 100644 index 000000000..ddb2fa8a0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttClient.html @@ -0,0 +1,431 @@ + + + + + +MqttClient (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class MqttClient

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class MqttClient
+extends CrtResource
      +
      This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionalities + via the AWS Common Runtime + + One MqttClient class is needed per application. It can create any number of connections to + any number of MQTT endpoints
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTlsContext

          +
          public TlsContext getTlsContext()
          +
          +
          Returns:
          +
          the tls context used by all connections associated with this client.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnection.html b/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnection.html new file mode 100644 index 000000000..67f9996f4 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnection.html @@ -0,0 +1,592 @@ + + + + + +MqttClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class MqttClientConnection

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class MqttClientConnection
+extends CrtResource
      +
      This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionality + via the AWS Common Runtime + + MqttClientConnection represents a single connection from one MqttClient to an + MQTT service endpoint
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttClientConnection

          +
          public MqttClientConnection​(MqttConnectionConfig config)
+                     throws MqttException
          +
          Constructs a new MqttClientConnection. Connections are reusable after being + disconnected.
          +
          +
          Parameters:
          +
          config - Configuration to use
          +
          Throws:
          +
          MqttException - If mqttClient is null
          +
          +
          • +
        + + + +
          +
        • +

          MqttClientConnection

          +
          public MqttClientConnection​(Mqtt5Client mqtt5client,
+                            MqttClientConnectionEvents callbacks)
+                     throws MqttException
          +
          Constructs a new MqttClientConnection from a Mqtt5Client. Connections are + reusable after being + disconnected.
          +
          +
          Parameters:
          +
          mqtt5client - the mqtt5 client to setup from
          +
          callbacks - connection callbacks triggered when receive connection + events
          +
          Throws:
          +
          MqttException - If mqttClient is null
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          connect

          +
          public CompletableFuture<Boolean> connect()
+                                   throws MqttException
          +
          Connect to the service endpoint and start a session
          +
          +
          Returns:
          +
          Future result is true if resuming a session, false if clean session
          +
          Throws:
          +
          MqttException - If the port is out of range
          +
          +
          • +
        + + + +
          +
        • +

          disconnect

          +
          public CompletableFuture<Void> disconnect()
          +
          Disconnects the current session
          +
          +
          Returns:
          +
          When this future completes, the disconnection is complete
          +
          +
          • +
        + + + +
          +
        • +

          subscribe

          +
          public CompletableFuture<Integer> subscribe​(String topic,
+                                            QualityOfService qos,
+                                            Consumer<MqttMessage> handler)
          +
          Subscribes to a topic
          +
          +
          Parameters:
          +
          topic - The topic to subscribe to
          +
          qos - QualityOfService for this subscription
          +
          handler - A handler which can receive an MqttMessage when a message is + published to the topic
          +
          Returns:
          +
          Future result is the packet/message id associated with the subscribe + operation
          +
          +
          • +
        + + + +
          +
        • +

          subscribe

          +
          public CompletableFuture<Integer> subscribe​(String topic,
+                                            QualityOfService qos)
          +
          Subscribes to a topic without a handler (messages will only be delivered to + the OnMessage handler)
          +
          +
          Parameters:
          +
          topic - The topic to subscribe to
          +
          qos - QualityOfService for this subscription
          +
          Returns:
          +
          Future result is the packet/message id associated with the subscribe + operation
          +
          +
          • +
        + + + +
          +
        • +

          onMessage

          +
          public void onMessage​(Consumer<MqttMessage> handler)
          +
          Sets a handler to be invoked whenever a message arrives, subscription or not
          +
          +
          Parameters:
          +
          handler - A handler which can receive any MqttMessage
          +
          +
          • +
        + + + +
          +
        • +

          unsubscribe

          +
          public CompletableFuture<Integer> unsubscribe​(String topic)
          +
          Unsubscribes from a topic
          +
          +
          Parameters:
          +
          topic - The topic to unsubscribe from
          +
          Returns:
          +
          Future result is the packet/message id associated with the + unsubscribe operation
          +
          +
          • +
        + + + +
          +
        • +

          publish

          +
          public CompletableFuture<Integer> publish​(MqttMessage message)
          +
          Publishes a message to a topic.
          +
          +
          Parameters:
          +
          message - The message to publish.
          +
          Returns:
          +
          Future value is the packet/message id associated with the publish + operation
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOperationStatistics

          +
          public MqttClientConnectionOperationStatistics getOperationStatistics()
          +
          Returns statistics about the current state of the MqttClientConnection's + queue of operations.
          +
          +
          Returns:
          +
          Current state of the connection's queue of operations.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnectionEvents.html b/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnectionEvents.html new file mode 100644 index 000000000..0765cbdee --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnectionEvents.html @@ -0,0 +1,350 @@ + + + + + +MqttClientConnectionEvents (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Interface MqttClientConnectionEvents

    +
    +
    +
    +
      +
    • +
      +
      public interface MqttClientConnectionEvents
      +
      Interface used to receive connection events from the CRT
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onConnectionInterrupted

          +
          void onConnectionInterrupted​(int errorCode)
          +
          Called when the connection was lost (or disconnected), reconnect will be attempted automatically until + disconnect() is called
          +
          +
          Parameters:
          +
          errorCode - AWS CRT error code, pass to CRT.awsErrorString(int) for a human readable error
          +
          +
          • +
        + + + +
          +
        • +

          onConnectionResumed

          +
          void onConnectionResumed​(boolean sessionPresent)
          +
          Called whenever a reconnect succeeds; not called on an initial connect success
          +
          +
          Parameters:
          +
          sessionPresent - true if the session has been resumed, false if the session is clean
          +
          +
          • +
        + + + +
          +
        • +

          onConnectionSuccess

          +
          default void onConnectionSuccess​(OnConnectionSuccessReturn data)
          +
          Called on every successful connect and every successful reconnect. + Optional and is not required to be defined.
          +
          +
          Parameters:
          +
          data - The data sent from the client alongside the successful connection callback.
          +
          +
          • +
        + + + +
          +
        • +

          onConnectionFailure

          +
          default void onConnectionFailure​(OnConnectionFailureReturn data)
          +
          Called on every unsuccessful connect and every unsuccessful disconnect. + Optional and is not required to be defined.
          +
          +
          Parameters:
          +
          data - The data sent from the client alongside the failed connection callback.
          +
          +
          • +
        + + + +
          +
        • +

          onConnectionClosed

          +
          default void onConnectionClosed​(OnConnectionClosedReturn data)
          +
          Called when the connection was disconnected and shutdown successfully. + Optional and is not required to be defined.
          +
          +
          Parameters:
          +
          data - The data sent from the client alongside the successful disconnect.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnectionOperationStatistics.html b/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnectionOperationStatistics.html new file mode 100644 index 000000000..6458ab193 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttClientConnectionOperationStatistics.html @@ -0,0 +1,386 @@ + + + + + +MqttClientConnectionOperationStatistics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class MqttClientConnectionOperationStatistics

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class MqttClientConnectionOperationStatistics
+extends Object
      +
      Simple statistics about the current state of the connection's queue of operations
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttClientConnectionOperationStatistics

          +
          public MqttClientConnectionOperationStatistics()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getIncompleteOperationCount

          +
          public long getIncompleteOperationCount()
          +
          Returns the total number of operations submitted to the connection that have not yet been completed. + Note: Unacked operations are a subset of this.
          +
          +
          Returns:
          +
          Total number of operations submitted to the connection that have not yet been completed
          +
          +
          • +
        + + + +
          +
        • +

          getIncompleteOperationSize

          +
          public long getIncompleteOperationSize()
          +
          Returns the total packet size of operations submitted to the connection that have not yet been completed. + Note: Unacked operations are a subset of this.
          +
          +
          Returns:
          +
          Total packet size of operations submitted to the connection that have not yet been completed
          +
          +
          • +
        + + + +
          +
        • +

          getUnackedOperationCount

          +
          public long getUnackedOperationCount()
          +
          Returns the total number of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
          +
          +
          Returns:
          +
          Total number of operations that have been sent and are waiting for a corresponding ACK
          +
          +
          • +
        + + + +
          +
        • +

          getUnackedOperationSize

          +
          public long getUnackedOperationSize()
          +
          Returns the total packet size of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
          +
          +
          Returns:
          +
          Total packet size of operations that have been sent and are waiting for a corresponding ACK
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttConnectionConfig.html b/docs/software/amazon/awssdk/crt/mqtt/MqttConnectionConfig.html new file mode 100644 index 000000000..0ac412246 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttConnectionConfig.html @@ -0,0 +1,1397 @@ + + + + + +MqttConnectionConfig (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class MqttConnectionConfig

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public final class MqttConnectionConfig
+extends CrtResource
      +
      Encapsulates all per-mqtt-connection configuration
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttConnectionConfig

          +
          public MqttConnectionConfig()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setConnectionCallbacks

          +
          public void setConnectionCallbacks​(MqttClientConnectionEvents connectionCallbacks)
          +
          Configures the connection-related callbacks for a connection
          +
          +
          Parameters:
          +
          connectionCallbacks - connection event callbacks to use
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionCallbacks

          +
          public MqttClientConnectionEvents getConnectionCallbacks()
          +
          Queries the connection-related callbacks for a connection
          +
          +
          Returns:
          +
          the connection event callbacks to use
          +
          +
          • +
        + + + +
          +
        • +

          setClientId

          +
          public void setClientId​(String clientId)
          +
          Configures the client_id to use with a connection
          +
          +
          Parameters:
          +
          clientId - The client id for a connection. Needs to be unique across + all devices/clients.this.credentialsProvider
          +
          +
          • +
        + + + +
          +
        • +

          getClientId

          +
          public String getClientId()
          +
          Queries the client_id being used by a connection
          +
          +
          Returns:
          +
          The client id for a connection.
          +
          +
          • +
        + + + +
          +
        • +

          setEndpoint

          +
          public void setEndpoint​(String endpoint)
          +
          Configures the IoT endpoint for a connection
          +
          +
          Parameters:
          +
          endpoint - The IoT endpoint to connect to
          +
          +
          • +
        + + + +
          +
        • +

          getEndpoint

          +
          public String getEndpoint()
          +
          Queries the IoT endpoint used by a connection
          +
          +
          Returns:
          +
          The IoT endpoint used by a connection
          +
          +
          • +
        + + + +
          +
        • +

          setPort

          +
          public void setPort​(int port)
          +
          Configures the port to connect to.
          +
          +
          Parameters:
          +
          port - The port to connect to. Usually 8883 for MQTT, or 443 for websockets
          +
          +
          • +
        + + + +
          +
        • +

          getPort

          +
          public int getPort()
          +
          Queries the port to connect to.
          +
          +
          Returns:
          +
          The port to connect to
          +
          +
          • +
        + + + +
          +
        • +

          setSocketOptions

          +
          public void setSocketOptions​(SocketOptions socketOptions)
          +
          Configures the common settings to use for a connection's socket
          +
          +
          Parameters:
          +
          socketOptions - The socket settings
          +
          +
          • +
        + + + +
          +
        • +

          getSocketOptions

          +
          public SocketOptions getSocketOptions()
          +
          Queries the common settings to use for a connection's socket
          +
          +
          Returns:
          +
          The socket settings
          +
          +
          • +
        + + + +
          +
        • +

          setCleanSession

          +
          public void setCleanSession​(boolean cleanSession)
          +
          Configures whether or not the service should try to resume prior subscriptions, if it has any
          +
          +
          Parameters:
          +
          cleanSession - true if the session should drop prior subscriptions when + a connection is established, false to resume the session
          +
          +
          • +
        + + + +
          +
        • +

          getCleanSession

          +
          public boolean getCleanSession()
          +
          Queries whether or not the service should try to resume prior subscriptions, if it has any
          +
          +
          Returns:
          +
          true if the session should drop prior subscriptions when + a connection is established, false to resume the session
          +
          +
          • +
        + + + +
          +
        • +

          setKeepAliveMs

          +
          @Deprecated
+public void setKeepAliveMs​(int keepAliveMs)
          +
          Deprecated. +
          Configures MQTT keep-alive via PING messages. Note that this is not TCP + keepalive. Please use setKeepAliveSecs instead.
          +
          +
          +
          Parameters:
          +
          keepAliveMs - How often in milliseconds to send an MQTT PING message to the + service to keep a connection alive
          +
          +
          • +
        + + + +
          +
        • +

          getKeepAliveMs

          +
          @Deprecated
+public int getKeepAliveMs()
          +
          Deprecated. +
          Queries the MQTT keep-alive via PING messages. Please use + getKeepAliveSecs instead.
          +
          +
          +
          Returns:
          +
          How often in milliseconds to send an MQTT PING message to the + service to keep a connection alive
          +
          +
          • +
        + + + +
          +
        • +

          setKeepAliveSecs

          +
          public void setKeepAliveSecs​(int keepAliveSecs)
          +
          Configures MQTT keep-alive via PING messages. Note that this is not TCP + keepalive. Note: AWS IoT Core only allows 30-1200 Secs. Anything larger than + 65535 will be capped.
          +
          +
          Parameters:
          +
          keepAliveSecs - How often in seconds to send an MQTT PING message to the + service to keep a connection alive
          +
          +
          • +
        + + + +
          +
        • +

          getKeepAliveSecs

          +
          public int getKeepAliveSecs()
          +
          Queries the MQTT keep-alive via PING messages.
          +
          +
          Returns:
          +
          How often in seconds to send an MQTT PING message to the + service to keep a connection alive
          +
          +
          • +
        + + + +
          +
        • +

          setPingTimeoutMs

          +
          public void setPingTimeoutMs​(int pingTimeoutMs)
          +
          Configures ping timeout value. If a response is not received within this + interval, the connection will be reestablished.
          +
          +
          Parameters:
          +
          pingTimeoutMs - How long to wait for a ping response (in milliseconds) before resetting the connection
          +
          +
          • +
        + + + +
          +
        • +

          getPingTimeoutMs

          +
          public int getPingTimeoutMs()
          +
          Queries ping timeout value. If a response is not received within this + interval, the connection will be reestablished.
          +
          +
          Returns:
          +
          How long to wait for a ping response before resetting the connection
          +
          +
          • +
        + + + +
          +
        • +

          setReconnectTimeoutSecs

          +
          public void setReconnectTimeoutSecs​(long minTimeoutSecs,
+                                    long maxTimeoutSecs)
          +
          Configures the minimum and maximum reconnect timeouts. + + The time between reconnect attempts will start at min and multiply by 2 until max is reached. + Default value for min is 1, for max 128. Set either one to zero will use the default setting.
          +
          +
          Parameters:
          +
          minTimeoutSecs - The timeout to start with
          +
          maxTimeoutSecs - The highest allowable wait time between reconnect attempts
          +
          +
          • +
        + + + +
          +
        • +

          getMinReconnectTimeoutSecs

          +
          public long getMinReconnectTimeoutSecs()
          +
          Return the minimum reconnect timeout.
          +
          +
          Returns:
          +
          The timeout to start with
          +
          +
          • +
        + + + +
          +
        • +

          getMaxReconnectTimeoutSecs

          +
          public long getMaxReconnectTimeoutSecs()
          +
          Return the maximum reconnect timeout.
          +
          +
          Returns:
          +
          The highest allowable wait time between reconnect attempts
          +
          +
          • +
        + + + +
          +
        • +

          setProtocolOperationTimeoutMs

          +
          public void setProtocolOperationTimeoutMs​(int protocolOperationTimeoutMs)
          +
          Configures timeout value for requests that response is required on healthy connection. + If a response is not received within this interval, the request will fail as server not receiving it. + Applied to publish (QoS>0) and unsubscribe
          +
          +
          Parameters:
          +
          protocolOperationTimeoutMs - How long to wait for a request response (in milliseconds) before failing
          +
          +
          • +
        + + + +
          +
        • +

          getProtocolOperationTimeoutMs

          +
          public int getProtocolOperationTimeoutMs()
          +
          Queries timeout value for requests that response is required on healthy connection. + If a response is not received within this interval, the request will fail as server not receiving it. + Applied to publish (QoS>0) and unsubscribe
          +
          +
          Returns:
          +
          How long to wait for a request response (in milliseconds) before failing
          +
          +
          • +
        + + + +
          +
        • +

          setMqttClient

          +
          public void setMqttClient​(MqttClient mqttClient)
          +
          Configures the mqtt client to use for a connection
          +
          +
          Parameters:
          +
          mqttClient - the mqtt client to use
          +
          +
          • +
        + + + +
          +
        • +

          getMqttClient

          +
          public MqttClient getMqttClient()
          +
          Queries the mqtt client to use for a connection
          +
          +
          Returns:
          +
          the mqtt client to use
          +
          +
          • +
        + + + +
          +
        • +

          setMqtt5Client

          +
          public void setMqtt5Client​(Mqtt5Client mqtt5Client)
          +
          Configures the mqtt5 client to use for a connection
          +
          +
          Parameters:
          +
          mqtt5Client - the mqtt client to use
          +
          +
          • +
        + + + +
          +
        • +

          getMqtt5Client

          +
          public Mqtt5Client getMqtt5Client()
          +
          Queries the mqtt5 client to use for a connection
          +
          +
          Returns:
          +
          the mqtt5 client to use
          +
          +
          • +
        + + + +
          +
        • +

          setLogin

          +
          public void setLogin​(String user,
+                     String pass)
+              throws MqttException
          +
          Sets the login credentials for a connection.
          +
          +
          Parameters:
          +
          user - Login username
          +
          pass - Login password
          +
          Throws:
          +
          MqttException
          +
          +
          • +
        + + + +
          +
        • +

          setUsername

          +
          public void setUsername​(String username)
          +
          Configures the username to use as part of the CONNECT attempt
          +
          +
          Parameters:
          +
          username - username to use for the mqtt connect operation
          +
          +
          • +
        + + + +
          +
        • +

          getUsername

          +
          public String getUsername()
          +
          Queries the username to use as part of the CONNECT attempt
          +
          +
          Returns:
          +
          username to use for the mqtt connect operation
          +
          +
          • +
        + + + +
          +
        • +

          setPassword

          +
          public void setPassword​(String password)
          +
          Configures the password to use as part of the CONNECT attempt
          +
          +
          Parameters:
          +
          password - password to use for the mqtt connect operation
          +
          +
          • +
        + + + +
          +
        • +

          getPassword

          +
          public String getPassword()
          +
          Queries the password to use as part of the CONNECT attempt
          +
          +
          Returns:
          +
          password to use for the mqtt connect operation
          +
          +
          • +
        + + + +
          +
        • +

          setWillMessage

          +
          public void setWillMessage​(MqttMessage willMessage)
          +
          Configures the last will and testament message to be delivered to a topic when a connection disconnects
          +
          +
          Parameters:
          +
          willMessage - the message to publish as the will
          +
          +
          • +
        + + + +
          +
        • +

          getWillMessage

          +
          public MqttMessage getWillMessage()
          +
          Queries the last will and testament message to be delivered to a topic when a connection disconnects
          +
          +
          Returns:
          +
          the message to publish as the will
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setWillRetain

          +
          @Deprecated
+public void setWillRetain​(boolean retain)
          +
          Deprecated. +
          Set retain directly on the will's MqttMessage.
          +
          +
          +
          Parameters:
          +
          retain - whether will's should be sent with retain property set
          +
          +
          • +
        + + + +
          +
        • +

          getWillRetain

          +
          @Deprecated
+public boolean getWillRetain()
          +
          Deprecated. +
          Query retain directly from the will's MqttMessage.
          +
          +
          +
          Returns:
          +
          whether will will be sent with retain property set
          +
          +
          • +
        + + + +
          +
        • +

          setUseWebsockets

          +
          public void setUseWebsockets​(boolean useWebsockets)
          +
          Configures whether or not to use websockets for the mqtt connection
          +
          +
          Parameters:
          +
          useWebsockets - whether or not to use websockets
          +
          +
          • +
        + + + +
          +
        • +

          getUseWebsockets

          +
          public boolean getUseWebsockets()
          +
          Queries whether or not to use websockets for the mqtt connection
          +
          +
          Returns:
          +
          whether or not to use websockets
          +
          +
          • +
        + + + +
          +
        • +

          setWebsocketProxyOptions

          +
          public void setWebsocketProxyOptions​(HttpProxyOptions proxyOptions)
          +
          Deprecated. +
          use setHttpProxyOptions instead + Configures proxy options for a websocket-based mqtt connection
          +
          +
          +
          Parameters:
          +
          proxyOptions - proxy options to use for the base http connection
          +
          +
          • +
        + + + +
          +
        • +

          getWebsocketProxyOptions

          +
          public HttpProxyOptions getWebsocketProxyOptions()
          +
          Deprecated. +
          use getHttpProxyOptions instead + Queries proxy options for a websocket-based mqtt connection
          +
          +
          +
          Returns:
          +
          proxy options to use for the base http connection
          +
          +
          • +
        + + + +
          +
        • +

          setHttpProxyOptions

          +
          public void setHttpProxyOptions​(HttpProxyOptions proxyOptions)
          +
          Configures proxy options for the mqtt connection
          +
          +
          Parameters:
          +
          proxyOptions - proxy options to use for the connection
          +
          +
          • +
        + + + +
          +
        • +

          getHttpProxyOptions

          +
          public HttpProxyOptions getHttpProxyOptions()
          +
          Queries proxy options for an mqtt connection
          +
          +
          Returns:
          +
          proxy options to use for the connection
          +
          +
          • +
        + + + +
          +
        • +

          setWebsocketHandshakeTransform

          +
          public void setWebsocketHandshakeTransform​(Consumer<WebsocketHandshakeTransformArgs> handshakeTransform)
          +
          Set a transform operation to use on each websocket handshake http request. + The transform may modify the http request before it is sent to the server. + The transform MUST call handshakeTransform.complete() or handshakeTransform.completeExceptionally() + when the transform is complete, failure to do so will stall the mqtt connection indefinitely. + The transform operation may be asynchronous. + + The default websocket handshake http request uses path "/mqtt". + All required headers for a websocket handshake are present, + plus the optional header "Sec-WebSocket-Protocol: mqtt". + + This is only applicable to websocket-based mqtt connections.
          +
          +
          Parameters:
          +
          handshakeTransform - http request handshake transform
          +
          +
          • +
        + + + +
          +
        • +

          getWebsocketHandshakeTransform

          +
          public Consumer<WebsocketHandshakeTransformArgs> getWebsocketHandshakeTransform()
          +
          Queries the handshake http request transform to use when upgrading the connection
          +
          +
          Returns:
          +
          http request handshake transform
          +
          +
          • +
        + + + +
          +
        • +

          clone

          +
          public MqttConnectionConfig clone()
          +
          Creates a (shallow) clone of this config object
          +
          +
          Returns:
          +
          shallow clone of this config object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttException.html b/docs/software/amazon/awssdk/crt/mqtt/MqttException.html new file mode 100644 index 000000000..0e6d02e97 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttException.html @@ -0,0 +1,324 @@ + + + + + +MqttException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class MqttException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable
      +
      +
      +
      public class MqttException
+extends RuntimeException
      +
      This exception will be thrown by any exceptional cases encountered within the + JNI bindings to the AWS Common Runtime
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttException

          +
          public MqttException​(String msg)
          +
          +
          Parameters:
          +
          msg - mqtt exception message
          +
          +
          • +
        + + + +
          +
        • +

          MqttException

          +
          public MqttException​(int errorCode)
          +
          +
          Parameters:
          +
          errorCode - native CRT error code indicating the reason for the exception
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/MqttMessage.html b/docs/software/amazon/awssdk/crt/mqtt/MqttMessage.html new file mode 100644 index 000000000..2b1fd5890 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/MqttMessage.html @@ -0,0 +1,522 @@ + + + + + +MqttMessage (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class MqttMessage

    +
    +
    + +
    +
      +
    • +
      +
      public final class MqttMessage
+extends Object
      +
      Represents a message to publish, or a message that was received.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttMessage

          +
          public MqttMessage​(String topic,
+                   byte[] payload,
+                   QualityOfService qos,
+                   boolean retain,
+                   boolean dup)
          +
          Constructs a new message.
          +
          +
          Parameters:
          +
          topic - Message topic.
          +
          payload - Message payload.
          +
          qos - QualityOfService. When sending, the + QualityOfService to use for delivery. When receiving, + the QualityOfService used for delivery.
          +
          retain - Retain flag. When sending, whether the message should be + retained by the broker and delivered to future subscribers. + When receiving, whether the message was sent as a result of a + new subscription being made.
          +
          dup - DUP flag. Ignored when sending. When receiving, indicates + whether this might be re-delivery of an earlier attempt to + send the message.
          +
          +
          • +
        + + + +
          +
        • +

          MqttMessage

          +
          public MqttMessage​(String topic,
+                   byte[] payload,
+                   QualityOfService qos,
+                   boolean retain)
          +
          Constructs a new message.
          +
          +
          Parameters:
          +
          topic - Message topic.
          +
          payload - Message payload.
          +
          qos - QualityOfService. When sending, the + QualityOfService to use for delivery. When receiving, + the QualityOfService used for delivery.
          +
          retain - Retain flag. When sending, whether the message should be + retained by the broker and delivered to future subscribers. + When receiving, whether the message was sent as a result of a + new subscription being made.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          MqttMessage

          +
          @Deprecated
+public MqttMessage​(String topic,
+                   byte[] payload)
          +
          Deprecated. +
          Use alternate constructor.
          +
          +
          +
          Parameters:
          +
          topic - Message topic.
          +
          payload - Message payload.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTopic

          +
          public String getTopic()
          +
          Gets the topic associated with this message
          +
          +
          Returns:
          +
          The topic
          +
          +
          • +
        + + + +
          +
        • +

          getPayload

          +
          public byte[] getPayload()
          +
          Gets the message payload
          +
          +
          Returns:
          +
          Message payload
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getRetain

          +
          public boolean getRetain()
          +
          Gets the retain flag. When sending, whether the message should be retained by + the broker and delivered to future subscribers. When receiving, whether the + message was sent as a result of a new subscription being made.
          +
          +
          Returns:
          +
          Retain flag
          +
          +
          • +
        + + + +
          +
        • +

          getDup

          +
          public boolean getDup()
          +
          Gets the DUP flag. Ignored when sending. When receiving, indicates whether + this might be re-delivery of an earlier attempt to send the message.
          +
          +
          Returns:
          +
          DUP flag
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/OnConnectionClosedReturn.html b/docs/software/amazon/awssdk/crt/mqtt/OnConnectionClosedReturn.html new file mode 100644 index 000000000..a7eb976c6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/OnConnectionClosedReturn.html @@ -0,0 +1,278 @@ + + + + + +OnConnectionClosedReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class OnConnectionClosedReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt.OnConnectionClosedReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnConnectionClosedReturn
+extends Object
      +
      The data returned when the connection closed callback is invoked in a connection. +

      + Note: This class is currently empty, but this may contain additional data in the future.

      +
      +
      See Also:
      +
      MqttClientConnectionEvents
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OnConnectionClosedReturn

          +
          public OnConnectionClosedReturn()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/OnConnectionFailureReturn.html b/docs/software/amazon/awssdk/crt/mqtt/OnConnectionFailureReturn.html new file mode 100644 index 000000000..d9c1aee67 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/OnConnectionFailureReturn.html @@ -0,0 +1,282 @@ + + + + + +OnConnectionFailureReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class OnConnectionFailureReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt.OnConnectionFailureReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnConnectionFailureReturn
+extends Object
      +
      The data returned when the connection failure callback is invoked in a connection.
      +
      +
      See Also:
      +
      MqttClientConnectionEvents
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getErrorCode

          +
          public int getErrorCode()
          +
          Gets the AWS CRT error code for the connection failure. + Pass to CRT.awsErrorString(int) for a human readable error
          +
          +
          Returns:
          +
          The AWS CRT error code for the connection failure.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/OnConnectionSuccessReturn.html b/docs/software/amazon/awssdk/crt/mqtt/OnConnectionSuccessReturn.html new file mode 100644 index 000000000..325970129 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/OnConnectionSuccessReturn.html @@ -0,0 +1,282 @@ + + + + + +OnConnectionSuccessReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class OnConnectionSuccessReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt.OnConnectionSuccessReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnConnectionSuccessReturn
+extends Object
      +
      The data returned when the connection success callback is invoked in a connection.
      +
      +
      See Also:
      +
      MqttClientConnectionEvents
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSessionPresent

          +
          public boolean getSessionPresent()
          +
          Returns whether a session was present and resumed for this successful connection. + Will be set to true if the connection resumed an already present MQTT connection session.
          +
          +
          Returns:
          +
          whether a session was present and resumed
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/QualityOfService.html b/docs/software/amazon/awssdk/crt/mqtt/QualityOfService.html new file mode 100644 index 000000000..2fc5a011e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/QualityOfService.html @@ -0,0 +1,448 @@ + + + + + +QualityOfService (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Enum QualityOfService

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          AT_MOST_ONCE

          +
          public static final QualityOfService AT_MOST_ONCE
          +
          Message will be delivered at most once, or may not be delivered at all. There will be no ACK, and the message + will not be stored.
          +
          • +
        + + + +
          +
        • +

          AT_LEAST_ONCE

          +
          public static final QualityOfService AT_LEAST_ONCE
          +
          Message will be delivered at least once. It may be resent multiple times if errors occur before an ACK is + returned to the sender. The message will be stored in case it has to be re-sent. This is the most common QualityOfService.
          +
          • +
        + + + +
          +
        • +

          EXACTLY_ONCE

          +
          public static final QualityOfService EXACTLY_ONCE
          +
          The message is always delivered exactly once. This is the safest, but slowest QualityOfService, because multiple levels + of handshake must happen to guarantee no duplication of messages.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static QualityOfService[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (QualityOfService c : QualityOfService.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static QualityOfService valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          the native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static QualityOfService getEnumValueFromInteger​(int value)
          +
          Creates a Java QualityOfService enum value from a native integer value
          +
          +
          Parameters:
          +
          value - native integer value for quality of service
          +
          Returns:
          +
          a new QualityOfService value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/WebsocketHandshakeTransformArgs.html b/docs/software/amazon/awssdk/crt/mqtt/WebsocketHandshakeTransformArgs.html new file mode 100644 index 000000000..6e54f32c7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/WebsocketHandshakeTransformArgs.html @@ -0,0 +1,401 @@ + + + + + +WebsocketHandshakeTransformArgs (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt
    +

    Class WebsocketHandshakeTransformArgs

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class WebsocketHandshakeTransformArgs
+extends Object
      +
      Arguments to a websocket handshake transform operation. + The transform may modify the http request before it is sent to the server. + The transform MUST call complete() or completeExceptionally() when the transform is complete, + failure to do so will stall the mqtt connection indefinitely. + The transform operation may be asynchronous. + + The default websocket handshake http request uses path "/mqtt". + All required headers for a websocket handshake are present, + plus the optional header "Sec-WebSocket-Protocol: mqtt".
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          WebsocketHandshakeTransformArgs

          +
          public WebsocketHandshakeTransformArgs​(MqttClientConnection mqttConnection,
+                                       HttpRequest httpRequest,
+                                       CompletableFuture<HttpRequest> future)
          +
          +
          Parameters:
          +
          mqttConnection - mqtt client connection that is establishing a websocket connection
          +
          httpRequest - http request that may be modified by the transform operation
          +
          future - Future to complete when the transform is complete.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMqttClientConnection

          +
          public MqttClientConnection getMqttClientConnection()
          +
          Queries the mqtt client connection.
          +
          +
          Returns:
          +
          the mqtt client connection.
          +
          +
          • +
        + + + +
          +
        • +

          getHttpRequest

          +
          public HttpRequest getHttpRequest()
          +
          Get the http request that will be used to perform the websocket handshake. + The transform operation may modify this request.
          +
          +
          Returns:
          +
          The http request that will be used to perform the websocket handshake
          +
          +
          • +
        + + + +
          +
        • +

          complete

          +
          public void complete​(HttpRequest signedRequest)
          +
          Mark the transform operation as successfully completed. + The websocket connection will proceed, using the http request.
          +
          +
          Parameters:
          +
          signedRequest - completed request
          +
          +
          • +
        + + + +
          +
        • +

          completeExceptionally

          +
          public void completeExceptionally​(Throwable ex)
          +
          Mark the transform operation as unsuccessfully completed. + The websocket connection attempt will be canceled.
          +
          +
          Parameters:
          +
          ex - the exception
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClient.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClient.html new file mode 100644 index 000000000..8e8ba90f0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClient.html @@ -0,0 +1,214 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.MqttClient (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.MqttClient

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnection.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnection.html new file mode 100644 index 000000000..ee5af7ab6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnection.html @@ -0,0 +1,212 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.MqttClientConnection (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.MqttClientConnection

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnectionEvents.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnectionEvents.html new file mode 100644 index 000000000..21acf13b3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnectionEvents.html @@ -0,0 +1,230 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.mqtt.MqttClientConnectionEvents

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnectionOperationStatistics.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnectionOperationStatistics.html new file mode 100644 index 000000000..8d218e9e1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttClientConnectionOperationStatistics.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.MqttClientConnectionOperationStatistics

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttConnectionConfig.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttConnectionConfig.html new file mode 100644 index 000000000..9ce65417a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttConnectionConfig.html @@ -0,0 +1,212 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.MqttConnectionConfig (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.MqttConnectionConfig

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttException.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttException.html new file mode 100644 index 000000000..c79ac03ca --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttException.html @@ -0,0 +1,227 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.MqttException (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.MqttException

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttMessage.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttMessage.html new file mode 100644 index 000000000..916eb7e57 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/MqttMessage.html @@ -0,0 +1,256 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.MqttMessage (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.MqttMessage

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionClosedReturn.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionClosedReturn.html new file mode 100644 index 000000000..03e1e6676 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionClosedReturn.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.OnConnectionClosedReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.OnConnectionClosedReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionFailureReturn.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionFailureReturn.html new file mode 100644 index 000000000..513bf9927 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionFailureReturn.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.OnConnectionFailureReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.OnConnectionFailureReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionSuccessReturn.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionSuccessReturn.html new file mode 100644 index 000000000..f80f8b755 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/OnConnectionSuccessReturn.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.OnConnectionSuccessReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.OnConnectionSuccessReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/QualityOfService.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/QualityOfService.html new file mode 100644 index 000000000..e7b01260f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/QualityOfService.html @@ -0,0 +1,310 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.QualityOfService (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.QualityOfService

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/class-use/WebsocketHandshakeTransformArgs.html b/docs/software/amazon/awssdk/crt/mqtt/class-use/WebsocketHandshakeTransformArgs.html new file mode 100644 index 000000000..051b0c2e6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/class-use/WebsocketHandshakeTransformArgs.html @@ -0,0 +1,214 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt.WebsocketHandshakeTransformArgs

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/package-summary.html b/docs/software/amazon/awssdk/crt/mqtt/package-summary.html new file mode 100644 index 000000000..37f31403e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/package-summary.html @@ -0,0 +1,278 @@ + + + + + +software.amazon.awssdk.crt.mqtt (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.mqtt

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      MqttClientConnectionEvents +
      Interface used to receive connection events from the CRT
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      MqttClient +
      This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionalities + via the AWS Common Runtime + + One MqttClient class is needed per application.
      +
      MqttClientConnection +
      This class wraps aws-c-mqtt to provide the basic MQTT pub/sub functionality + via the AWS Common Runtime + + MqttClientConnection represents a single connection from one MqttClient to an + MQTT service endpoint
      +
      MqttClientConnectionOperationStatistics +
      Simple statistics about the current state of the connection's queue of operations
      +
      MqttConnectionConfig +
      Encapsulates all per-mqtt-connection configuration
      +
      MqttMessage +
      Represents a message to publish, or a message that was received.
      +
      OnConnectionClosedReturn +
      The data returned when the connection closed callback is invoked in a connection.
      +
      OnConnectionFailureReturn +
      The data returned when the connection failure callback is invoked in a connection.
      +
      OnConnectionSuccessReturn +
      The data returned when the connection success callback is invoked in a connection.
      +
      WebsocketHandshakeTransformArgs +
      Arguments to a websocket handshake transform operation.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      QualityOfService +
      Quality of Service associated with a publish action or subscription [MQTT-4.3].
      +
      +
      • +
    • + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      MqttException +
      This exception will be thrown by any exceptional cases encountered within the + JNI bindings to the AWS Common Runtime
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/package-tree.html b/docs/software/amazon/awssdk/crt/mqtt/package-tree.html new file mode 100644 index 000000000..132799569 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/package-tree.html @@ -0,0 +1,211 @@ + + + + + +software.amazon.awssdk.crt.mqtt Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.mqtt

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt/package-use.html b/docs/software/amazon/awssdk/crt/mqtt/package-use.html new file mode 100644 index 000000000..6d768094e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt/package-use.html @@ -0,0 +1,262 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.mqtt (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.mqtt

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5Client.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5Client.html new file mode 100644 index 000000000..085972d94 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5Client.html @@ -0,0 +1,561 @@ + + + + + +Mqtt5Client (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class Mqtt5Client

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      AutoCloseable
      +
      +
      +
      public class Mqtt5Client
+extends CrtResource
      +
      This class wraps the aws-c-mqtt MQTT5 client to provide the basic MQTT5 pub/sub functionalities + via the AWS Common Runtime + + One Mqtt5Client class creates one connection.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Mqtt5Client

          +
          public Mqtt5Client​(Mqtt5ClientOptions options)
+            throws CrtRuntimeException
          +
          Creates a Mqtt5Client instance using the provided Mqtt5ClientOptions. Once the Mqtt5Client is created, + changing the settings will not cause a change in already created Mqtt5Client's.
          +
          +
          Parameters:
          +
          options - The Mqtt5Options class to use to configure the new Mqtt5Client.
          +
          Throws:
          +
          CrtRuntimeException - If the system is unable to allocate space for a native MQTT5 client structure
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          start

          +
          public void start()
+           throws CrtRuntimeException
          +
          Notifies the Mqtt5Client that you want it maintain connectivity to the configured endpoint. + The client will attempt to stay connected using the properties of the reconnect-related parameters + in the Mqtt5Client configuration. + + This is an asynchronous operation.
          +
          +
          Throws:
          +
          CrtRuntimeException - If the native client returns an error when starting
          +
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop​(DisconnectPacket disconnectPacket)
+          throws CrtRuntimeException
          +
          Notifies the Mqtt5Client that you want it to end connectivity to the configured endpoint, disconnecting any + existing connection and halting any reconnect attempts. + + This is an asynchronous operation.
          +
          +
          Parameters:
          +
          disconnectPacket - (optional) Properties of a DISCONNECT packet to send as part of the shutdown process. When + disconnectPacket is null, no DISCONNECT packets will be sent.
          +
          Throws:
          +
          CrtRuntimeException - If the native client is unable to initialize the stop process.
          +
          +
          • +
        + + + +
          +
        • +

          stop

          +
          public void stop()
+          throws CrtRuntimeException
          +
          Notifies the Mqtt5Client that you want it to end connectivity to the configured endpoint, disconnecting any + existing connection and halting any reconnect attempts. No DISCONNECT packets will be sent. + + This is an asynchronous operation.
          +
          +
          Throws:
          +
          CrtRuntimeException - If the native client is unable to initialize the stop process.
          +
          +
          • +
        + + + +
          +
        • +

          publish

          +
          public CompletableFuture<PublishResult> publish​(PublishPacket publishPacket)
          +
          Tells the Mqtt5Client to attempt to send a PUBLISH packet. + + Will return a future containing a PublishPacket if the publish is successful. + The data in the PublishPacket varies depending on the QoS of the Publish. For QoS 0, the PublishPacket + will not contain data. For QoS 1, the PublishPacket will contain a PubAckPacket. + See PublishPacket class documentation for more info.
          +
          +
          Parameters:
          +
          publishPacket - PUBLISH packet to send to the server
          +
          Returns:
          +
          A future that will be rejected with an error or resolved with a PublishResult response
          +
          +
          • +
        + + + +
          +
        • +

          subscribe

          +
          public CompletableFuture<SubAckPacket> subscribe​(SubscribePacket subscribePacket)
          +
          Tells the Mqtt5Client to attempt to subscribe to one or more topic filters.
          +
          +
          Parameters:
          +
          subscribePacket - SUBSCRIBE packet to send to the server
          +
          Returns:
          +
          a future that will be rejected with an error or resolved with the SUBACK response
          +
          +
          • +
        + + + +
          +
        • +

          unsubscribe

          +
          public CompletableFuture<UnsubAckPacket> unsubscribe​(UnsubscribePacket unsubscribePacket)
          +
          Tells the Mqtt5Client to attempt to unsubscribe from one or more topic filters.
          +
          +
          Parameters:
          +
          unsubscribePacket - UNSUBSCRIBE packet to send to the server
          +
          Returns:
          +
          a future that will be rejected with an error or resolved with the UNSUBACK response
          +
          +
          • +
        + + + +
          +
        • +

          getOperationStatistics

          +
          public Mqtt5ClientOperationStatistics getOperationStatistics()
          +
          Returns statistics about the current state of the Mqtt5Client's queue of operations.
          +
          +
          Returns:
          +
          Current state of the client's queue of operations.
          +
          +
          • +
        + + + +
          +
        • +

          getIsConnected

          +
          public boolean getIsConnected()
          +
          Returns the connectivity state for the Mqtt5Client.
          +
          +
          Returns:
          +
          True if the client is connected, false otherwise
          +
          +
          • +
        + + + +
          +
        • +

          getClientOptions

          +
          public Mqtt5ClientOptions getClientOptions()
          +
          Returns the Mqtt5ClientOptions used for the Mqtt5Client
          +
          +
          Returns:
          +
          Mqtt5ClientOptions
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOperationStatistics.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOperationStatistics.html new file mode 100644 index 000000000..e37002ada --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOperationStatistics.html @@ -0,0 +1,386 @@ + + + + + +Mqtt5ClientOperationStatistics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class Mqtt5ClientOperationStatistics

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Mqtt5ClientOperationStatistics
+extends Object
      +
      Simple statistics about the current state of the client's queue of operations
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Mqtt5ClientOperationStatistics

          +
          public Mqtt5ClientOperationStatistics()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getIncompleteOperationCount

          +
          public long getIncompleteOperationCount()
          +
          Returns the total number of operations submitted to the client that have not yet been completed. + Note: Unacked operations are a subset of this.
          +
          +
          Returns:
          +
          Total number of operations submitted to the client that have not yet been completed
          +
          +
          • +
        + + + +
          +
        • +

          getIncompleteOperationSize

          +
          public long getIncompleteOperationSize()
          +
          Returns the total packet size of operations submitted to the client that have not yet been completed. + Note: Unacked operations are a subset of this.
          +
          +
          Returns:
          +
          Total packet size of operations submitted to the client that have not yet been completed
          +
          +
          • +
        + + + +
          +
        • +

          getUnackedOperationCount

          +
          public long getUnackedOperationCount()
          +
          Returns the total number of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
          +
          +
          Returns:
          +
          Total number of operations that have been sent and are waiting for a corresponding ACK
          +
          +
          • +
        + + + +
          +
        • +

          getUnackedOperationSize

          +
          public long getUnackedOperationSize()
          +
          Returns the total packet size of operations that have been sent and are waiting for a corresponding ACK before + they can be completed.
          +
          +
          Returns:
          +
          Total packet size of operations that have been sent and are waiting for a corresponding ACK
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ClientOfflineQueueBehavior.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ClientOfflineQueueBehavior.html new file mode 100644 index 000000000..212c1edfe --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ClientOfflineQueueBehavior.html @@ -0,0 +1,473 @@ + + + + + +Mqtt5ClientOptions.ClientOfflineQueueBehavior (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum Mqtt5ClientOptions.ClientOfflineQueueBehavior

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT

          +
          public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT
          +
          Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay + in place. All other operations (QoS 0 publishes, subscribe, unsubscribe) are failed.
          +
          • +
        + + + +
          +
        • +

          FAIL_QOS0_PUBLISH_ON_DISCONNECT

          +
          public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior FAIL_QOS0_PUBLISH_ON_DISCONNECT
          +
          QoS 0 publishes that are not complete at the time of disconnection are failed. Un-acked QoS 1+ publishes are + re-queued at the head of the line for immediate retransmission on a session resumption. All other operations + are requeued in original order behind any retransmissions.
          +
          • +
        + + + +
          +
        • +

          FAIL_ALL_ON_DISCONNECT

          +
          public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior FAIL_ALL_ON_DISCONNECT
          +
          All operations that are not complete at the time of disconnection are failed, except operations that + the MQTT5 spec requires to be retransmitted (un-acked QoS1+ publishes).
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Mqtt5ClientOptions.ClientOfflineQueueBehavior[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Mqtt5ClientOptions.ClientOfflineQueueBehavior c : Mqtt5ClientOptions.ClientOfflineQueueBehavior.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Mqtt5ClientOptions.ClientOfflineQueueBehavior valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static Mqtt5ClientOptions.ClientOfflineQueueBehavior getEnumValueFromInteger​(int value)
          +
          Creates a Java ClientOfflineQueueBehavior enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for the client operation queue behavior type
          +
          Returns:
          +
          a new ClientOfflineQueueBehavior value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ClientSessionBehavior.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ClientSessionBehavior.html new file mode 100644 index 000000000..9d05be76a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ClientSessionBehavior.html @@ -0,0 +1,470 @@ + + + + + +Mqtt5ClientOptions.ClientSessionBehavior (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum Mqtt5ClientOptions.ClientSessionBehavior

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + + + + + +
          +
        • +

          REJOIN_POST_SUCCESS

          +
          public static final Mqtt5ClientOptions.ClientSessionBehavior REJOIN_POST_SUCCESS
          +
          Always attempt to rejoin an existing session after an initial connection success. + + Session rejoin requires an appropriate non-zero session expiry interval in the client's CONNECT options.
          +
          • +
        + + + +
          +
        • +

          REJOIN_ALWAYS

          +
          public static final Mqtt5ClientOptions.ClientSessionBehavior REJOIN_ALWAYS
          +
          Always attempt to rejoin an existing session. Since the client does not yet support durable session persistence, + this option is not guaranteed to be spec compliant because any unacknowledged qos1 publishes (which are + part of the client session state) will not be present on the initial connection. Until we support + durable session resumption, this option is technically spec-breaking, but useful.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Mqtt5ClientOptions.ClientSessionBehavior[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Mqtt5ClientOptions.ClientSessionBehavior c : Mqtt5ClientOptions.ClientSessionBehavior.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Mqtt5ClientOptions.ClientSessionBehavior valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static Mqtt5ClientOptions.ClientSessionBehavior getEnumValueFromInteger​(int value)
          +
          Creates a ClientSessionBehavior enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for the Client Session Behavior Type
          +
          Returns:
          +
          a new ClientSessionBehavior value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.html new file mode 100644 index 000000000..8c0addba9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.html @@ -0,0 +1,452 @@ + + + + + +Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          AWS_IOT_CORE_DEFAULTS

          +
          public static final Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions AWS_IOT_CORE_DEFAULTS
          +
          Apply additional client-side validation and operational flow control that respects the + default AWS IoT Core limits. + + Currently applies the following additional validation: + +
            +
          1. No more than 8 subscriptions per SUBSCRIBE packet
            2. +
          2. Topics and topic filters have a maximum of 7 slashes (8 segments), not counting any AWS rules prefix
            3. +
          3. Topics must be 256 bytes or less in length
            4. +
          4. Client id must be 128 or less bytes in length
            5. +
          + + Also applies the following flow control: + +
            +
          1. Outbound throughput throttled to 512KB/s
            2. +
          2. Outbound publish TPS throttled to 100
            3. +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions c : Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions getEnumValueFromInteger​(int value)
          +
          Creates a Java ExtendedValidationAndFlowControlOptions enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for the extended validation and flow control options
          +
          Returns:
          +
          a new ExtendedValidationAndFlowControlOptions value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.LifecycleEvents.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.LifecycleEvents.html new file mode 100644 index 000000000..01730805f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.LifecycleEvents.html @@ -0,0 +1,364 @@ + + + + + +Mqtt5ClientOptions.LifecycleEvents (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Interface Mqtt5ClientOptions.LifecycleEvents

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Mqtt5ClientOptions
      +
      +
      +
      public static interface Mqtt5ClientOptions.LifecycleEvents
      +
      An interface that defines all of the functions the Mqtt5Client will call when it receives a lifecycle event.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onAttemptingConnect

          +
          void onAttemptingConnect​(Mqtt5Client client,
+                         OnAttemptingConnectReturn onAttemptingConnectReturn)
          +
          Called when the client begins a connection attempt
          +
          +
          Parameters:
          +
          client - The client associated with the event
          +
          onAttemptingConnectReturn - The data associated with the onAttemptingConnect event.
          +
          +
          • +
        + + + +
          +
        • +

          onConnectionSuccess

          +
          void onConnectionSuccess​(Mqtt5Client client,
+                         OnConnectionSuccessReturn onConnectionSuccessReturn)
          +
          Called when the client successfully establishes an MQTT connection
          +
          +
          Parameters:
          +
          client - The client associated with the event
          +
          onConnectionSuccessReturn - The data associated with the onConnectionSuccess event.
          +
          +
          • +
        + + + +
          +
        • +

          onConnectionFailure

          +
          void onConnectionFailure​(Mqtt5Client client,
+                         OnConnectionFailureReturn onConnectionFailureReturn)
          +
          Called when the client fails to establish an MQTT connection
          +
          +
          Parameters:
          +
          client - The client associated with the event
          +
          onConnectionFailureReturn - The data associated with the onConnectionFailure event.
          +
          +
          • +
        + + + +
          +
        • +

          onDisconnection

          +
          void onDisconnection​(Mqtt5Client client,
+                     OnDisconnectionReturn onDisconnectionReturn)
          +
          Called when the client's current MQTT connection is closed
          +
          +
          Parameters:
          +
          client - The client associated with the event
          +
          onDisconnectionReturn - The data associated with the onDisconnection event.
          +
          +
          • +
        + + + +
          +
        • +

          onStopped

          +
          void onStopped​(Mqtt5Client client,
+               OnStoppedReturn onStoppedReturn)
          +
          Called when the client reaches the 'Stopped' state as a result of the user invoking .stop()
          +
          +
          Parameters:
          +
          client - The client associated with the event
          +
          onStoppedReturn - The data associated with the onStopped event.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder.html new file mode 100644 index 000000000..88f1de40e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder.html @@ -0,0 +1,837 @@ + + + + + +Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Mqtt5ClientOptions
      +
      +
      +
      public static final class Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder
+extends Object
      +
      All of the options for a Mqtt5Client. This includes the settings to make a connection, as well as the + event callbacks, publish callbacks, and more.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Mqtt5ClientOptionsBuilder

          +
          public Mqtt5ClientOptionsBuilder​(String hostName,
+                                 Long port)
          +
          Creates a new Mqtt5ClientOptionsBuilder instance
          +
          +
          Parameters:
          +
          hostName - The host name of the MQTT server to connect to.
          +
          port - The port of the MQTT server to connect to.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withHostName

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withHostName​(String hostName)
          +
          Sets the host name of the MQTT server to connect to.
          +
          +
          Parameters:
          +
          hostName - Host name of the MQTT server to connect to.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the host name
          +
          +
          • +
        + + + +
          +
        • +

          withPort

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withPort​(Long port)
          +
          Sets the network port of the MQTT server to connect to.
          +
          +
          Parameters:
          +
          port - Network port of the MQTT server to connect to.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the port
          +
          +
          • +
        + + + +
          +
        • +

          withBootstrap

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withBootstrap​(ClientBootstrap bootstrap)
          +
          Sets the ClientBootstrap to use. In almost all cases, this should be left null.
          +
          +
          Parameters:
          +
          bootstrap - The ClientBootstrap to use
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the ClientBootstrap
          +
          +
          • +
        + + + +
          +
        • +

          withSocketOptions

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withSocketOptions​(SocketOptions socketOptions)
          +
          Sets the socket properties of the underlying MQTT connections made by the client. Leave null to use + defaults (no TCP keep alive, 10 second socket timeout).
          +
          +
          Parameters:
          +
          socketOptions - The socket properties of the underlying MQTT connections made by the client.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the socket options
          +
          +
          • +
        + + + +
          +
        • +

          withTlsContext

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withTlsContext​(TlsContext tlsContext)
          +
          Sets the TLS context for secure socket connections. + If null, then a plaintext connection will be used.
          +
          +
          Parameters:
          +
          tlsContext - The TLS context for secure socket connections.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the TlsContext
          +
          +
          • +
        + + + +
          +
        • +

          withHttpProxyOptions

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withHttpProxyOptions​(HttpProxyOptions httpProxyOptions)
          +
          Sets the (tunneling) HTTP proxy usage when establishing MQTT connection.
          +
          +
          Parameters:
          +
          httpProxyOptions - the (tunneling) HTTP proxy usage when establishing MQTT connection.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the HttpProxyOptions
          +
          +
          • +
        + + + +
          +
        • +

          withConnectOptions

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withConnectOptions​(ConnectPacket connectOptions)
          +
          Sets all configurable options with respect to the CONNECT packet sent by the client, including the Will. These + connect properties will be used for every connection attempt made by the client.
          +
          +
          Parameters:
          +
          connectOptions - Configurable options with respect to the CONNECT packet sent by the client, including the Will.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the connect options
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withExtendedValidationAndFlowControlOptions

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withExtendedValidationAndFlowControlOptions​(Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions extendedValidationAndFlowControlOptions)
          +
          Sets the additional controls for client behavior with respect to operation validation and flow control; these checks + go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.
          +
          +
          Parameters:
          +
          extendedValidationAndFlowControlOptions - Additional controls for client behavior with respect to operation validation and flow control
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the ExtendedValidationAndFlowControlOptions
          +
          +
          • +
        + + + +
          +
        • +

          withOfflineQueueBehavior

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withOfflineQueueBehavior​(Mqtt5ClientOptions.ClientOfflineQueueBehavior offlineQueueBehavior)
          +
          Sets how disconnects affect the queued and in-progress operations tracked by the client. Also controls + how new operations are handled while the client is not connected. In particular, if the client is not connected, + then any operation that would be failed on disconnect (according to these rules) will also be rejected.
          +
          +
          Parameters:
          +
          offlineQueueBehavior - How disconnects affect the queued and in-progress operations tracked by the client
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the ClientOfflineQueueBehavior
          +
          +
          • +
        + + + +
          +
        • +

          withRetryJitterMode

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withRetryJitterMode​(ExponentialBackoffRetryOptions.JitterMode retryJitterMode)
          +
          Sets how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt + time points for a large set of reconnecting clients.
          +
          +
          Parameters:
          +
          retryJitterMode - How the reconnect delay is modified in order to smooth out the distribution of reconnection attempt + time points for a large set of reconnecting clients.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the JitterMode
          +
          +
          • +
        + + + +
          +
        • +

          withMinReconnectDelayMs

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withMinReconnectDelayMs​(Long minReconnectDelayMs)
          +
          Sets the minimum amount of time to wait to reconnect after a disconnect. Exponential back-off is performed with jitter + after each connection failure.
          +
          +
          Parameters:
          +
          minReconnectDelayMs - The minimum amount of time to wait to reconnect after a disconnect.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the minimum reconnect delay
          +
          +
          • +
        + + + +
          +
        • +

          withMaxReconnectDelayMs

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withMaxReconnectDelayMs​(Long maxReconnectDelayMs)
          +
          Sets the maximum amount of time to wait to reconnect after a disconnect. Exponential back-off is performed with jitter + after each connection failure.
          +
          +
          Parameters:
          +
          maxReconnectDelayMs - The maximum amount of time to wait to reconnect after a disconnect
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the maximum reconnect delay
          +
          +
          • +
        + + + +
          +
        • +

          withMinConnectedTimeToResetReconnectDelayMs

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withMinConnectedTimeToResetReconnectDelayMs​(Long minConnectedTimeToResetReconnectDelayMs)
          +
          Sets the minimum time needed to pass to reset the reconnect delay in milliseconds used when the Mqtt5Client connects.
          +
          +
          Parameters:
          +
          minConnectedTimeToResetReconnectDelayMs - The minimum time needed to pass to reset the reconnect delay
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the minimum time needed to pass to reset the reconnect delay
          +
          +
          • +
        + + + +
          +
        • +

          withPingTimeoutMs

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withPingTimeoutMs​(Long pingTimeoutMs)
          +
          Sets the time interval to wait after sending a PINGREQ for a PINGRESP to arrive. If one does not arrive, the client will + close the current connection.
          +
          +
          Parameters:
          +
          pingTimeoutMs - The time interval to wait after sending a PINGREQ for a PINGRESP to arrive.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the ping timeout time
          +
          +
          • +
        + + + +
          +
        • +

          withConnackTimeoutMs

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withConnackTimeoutMs​(Long connackTimeoutMs)
          +
          Sets the time interval to wait after sending a CONNECT request for a CONNACK to arrive. If one does not arrive, the + connection will be shut down.
          +
          +
          Parameters:
          +
          connackTimeoutMs - The time interval to wait after sending a CONNECT request for a CONNACK to arrive.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the timeout in milliseconds for getting a ConnAckPacket from the server
          +
          +
          • +
        + + + +
          +
        • +

          withAckTimeoutSeconds

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withAckTimeoutSeconds​(Long ackTimeoutSeconds)
          +
          Sets the time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before + failing the operation.
          +
          +
          Parameters:
          +
          ackTimeoutSeconds - The time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before + failing the operation.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the timeout in milliseconds for getting an ACK packet + from the server when performing an operation
          +
          +
          • +
        + + + +
          +
        • +

          withLifecycleEvents

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withLifecycleEvents​(Mqtt5ClientOptions.LifecycleEvents lifecycleEvents)
          +
          Sets the Lifecycle Events interface that will be called when the client gets a LifecycleEvent.
          +
          +
          Parameters:
          +
          lifecycleEvents - The LifecycleEvents interface that will be called
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the Lifecycle Events interface
          +
          +
          • +
        + + + +
          +
        • +

          withWebsocketHandshakeTransform

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withWebsocketHandshakeTransform​(Consumer<Mqtt5WebsocketHandshakeTransformArgs> handshakeTransform)
          +
          Sets the callback that allows a custom transformation of the HTTP request that acts as the websocket handshake. + Websockets will be used if this is set to a valid transformation callback. To use websockets but not perform + a transformation, just set this as a trivial completion callback. If null, the connection will be made + with direct MQTT.
          +
          +
          Parameters:
          +
          handshakeTransform - Callback that allows a custom transformation of the HTTP request that acts as the websocket handshake.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the websocket handshake transform callback
          +
          +
          • +
        + + + +
          +
        • +

          withPublishEvents

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withPublishEvents​(Mqtt5ClientOptions.PublishEvents publishEvents)
          +
          Sets the PublishEvents interface that will be called when the client gets a message.
          +
          +
          Parameters:
          +
          publishEvents - The PublishEvents interface that will be called when the client gets a message.
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder after setting the PublishEvents interface
          +
          +
          • +
        + + + +
          +
        • +

          withTopicAliasingOptions

          +
          public Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder withTopicAliasingOptions​(TopicAliasingOptions options)
          +
          Sets the topic aliasing options for clients constructed from this builder
          +
          +
          Parameters:
          +
          options - topic aliasing options that the client should use
          +
          Returns:
          +
          The Mqtt5ClientOptionsBuilder object
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public Mqtt5ClientOptions build()
          +
          Returns a Mqtt5ClientOptions class configured with all of the options set in the Mqtt5ClientOptionsBuilder. + This can then be used to make a new Mqtt5Client.
          +
          +
          Returns:
          +
          A configured Mqtt5ClientOptions
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.PublishEvents.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.PublishEvents.html new file mode 100644 index 000000000..e532c297e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.PublishEvents.html @@ -0,0 +1,268 @@ + + + + + +Mqtt5ClientOptions.PublishEvents (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Interface Mqtt5ClientOptions.PublishEvents

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Mqtt5ClientOptions
      +
      +
      +
      public static interface Mqtt5ClientOptions.PublishEvents
      +
      An interface that defines all of the publish functions the Mqtt5Client will call when it receives a publish packet.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onMessageReceived

          +
          void onMessageReceived​(Mqtt5Client client,
+                       PublishReturn publishReturn)
          +
          Called when an MQTT PUBLISH packet is received by the client
          +
          +
          Parameters:
          +
          client - The client that has received the message
          +
          publishReturn - All of the data that was received from the server
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.html new file mode 100644 index 000000000..d93369aba --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5ClientOptions.html @@ -0,0 +1,825 @@ + + + + + +Mqtt5ClientOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class Mqtt5ClientOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class Mqtt5ClientOptions
+extends Object
      +
      Configuration for the creation of Mqtt5Clients
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Mqtt5ClientOptions

          +
          public Mqtt5ClientOptions​(Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder builder)
          +
          Creates a Mqtt5ClientOptionsBuilder instance
          +
          +
          Parameters:
          +
          builder - The builder to get the Mqtt5ClientOptions values from
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getHostName

          +
          public String getHostName()
          +
          Returns the host name of the MQTT server to connect to.
          +
          +
          Returns:
          +
          Host name of the MQTT server to connect to.
          +
          +
          • +
        + + + +
          +
        • +

          getPort

          +
          public Long getPort()
          +
          Returns the network port of the MQTT server to connect to.
          +
          +
          Returns:
          +
          Network port of the MQTT server to connect to.
          +
          +
          • +
        + + + +
          +
        • +

          getBootstrap

          +
          public ClientBootstrap getBootstrap()
          +
          Returns the Client bootstrap used.
          +
          +
          Returns:
          +
          The Client bootstrap used
          +
          +
          • +
        + + + +
          +
        • +

          getSocketOptions

          +
          public SocketOptions getSocketOptions()
          +
          Returns the socket properties of the underlying MQTT connections made by the client.
          +
          +
          Returns:
          +
          the socket properties of the underlying MQTT connections made by the client or null if defaults are used.
          +
          +
          • +
        + + + +
          +
        • +

          getTlsContext

          +
          public TlsContext getTlsContext()
          +
          Returns the TLS context for secure socket connections. + If null, then a plaintext connection will be used.
          +
          +
          Returns:
          +
          TLS context for secure socket connections.
          +
          +
          • +
        + + + +
          +
        • +

          getHttpProxyOptions

          +
          public HttpProxyOptions getHttpProxyOptions()
          +
          Returns the (tunneling) HTTP proxy usage when establishing MQTT connections
          +
          +
          Returns:
          +
          (tunneling) HTTP proxy usage when establishing MQTT connections
          +
          +
          • +
        + + + +
          +
        • +

          getConnectOptions

          +
          public ConnectPacket getConnectOptions()
          +
          Returns all configurable options with respect to the CONNECT packet sent by the client, including the will. These + connect properties will be used for every connection attempt made by the client.
          +
          +
          Returns:
          +
          all configurable options with respect to the CONNECT packet sent by the client, including the will
          +
          +
          • +
        + + + +
          +
        • +

          getSessionBehavior

          +
          public Mqtt5ClientOptions.ClientSessionBehavior getSessionBehavior()
          +
          Returns how the Mqtt5Client should behave with respect to MQTT sessions.
          +
          +
          Returns:
          +
          How the Mqtt5Client should behave with respect to MQTT sessions.
          +
          +
          • +
        + + + +
          +
        • +

          getExtendedValidationAndFlowControlOptions

          +
          public Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions getExtendedValidationAndFlowControlOptions()
          +
          Returns the additional controls for client behavior with respect to operation validation and flow control; + these checks go beyond the base MQTT5 spec to respect limits of specific MQTT brokers.
          +
          +
          Returns:
          +
          The additional controls for client behavior with respect to operation validation and flow control
          +
          +
          • +
        + + + +
          +
        • +

          getOfflineQueueBehavior

          +
          public Mqtt5ClientOptions.ClientOfflineQueueBehavior getOfflineQueueBehavior()
          +
          Returns how disconnects affect the queued and in-progress operations tracked by the client. Also controls + how new operations are handled while the client is not connected. In particular, if the client is not connected, + then any operation that would be failed on disconnect (according to these rules) will also be rejected.
          +
          +
          Returns:
          +
          How disconnects affect the queued and in-progress operations tracked by the client.
          +
          +
          • +
        + + + +
          +
        • +

          getRetryJitterMode

          +
          public ExponentialBackoffRetryOptions.JitterMode getRetryJitterMode()
          +
          Returns how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt + time points for a large set of reconnecting clients.
          +
          +
          Returns:
          +
          how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt + time points for a large set of reconnecting clients.
          +
          +
          • +
        + + + +
          +
        • +

          getMinReconnectDelayMs

          +
          public Long getMinReconnectDelayMs()
          +
          Returns the minimum amount of time to wait to reconnect after a disconnect. + Exponential back-off is performed with jitter after each connection failure.
          +
          +
          Returns:
          +
          The minimum amount of time to wait to reconnect after a disconnect.
          +
          +
          • +
        + + + +
          +
        • +

          getMaxReconnectDelayMs

          +
          public Long getMaxReconnectDelayMs()
          +
          Returns the maximum amount of time to wait to reconnect after a disconnect. Exponential back-off is performed with jitter + after each connection failure.
          +
          +
          Returns:
          +
          The maximum amount of time to wait to reconnect after a disconnect
          +
          +
          • +
        + + + +
          +
        • +

          getMinConnectedTimeToResetReconnectDelayMs

          +
          public Long getMinConnectedTimeToResetReconnectDelayMs()
          +
          Returns the amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum. + This helps alleviate bandwidth-waste in fast reconnect cycles due to permission failures on operations.
          +
          +
          Returns:
          +
          The amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum
          +
          +
          • +
        + + + +
          +
        • +

          getPingTimeoutMs

          +
          public Long getPingTimeoutMs()
          +
          Returns the time interval to wait after sending a PINGREQ for a PINGRESP to arrive. If one does not arrive, the client will + close the current connection.
          +
          +
          Returns:
          +
          time interval to wait after sending a PINGREQ for a PINGRESP to arrive.
          +
          +
          • +
        + + + +
          +
        • +

          getConnackTimeoutMs

          +
          public Long getConnackTimeoutMs()
          +
          Returns the time interval to wait after sending a CONNECT request for a CONNACK to arrive. If one does not arrive, the + connection will be shut down.
          +
          +
          Returns:
          +
          Time interval to wait after sending a CONNECT request for a CONNACK to arrive
          +
          +
          • +
        + + + +
          +
        • +

          getAckTimeoutSeconds

          +
          public Long getAckTimeoutSeconds()
          +
          Returns the time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before + failing the operation.
          +
          +
          Returns:
          +
          the time interval to wait for an ack after sending a QoS 1+ PUBLISH, SUBSCRIBE, or UNSUBSCRIBE before + failing the operation.
          +
          +
          • +
        + + + +
          +
        • +

          getLifecycleEvents

          +
          public Mqtt5ClientOptions.LifecycleEvents getLifecycleEvents()
          +
          Returns the LifecycleEvents interface that will be called when the client gets a LifecycleEvent.
          +
          +
          Returns:
          +
          The LifecycleEvents interface that will be called when the client gets a LifecycleEvent
          +
          +
          • +
        + + + +
          +
        • +

          getWebsocketHandshakeTransform

          +
          public Consumer<Mqtt5WebsocketHandshakeTransformArgs> getWebsocketHandshakeTransform()
          +
          Returns the callback that allows a custom transformation of the HTTP request which acts as the websocket handshake. + Websockets will be used if this is set to a valid transformation callback. To use websockets but not perform + a transformation, just set this as a trivial completion callback. If null, the connection will be made + with direct MQTT.
          +
          +
          Returns:
          +
          The custom transformation of the HTTP request that acts as the websocket handshake or null.
          +
          +
          • +
        + + + +
          +
        • +

          getPublishEvents

          +
          public Mqtt5ClientOptions.PublishEvents getPublishEvents()
          +
          Returns the PublishEvents interface that will be called when the client gets a message.
          +
          +
          Returns:
          +
          PublishEvents interface that will be called when the client gets a message.
          +
          +
          • +
        + + + +
          +
        • +

          getTopicAliasingOptions

          +
          public TopicAliasingOptions getTopicAliasingOptions()
          +
          Returns the topic aliasing options to be used by the client
          +
          +
          Returns:
          +
          the topic aliasing options to be used by the client
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5WebsocketHandshakeTransformArgs.html b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5WebsocketHandshakeTransformArgs.html new file mode 100644 index 000000000..3f6d18fd9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/Mqtt5WebsocketHandshakeTransformArgs.html @@ -0,0 +1,401 @@ + + + + + +Mqtt5WebsocketHandshakeTransformArgs (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class Mqtt5WebsocketHandshakeTransformArgs

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Mqtt5WebsocketHandshakeTransformArgs
+extends Object
      +
      Arguments to a websocket handshake transform operation. + The transform may modify the http request before it is sent to the server. + The transform MUST call complete() or completeExceptionally() when the transform is complete, + failure to do so will stall the mqtt connection indefinitely. + The transform operation may be asynchronous. + + The default websocket handshake http request uses path "/mqtt". + All required headers for a websocket handshake are present, + plus the optional header "Sec-WebSocket-Protocol: mqtt".
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Mqtt5WebsocketHandshakeTransformArgs

          +
          public Mqtt5WebsocketHandshakeTransformArgs​(Mqtt5Client mqttClient,
+                                            HttpRequest httpRequest,
+                                            CompletableFuture<HttpRequest> future)
          +
          +
          Parameters:
          +
          mqttClient - Mqtt5Client that is establishing a websocket connection
          +
          httpRequest - http request that may be modified by the transform operation
          +
          future - Future to complete when the transform is complete.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMqttClient

          +
          public Mqtt5Client getMqttClient()
          +
          Queries the Mqtt5Client.
          +
          +
          Returns:
          +
          the Mqtt5Client.
          +
          +
          • +
        + + + +
          +
        • +

          getHttpRequest

          +
          public HttpRequest getHttpRequest()
          +
          Get the http request that will be used to perform the websocket handshake. + The transform operation may modify this request.
          +
          +
          Returns:
          +
          The http request that will be used to perform the websocket handshake
          +
          +
          • +
        + + + +
          +
        • +

          complete

          +
          public void complete​(HttpRequest signedRequest)
          +
          Mark the transform operation as successfully completed. + The websocket connection will proceed, using the http request.
          +
          +
          Parameters:
          +
          signedRequest - completed request
          +
          +
          • +
        + + + +
          +
        • +

          completeExceptionally

          +
          public void completeExceptionally​(Throwable ex)
          +
          Mark the transform operation as unsuccessfully completed. + The websocket connection attempt will be canceled.
          +
          +
          Parameters:
          +
          ex - the exception
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/NegotiatedSettings.html b/docs/software/amazon/awssdk/crt/mqtt5/NegotiatedSettings.html new file mode 100644 index 000000000..065f9792e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/NegotiatedSettings.html @@ -0,0 +1,603 @@ + + + + + +NegotiatedSettings (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class NegotiatedSettings

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.NegotiatedSettings
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class NegotiatedSettings
+extends Object
      +
      MQTT behavior settings that are dynamically negotiated as part of the CONNECT/CONNACK exchange. + + While you can infer all of these values from a combination of + (1) defaults as specified in the MQTT5 spec + (2) your CONNECT settings + (3) the CONNACK from the broker + + the client instead does the combining for you and emits a NegotiatedSettings object with final, authoritative values. + + Negotiated settings are communicated with every successful connection establishment.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NegotiatedSettings

          +
          public NegotiatedSettings()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMaximumQOS

          +
          public QOS getMaximumQOS()
          +
          +
          Returns:
          +
          Returns the maximum QoS allowed for publishes on this connection instance
          +
          +
          • +
        + + + +
          +
        • +

          getSessionExpiryIntervalSeconds

          +
          public long getSessionExpiryIntervalSeconds()
          +
          +
          Returns:
          +
          Returns the amount of time in seconds the server will retain the MQTT session after a disconnect.
          +
          +
          • +
        + + + +
          +
        • +

          getSessionExpiryInterval

          +
          public long getSessionExpiryInterval()
          +
          Deprecated. +
          prefer getSessionExpiryIntervalSeconds instead
          +
          +
          +
          Returns:
          +
          Returns the amount of time in seconds the server will retain the MQTT session after a disconnect.
          +
          +
          • +
        + + + +
          +
        • +

          getReceiveMaximumFromServer

          +
          public int getReceiveMaximumFromServer()
          +
          +
          Returns:
          +
          Returns the number of in-flight QoS 1 and QoS 2 publications the server is willing to process concurrently.
          +
          +
          • +
        + + + +
          +
        • +

          getMaximumPacketSizeToServer

          +
          public long getMaximumPacketSizeToServer()
          +
          +
          Returns:
          +
          Returns the maximum packet size the server is willing to accept.
          +
          +
          • +
        + + + +
          +
        • +

          getTopicAliasMaximumToServer

          +
          public int getTopicAliasMaximumToServer()
          +
          +
          Returns:
          +
          returns the maximum allowed topic alias value on publishes sent from client to server
          +
          +
          • +
        + + + +
          +
        • +

          getTopicAliasMaximumToClient

          +
          public int getTopicAliasMaximumToClient()
          +
          +
          Returns:
          +
          returns the maximum allowed topic alias value on publishes sent from server to client
          +
          +
          • +
        + + + +
          +
        • +

          getServerKeepAliveSeconds

          +
          public int getServerKeepAliveSeconds()
          +
          Returns the maximum amount of time in seconds between client packets. The client should use PINGREQs to ensure this + limit is not breached. The server will disconnect the client for inactivity if no MQTT packet is received + in a time interval equal to 1.5 x this value.
          +
          +
          Returns:
          +
          The maximum amount of time in seconds between client packets.
          +
          +
          • +
        + + + +
          +
        • +

          getServerKeepAlive

          +
          public int getServerKeepAlive()
          +
          Deprecated. +
          prefer getServerKeepAliveSeconds
          +
          +
          Returns the maximum amount of time in seconds between client packets. The client should use PINGREQs to ensure this + limit is not breached. The server will disconnect the client for inactivity if no MQTT packet is received + in a time interval equal to 1.5 x this value.
          +
          +
          Returns:
          +
          The maximum amount of time in seconds between client packets.
          +
          +
          • +
        + + + +
          +
        • +

          getRetainAvailable

          +
          public boolean getRetainAvailable()
          +
          +
          Returns:
          +
          Returns whether the server supports retained messages.
          +
          +
          • +
        + + + +
          +
        • +

          getWildcardSubscriptionsAvailable

          +
          public boolean getWildcardSubscriptionsAvailable()
          +
          +
          Returns:
          +
          Returns whether the server supports wildcard subscriptions.
          +
          +
          • +
        + + + +
          +
        • +

          getSubscriptionIdentifiersAvailable

          +
          public boolean getSubscriptionIdentifiersAvailable()
          +
          +
          Returns:
          +
          Returns whether the server supports subscription identifiers
          +
          +
          • +
        + + + +
          +
        • +

          getSharedSubscriptionsAvailable

          +
          public boolean getSharedSubscriptionsAvailable()
          +
          +
          Returns:
          +
          Returns whether the server supports shared subscriptions
          +
          +
          • +
        + + + +
          +
        • +

          getRejoinedSession

          +
          public boolean getRejoinedSession()
          +
          +
          Returns:
          +
          Returns whether the client has rejoined an existing session.
          +
          +
          • +
        + + + +
          +
        • +

          getAssignedClientID

          +
          public String getAssignedClientID()
          +
          Returns the final client id in use by the newly-established connection. This will be the configured client id if one + was given in the configuration, otherwise, if no client id was specified, this will be the client id assigned + by the server. Reconnection attempts will always use the auto-assigned client id, allowing for auto-assigned + session resumption.
          +
          +
          Returns:
          +
          The final client id in use by the newly-established connection
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/OnAttemptingConnectReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/OnAttemptingConnectReturn.html new file mode 100644 index 000000000..929a43c32 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/OnAttemptingConnectReturn.html @@ -0,0 +1,227 @@ + + + + + +OnAttemptingConnectReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class OnAttemptingConnectReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.OnAttemptingConnectReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnAttemptingConnectReturn
+extends Object
      +
      The data returned when AttemptingConnect is invoked in the LifecycleEvents callback. + Currently empty, but may be used in the future for passing additional data.
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/OnConnectionFailureReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/OnConnectionFailureReturn.html new file mode 100644 index 000000000..3249867f0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/OnConnectionFailureReturn.html @@ -0,0 +1,301 @@ + + + + + +OnConnectionFailureReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class OnConnectionFailureReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.OnConnectionFailureReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnConnectionFailureReturn
+extends Object
      +
      The data returned when OnConnectionFailure is invoked in the LifecycleEvents callback. + The data contained within can be gotten using the get functions. + For example, getConnAckPacket will return the ConnAckPacket from the server.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getErrorCode

          +
          public int getErrorCode()
          +
          Returns the error code returned from the server on the connection failure. + Pass to CRT.awsErrorString(int) for a human readable error.
          +
          +
          Returns:
          +
          The error code returned from the server.
          +
          +
          • +
        + + + +
          +
        • +

          getConnAckPacket

          +
          public ConnAckPacket getConnAckPacket()
          +
          Returns the ConnAckPacket returned from the server on the connection failure, or Null if none was returned.
          +
          +
          Returns:
          +
          The ConnAckPacket returned from the server.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/OnConnectionSuccessReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/OnConnectionSuccessReturn.html new file mode 100644 index 000000000..98ce3b8de --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/OnConnectionSuccessReturn.html @@ -0,0 +1,300 @@ + + + + + +OnConnectionSuccessReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class OnConnectionSuccessReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.OnConnectionSuccessReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnConnectionSuccessReturn
+extends Object
      +
      The data returned when OnConnectionSuccess is invoked in the LifecycleEvents callback. + The data contained within can be gotten using the get functions. + For example, getResultPublishPacket will return the PublishPacket from the server.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConnAckPacket

          +
          public ConnAckPacket getConnAckPacket()
          +
          Returns the ConnAckPacket returned from the server on the connection success or Null if none was returned.
          +
          +
          Returns:
          +
          The ConnAckPacket returned from the server.
          +
          +
          • +
        + + + +
          +
        • +

          getNegotiatedSettings

          +
          public NegotiatedSettings getNegotiatedSettings()
          +
          Returns the NegotiatedSettings returned from the server on the connection success or Null if none was returned.
          +
          +
          Returns:
          +
          The NegotiatedSettings returned from the server.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/OnDisconnectionReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/OnDisconnectionReturn.html new file mode 100644 index 000000000..4d546944c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/OnDisconnectionReturn.html @@ -0,0 +1,301 @@ + + + + + +OnDisconnectionReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class OnDisconnectionReturn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.OnDisconnectionReturn
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OnDisconnectionReturn
+extends Object
      +
      The data returned when OnDisconnect is invoked in the LifecycleEvents callback. + The data contained within can be gotten using the get functions. + For example, getDisconnectPacket will return the DisconnectPacket from the server.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getErrorCode

          +
          public int getErrorCode()
          +
          Returns the error code returned from the server on the disconnection. + Pass to CRT.awsErrorString(int) for a human readable error.
          +
          +
          Returns:
          +
          The error code returned from the server.
          +
          +
          • +
        + + + +
          +
        • +

          getDisconnectPacket

          +
          public DisconnectPacket getDisconnectPacket()
          +
          Returns the ConnAckPacket returned from the server on the disconnection, or Null if none was returned.
          +
          +
          Returns:
          +
          The ConnAckPacket returned from the server.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/OnStoppedReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/OnStoppedReturn.html new file mode 100644 index 000000000..a63b9fa90 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/OnStoppedReturn.html @@ -0,0 +1,227 @@ + + + + + +OnStoppedReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class OnStoppedReturn

    +
    +
    + +
    +
      +
    • +
      +
      public class OnStoppedReturn
+extends Object
      +
      The data returned when OnStopped is invoked in the LifecycleEvents callback. + Currently empty, but may be used in the future for passing additional data.
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/PublishResult.PublishResultType.html b/docs/software/amazon/awssdk/crt/mqtt5/PublishResult.PublishResultType.html new file mode 100644 index 000000000..6894b3877 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/PublishResult.PublishResultType.html @@ -0,0 +1,440 @@ + + + + + +PublishResult.PublishResultType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum PublishResult.PublishResultType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          NONE

          +
          public static final PublishResult.PublishResultType NONE
          +
          No PublishResult result data (QoS 0) + This means the PublishResult has no data and getValue will return null.
          +
          • +
        + + + +
          +
        • +

          PUBACK

          +
          public static final PublishResult.PublishResultType PUBACK
          +
          PublishResult result was a publish acknowledgment (PubAck - QoS 1) + This means the PublishResult has a PubAck and getValue will return + the PubAckPacket associated with the publish.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PublishResult.PublishResultType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PublishResult.PublishResultType c : PublishResult.PublishResultType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PublishResult.PublishResultType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static PublishResult.PublishResultType getEnumValueFromInteger​(int value)
          +
          Creates a Java PublishResultType enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for PublishResultType
          +
          Returns:
          +
          a new PublishResultType value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/PublishResult.html b/docs/software/amazon/awssdk/crt/mqtt5/PublishResult.html new file mode 100644 index 000000000..c833f9eea --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/PublishResult.html @@ -0,0 +1,355 @@ + + + + + +PublishResult (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class PublishResult

    +
    +
    + +
    +
      +
    • +
      +
      public class PublishResult
+extends Object
      +
      The type of data returned after calling Publish on an Mqtt5Client. The data contained varies depending + on the publish and its configuration. Use getType() to figure out what type of data is contained and either + getData() to get the data and cast it, or call getResult[Type name here]() to get the data already cast.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getType

          +
          public PublishResult.PublishResultType getType()
          +
          Returns the type of data that was returned after calling Publish on the Mqtt5Client. + You can use this information to determine what type of data is contained and either + getData() to get the data and cast it, or call getResult[Type name here]() to + get the data already cast.
          +
          +
          Returns:
          +
          The type of data contained in the PublishResult
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public Object getValue()
          +
          Returns the data contained in the PubAck result. This is based on the PublishResultType, + which is determined by the QoS setting in the published message. + + Note: To get the data type from this function, you will need to cast. For example, to get + the PubAck from result type of PUBACK, you will need to use the following: + PubAckPacket packet = (PubAckPacket)getValue()
          +
          +
          Returns:
          +
          The data contained in the PublishResult result
          +
          +
          • +
        + + + +
          +
        • +

          getResultPubAck

          +
          public PubAckPacket getResultPubAck()
          +
          Returns the data contained in the PublishResult for a PublishResultType of PUBACK. + This occurs for QoS 1 and will return a PubAckPacket.
          +
          +
          Returns:
          +
          the data contained in the PublishResult for a PublishResultType of PUBACK.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/PublishReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/PublishReturn.html new file mode 100644 index 000000000..7e80d80f0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/PublishReturn.html @@ -0,0 +1,279 @@ + + + + + +PublishReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class PublishReturn

    +
    +
    + +
    +
      +
    • +
      +
      public class PublishReturn
+extends Object
      +
      The data returned when a publish is made to a topic the MQTT5 client is subscribed to. + The data contained within can be gotten using the get functions. + For example, getPublishPacket will return the PublishPacket received from the server.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPublishPacket

          +
          public PublishPacket getPublishPacket()
          +
          Returns the PublishPacket returned from the server or Null if none was returned.
          +
          +
          Returns:
          +
          The PublishPacket returned from the server.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/QOS.html b/docs/software/amazon/awssdk/crt/mqtt5/QOS.html new file mode 100644 index 000000000..34e656969 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/QOS.html @@ -0,0 +1,448 @@ + + + + + +QOS (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum QOS

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          AT_MOST_ONCE

          +
          public static final QOS AT_MOST_ONCE
          +
          The message is delivered according to the capabilities of the underlying network. No response is sent by the + receiver and no retry is performed by the sender. The message arrives at the receiver either once or not at all.
          +
          • +
        + + + +
          +
        • +

          AT_LEAST_ONCE

          +
          public static final QOS AT_LEAST_ONCE
          +
          A level of service that ensures that the message arrives at the receiver at least once.
          +
          • +
        + + + +
          +
        • +

          EXACTLY_ONCE

          +
          public static final QOS EXACTLY_ONCE
          +
          A level of service that ensures that the message arrives at the receiver exactly once.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static QOS[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (QOS c : QOS.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static QOS valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static QOS getEnumValueFromInteger​(int value)
          +
          Creates a Java QualityOfService enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for quality of service
          +
          Returns:
          +
          a new QualityOfService value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.InboundTopicAliasBehaviorType.html b/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.InboundTopicAliasBehaviorType.html new file mode 100644 index 000000000..2c625439d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.InboundTopicAliasBehaviorType.html @@ -0,0 +1,453 @@ + + + + + +TopicAliasingOptions.InboundTopicAliasBehaviorType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum TopicAliasingOptions.InboundTopicAliasBehaviorType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TopicAliasingOptions.InboundTopicAliasBehaviorType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TopicAliasingOptions.InboundTopicAliasBehaviorType c : TopicAliasingOptions.InboundTopicAliasBehaviorType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TopicAliasingOptions.InboundTopicAliasBehaviorType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static TopicAliasingOptions.InboundTopicAliasBehaviorType getEnumValueFromInteger​(int value)
          +
          Creates a Java InboundTopicAliasBehaviorType enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for the InboundTopicAliasBehaviorType value
          +
          Returns:
          +
          a new InboundTopicAliasBehaviorType value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.OutboundTopicAliasBehaviorType.html b/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.OutboundTopicAliasBehaviorType.html new file mode 100644 index 000000000..fb1e395b7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.OutboundTopicAliasBehaviorType.html @@ -0,0 +1,475 @@ + + + + + +TopicAliasingOptions.OutboundTopicAliasBehaviorType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Enum TopicAliasingOptions.OutboundTopicAliasBehaviorType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          Manual

          +
          public static final TopicAliasingOptions.OutboundTopicAliasBehaviorType Manual
          +
          Outbound aliasing is the user's responsibility. Client will cache and use + previously-established aliases if they fall within the negotiated limits of the connection. + + The user must still always submit a full topic in their publishes because disconnections disrupt + topic alias mappings unpredictably. The client will properly use a requested alias when the most-recently-seen + binding for a topic alias value matches the alias and topic in the publish packet.
          +
          • +
        + + + + + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TopicAliasingOptions.OutboundTopicAliasBehaviorType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TopicAliasingOptions.OutboundTopicAliasBehaviorType c : TopicAliasingOptions.OutboundTopicAliasBehaviorType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TopicAliasingOptions.OutboundTopicAliasBehaviorType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static TopicAliasingOptions.OutboundTopicAliasBehaviorType getEnumValueFromInteger​(int value)
          +
          Creates a Java OutboundTopicAliasBehaviorType enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for the OutboundTopicAliasBehaviorType value
          +
          Returns:
          +
          a new OutboundTopicAliasBehaviorType value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.html b/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.html new file mode 100644 index 000000000..f528281d2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/TopicAliasingOptions.html @@ -0,0 +1,443 @@ + + + + + +TopicAliasingOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5
    +

    Class TopicAliasingOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class TopicAliasingOptions
+extends Object
      +
      Configuration for all client topic aliasing behavior.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TopicAliasingOptions

          +
          public TopicAliasingOptions()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withOutboundBehavior

          +
          public TopicAliasingOptions withOutboundBehavior​(TopicAliasingOptions.OutboundTopicAliasBehaviorType behavior)
          +
          Controls what kind of outbound topic aliasing behavior the client should attempt to use. + + If topic aliasing is not supported by the server, this setting has no effect and any attempts to directly + manipulate the topic alias id in outbound publishes will be ignored. + + By default, outbound topic aliasing is disabled.
          +
          +
          Parameters:
          +
          behavior - outbound topic alias behavior to use
          +
          Returns:
          +
          the topic aliasing options object
          +
          +
          • +
        + + + +
          +
        • +

          withOutboundCacheMaxSize

          +
          public TopicAliasingOptions withOutboundCacheMaxSize​(int size)
          +
          If outbound topic aliasing is set to LRU, this controls the maximum size of the cache. If outbound topic + aliasing is set to LRU and this is zero or undefined, a sensible default is used (25). If outbound topic + aliasing is not set to LRU, then this setting has no effect. + + The final size of the cache is determined by the minimum of this setting and the value of the + topic_alias_maximum property of the received CONNACK. If the received CONNACK does not have an explicit + positive value for that field, outbound topic aliasing is disabled for the duration of that connection.
          +
          +
          Parameters:
          +
          size - maximum size to use for the outbound alias cache
          +
          Returns:
          +
          the topic aliasing options object
          +
          +
          • +
        + + + +
          +
        • +

          withInboundBehavior

          +
          public TopicAliasingOptions withInboundBehavior​(TopicAliasingOptions.InboundTopicAliasBehaviorType behavior)
          +
          Controls whether or not the client allows the broker to use topic aliasing when sending publishes. Even if + inbound topic aliasing is enabled, it is up to the server to choose whether or not to use it. + + If left undefined, then inbound topic aliasing is disabled.
          +
          +
          Parameters:
          +
          behavior - inbound topic alias behavior to use
          +
          Returns:
          +
          the topic aliasing options object
          +
          +
          • +
        + + + +
          +
        • +

          withInboundCacheMaxSize

          +
          public TopicAliasingOptions withInboundCacheMaxSize​(int size)
          +
          If inbound topic aliasing is enabled, this will control the size of the inbound alias cache. If inbound + aliases are enabled and this is zero or undefined, then a sensible default will be used (25). If inbound + aliases are disabled, this setting has no effect. + + Behaviorally, this value overrides anything present in the topic_alias_maximum field of + the CONNECT packet options.
          +
          +
          Parameters:
          +
          size - maximum size to use for the inbound alias cache
          +
          Returns:
          +
          the topic aliasing options object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5Client.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5Client.html new file mode 100644 index 000000000..8d17b0e02 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5Client.html @@ -0,0 +1,331 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5Client (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5Client

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOperationStatistics.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOperationStatistics.html new file mode 100644 index 000000000..e8c6ca100 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOperationStatistics.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOperationStatistics

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ClientOfflineQueueBehavior.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ClientOfflineQueueBehavior.html new file mode 100644 index 000000000..6c01f9f2e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ClientOfflineQueueBehavior.html @@ -0,0 +1,236 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ClientSessionBehavior.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ClientSessionBehavior.html new file mode 100644 index 000000000..d0d3670ae --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ClientSessionBehavior.html @@ -0,0 +1,236 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientSessionBehavior

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.html new file mode 100644 index 000000000..16fe93774 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.html @@ -0,0 +1,238 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.LifecycleEvents.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.LifecycleEvents.html new file mode 100644 index 000000000..f1c221b5c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.LifecycleEvents.html @@ -0,0 +1,214 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.LifecycleEvents

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder.html new file mode 100644 index 000000000..698a7ce24 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder.html @@ -0,0 +1,355 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.PublishEvents.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.PublishEvents.html new file mode 100644 index 000000000..0a54bf01c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.PublishEvents.html @@ -0,0 +1,214 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.PublishEvents (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.PublishEvents

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.html new file mode 100644 index 000000000..7002c2751 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5ClientOptions.html @@ -0,0 +1,219 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5WebsocketHandshakeTransformArgs.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5WebsocketHandshakeTransformArgs.html new file mode 100644 index 000000000..e9a134e25 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/Mqtt5WebsocketHandshakeTransformArgs.html @@ -0,0 +1,214 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.Mqtt5WebsocketHandshakeTransformArgs

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/NegotiatedSettings.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/NegotiatedSettings.html new file mode 100644 index 000000000..b930aba83 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/NegotiatedSettings.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.NegotiatedSettings (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.NegotiatedSettings

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnAttemptingConnectReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnAttemptingConnectReturn.html new file mode 100644 index 000000000..72e209544 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnAttemptingConnectReturn.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.OnAttemptingConnectReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.OnAttemptingConnectReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnConnectionFailureReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnConnectionFailureReturn.html new file mode 100644 index 000000000..1ae3603fc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnConnectionFailureReturn.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.OnConnectionFailureReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.OnConnectionFailureReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnConnectionSuccessReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnConnectionSuccessReturn.html new file mode 100644 index 000000000..fdafa284f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnConnectionSuccessReturn.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.OnConnectionSuccessReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.OnConnectionSuccessReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnDisconnectionReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnDisconnectionReturn.html new file mode 100644 index 000000000..b23caa619 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnDisconnectionReturn.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.OnDisconnectionReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.OnDisconnectionReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnStoppedReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnStoppedReturn.html new file mode 100644 index 000000000..0b7f0cc41 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/OnStoppedReturn.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.OnStoppedReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.OnStoppedReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishResult.PublishResultType.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishResult.PublishResultType.html new file mode 100644 index 000000000..ef4c8bb81 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishResult.PublishResultType.html @@ -0,0 +1,219 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.PublishResult.PublishResultType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishResult.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishResult.html new file mode 100644 index 000000000..4202b8462 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishResult.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.PublishResult (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.PublishResult

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishReturn.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishReturn.html new file mode 100644 index 000000000..26cd5d5d4 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/PublishReturn.html @@ -0,0 +1,198 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.PublishReturn (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.PublishReturn

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/QOS.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/QOS.html new file mode 100644 index 000000000..cdca3ec97 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/QOS.html @@ -0,0 +1,319 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.QOS (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.QOS

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.InboundTopicAliasBehaviorType.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.InboundTopicAliasBehaviorType.html new file mode 100644 index 000000000..42cb6fa53 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.InboundTopicAliasBehaviorType.html @@ -0,0 +1,229 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.OutboundTopicAliasBehaviorType.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.OutboundTopicAliasBehaviorType.html new file mode 100644 index 000000000..3191eae9c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.OutboundTopicAliasBehaviorType.html @@ -0,0 +1,229 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.html b/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.html new file mode 100644 index 000000000..f804d8676 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/class-use/TopicAliasingOptions.html @@ -0,0 +1,242 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/package-summary.html b/docs/software/amazon/awssdk/crt/mqtt5/package-summary.html new file mode 100644 index 000000000..364ce70cf --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/package-summary.html @@ -0,0 +1,330 @@ + + + + + +software.amazon.awssdk.crt.mqtt5 (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.mqtt5

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/package-tree.html b/docs/software/amazon/awssdk/crt/mqtt5/package-tree.html new file mode 100644 index 000000000..1a766605a --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/package-tree.html @@ -0,0 +1,210 @@ + + + + + +software.amazon.awssdk.crt.mqtt5 Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.mqtt5

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/package-use.html b/docs/software/amazon/awssdk/crt/mqtt5/package-use.html new file mode 100644 index 000000000..ecd00d737 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/package-use.html @@ -0,0 +1,374 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.mqtt5 (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.mqtt5

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnAckPacket.ConnectReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnAckPacket.ConnectReasonCode.html new file mode 100644 index 000000000..9b79804f8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnAckPacket.ConnectReasonCode.html @@ -0,0 +1,769 @@ + + + + + +ConnAckPacket.ConnectReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum ConnAckPacket.ConnectReasonCode

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        BAD_AUTHENTICATION_METHOD +
        Returned when the authentication method used in the connection is either nor supported on the server or it does + not match the authentication method currently in use in the ConnectPacket.
        +
        BAD_USERNAME_OR_PASSWORD +
        Returned when the server does not accept the username and/or password specified by the client + in the connection packet.
        +
        BANNED +
        Returned when the client has been banned by the server.
        +
        CLIENT_IDENTIFIER_NOT_VALID +
        Returned when the client identifier in the ConnectPacket is a valid string but not one that + is allowed on the server.
        +
        CONNECTION_RATE_EXCEEDED +
        Returned when the server connection rate limit has been exceeded.
        +
        IMPLEMENTATION_SPECIFIC_ERROR +
        Returned when the ConnectPacket is valid but was not accepted by the server.
        +
        MALFORMED_PACKET +
        Returned when data in the ConnectPacket could not be correctly parsed by the server.
        +
        NOT_AUTHORIZED +
        Returned when the client is not authorized to connect to the server.
        +
        PACKET_TOO_LARGE +
        Returned when the ConnectPacket exceeded the maximum permissible size on the server.
        +
        PAYLOAD_FORMAT_INVALID +
        Returned when the Will payload in the ConnectPacket does not match the specified payload format indicator.
        +
        PROTOCOL_ERROR +
        Returned when data in the ConnectPacket does not conform to the MQTT5 specification requirements.
        +
        QOS_NOT_SUPPORTED +
        Returned when the server does not support the QOS setting set in the Will QOS in the ConnectPacket.
        +
        QUOTA_EXCEEDED +
        Returned when the quota limits set on the server have been met and/or exceeded.
        +
        RETAIN_NOT_SUPPORTED +
        Returned when the server does not retain messages but the ConnectPacket on the client had Will retain enabled.
        +
        SERVER_BUSY +
        Returned when the server is too busy to make a connection.
        +
        SERVER_MOVED +
        Returned when the server is telling the client to permanently use another server instead of the one they + are trying to connect to.
        +
        SERVER_UNAVAILABLE +
        Returned when the MQTT5 server is not available.
        +
        SUCCESS +
        Returned when the connection is accepted.
        +
        TOPIC_NAME_INVALID +
        Returned when the Will topic name sent in the ConnectPacket is correctly formed, but is not accepted by + the server.
        +
        UNSPECIFIED_ERROR +
        Returned when the server has a failure but does not want to specify a reason or none + of the other reason codes apply.
        +
        UNSUPPORTED_PROTOCOL_VERSION +
        Returned when the server does not support MQTT5 protocol version specified in the connection.
        +
        USE_ANOTHER_SERVER +
        Returned when the server is telling the client to temporarily use another server instead of the one they + are trying to connect to.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          UNSPECIFIED_ERROR

          +
          public static final ConnAckPacket.ConnectReasonCode UNSPECIFIED_ERROR
          +
          Returned when the server has a failure but does not want to specify a reason or none + of the other reason codes apply.
          +
          • +
        + + + +
          +
        • +

          MALFORMED_PACKET

          +
          public static final ConnAckPacket.ConnectReasonCode MALFORMED_PACKET
          +
          Returned when data in the ConnectPacket could not be correctly parsed by the server.
          +
          • +
        + + + +
          +
        • +

          PROTOCOL_ERROR

          +
          public static final ConnAckPacket.ConnectReasonCode PROTOCOL_ERROR
          +
          Returned when data in the ConnectPacket does not conform to the MQTT5 specification requirements.
          +
          • +
        + + + +
          +
        • +

          IMPLEMENTATION_SPECIFIC_ERROR

          +
          public static final ConnAckPacket.ConnectReasonCode IMPLEMENTATION_SPECIFIC_ERROR
          +
          Returned when the ConnectPacket is valid but was not accepted by the server.
          +
          • +
        + + + +
          +
        • +

          UNSUPPORTED_PROTOCOL_VERSION

          +
          public static final ConnAckPacket.ConnectReasonCode UNSUPPORTED_PROTOCOL_VERSION
          +
          Returned when the server does not support MQTT5 protocol version specified in the connection.
          +
          • +
        + + + +
          +
        • +

          CLIENT_IDENTIFIER_NOT_VALID

          +
          public static final ConnAckPacket.ConnectReasonCode CLIENT_IDENTIFIER_NOT_VALID
          +
          Returned when the client identifier in the ConnectPacket is a valid string but not one that + is allowed on the server.
          +
          • +
        + + + +
          +
        • +

          BAD_USERNAME_OR_PASSWORD

          +
          public static final ConnAckPacket.ConnectReasonCode BAD_USERNAME_OR_PASSWORD
          +
          Returned when the server does not accept the username and/or password specified by the client + in the connection packet.
          +
          • +
        + + + +
          +
        • +

          NOT_AUTHORIZED

          +
          public static final ConnAckPacket.ConnectReasonCode NOT_AUTHORIZED
          +
          Returned when the client is not authorized to connect to the server.
          +
          • +
        + + + + + + + +
          +
        • +

          SERVER_BUSY

          +
          public static final ConnAckPacket.ConnectReasonCode SERVER_BUSY
          +
          Returned when the server is too busy to make a connection. It is recommended that the client try again later.
          +
          • +
        + + + + + + + +
          +
        • +

          BAD_AUTHENTICATION_METHOD

          +
          public static final ConnAckPacket.ConnectReasonCode BAD_AUTHENTICATION_METHOD
          +
          Returned when the authentication method used in the connection is either nor supported on the server or it does + not match the authentication method currently in use in the ConnectPacket.
          +
          • +
        + + + +
          +
        • +

          TOPIC_NAME_INVALID

          +
          public static final ConnAckPacket.ConnectReasonCode TOPIC_NAME_INVALID
          +
          Returned when the Will topic name sent in the ConnectPacket is correctly formed, but is not accepted by + the server.
          +
          • +
        + + + +
          +
        • +

          PACKET_TOO_LARGE

          +
          public static final ConnAckPacket.ConnectReasonCode PACKET_TOO_LARGE
          +
          Returned when the ConnectPacket exceeded the maximum permissible size on the server.
          +
          • +
        + + + +
          +
        • +

          QUOTA_EXCEEDED

          +
          public static final ConnAckPacket.ConnectReasonCode QUOTA_EXCEEDED
          +
          Returned when the quota limits set on the server have been met and/or exceeded.
          +
          • +
        + + + +
          +
        • +

          PAYLOAD_FORMAT_INVALID

          +
          public static final ConnAckPacket.ConnectReasonCode PAYLOAD_FORMAT_INVALID
          +
          Returned when the Will payload in the ConnectPacket does not match the specified payload format indicator.
          +
          • +
        + + + +
          +
        • +

          RETAIN_NOT_SUPPORTED

          +
          public static final ConnAckPacket.ConnectReasonCode RETAIN_NOT_SUPPORTED
          +
          Returned when the server does not retain messages but the ConnectPacket on the client had Will retain enabled.
          +
          • +
        + + + +
          +
        • +

          QOS_NOT_SUPPORTED

          +
          public static final ConnAckPacket.ConnectReasonCode QOS_NOT_SUPPORTED
          +
          Returned when the server does not support the QOS setting set in the Will QOS in the ConnectPacket.
          +
          • +
        + + + +
          +
        • +

          USE_ANOTHER_SERVER

          +
          public static final ConnAckPacket.ConnectReasonCode USE_ANOTHER_SERVER
          +
          Returned when the server is telling the client to temporarily use another server instead of the one they + are trying to connect to.
          +
          • +
        + + + +
          +
        • +

          SERVER_MOVED

          +
          public static final ConnAckPacket.ConnectReasonCode SERVER_MOVED
          +
          Returned when the server is telling the client to permanently use another server instead of the one they + are trying to connect to.
          +
          • +
        + + + +
          +
        • +

          CONNECTION_RATE_EXCEEDED

          +
          public static final ConnAckPacket.ConnectReasonCode CONNECTION_RATE_EXCEEDED
          +
          Returned when the server connection rate limit has been exceeded.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ConnAckPacket.ConnectReasonCode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ConnAckPacket.ConnectReasonCode c : ConnAckPacket.ConnectReasonCode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ConnAckPacket.ConnectReasonCode valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static ConnAckPacket.ConnectReasonCode getEnumValueFromInteger​(int value)
          +
          Creates a Java ConnectReasonCode enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for ConnectReasonCode
          +
          Returns:
          +
          a new ConnectReasonCode value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnAckPacket.html new file mode 100644 index 000000000..c6bf1d626 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnAckPacket.html @@ -0,0 +1,785 @@ + + + + + +ConnAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class ConnAckPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConnAckPacket

          +
          public ConnAckPacket()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSessionPresent

          +
          public boolean getSessionPresent()
          +
          Returns true if the client rejoined an existing session on the server, false otherwise. + + See MQTT5 Session Present
          +
          +
          Returns:
          +
          True if the client rejoined an existing session on the server, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getReasonCode

          +
          public ConnAckPacket.ConnectReasonCode getReasonCode()
          +
          Returns an indicator that is either success or the reason for failure for the connection attempt. + + See MQTT5 Connect Reason Code
          +
          +
          Returns:
          +
          Code indicating either success or the reason for failure for the connection attempt.
          +
          +
          • +
        + + + +
          +
        • +

          getSessionExpiryIntervalSeconds

          +
          public Long getSessionExpiryIntervalSeconds()
          +
          Returns a time interval, in seconds, that the server will persist this connection's MQTT session state + for. If present, this value overrides any session expiry specified in the preceding ConnectPacket. + + See MQTT5 Session Expiry Interval
          +
          +
          Returns:
          +
          A time interval, in seconds, that the server will persist this connection's MQTT session state for.
          +
          +
          • +
        + + + +
          +
        • +

          getSessionExpiryInterval

          +
          public Long getSessionExpiryInterval()
          +
          Deprecated. +
          prefer getSessionExpiryIntervalSeconds
          +
          +
          Returns a time interval, in seconds, that the server will persist this connection's MQTT session state + for. If present, this value overrides any session expiry specified in the preceding ConnectPacket. + + See MQTT5 Session Expiry Interval
          +
          +
          Returns:
          +
          A time interval, in seconds, that the server will persist this connection's MQTT session state for.
          +
          +
          • +
        + + + +
          +
        • +

          getReceiveMaximum

          +
          public Integer getReceiveMaximum()
          +
          Returns the maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once. If omitted or null, + the limit is based on the valid MQTT packet id space (65535). + + See MQTT5 Receive Maximum
          +
          +
          Returns:
          +
          The maximum amount of in-flight QoS 1 or 2 messages that the server is willing to handle at once.
          +
          +
          • +
        + + + +
          +
        • +

          getMaximumQOS

          +
          public QOS getMaximumQOS()
          +
          Returns the maximum message delivery quality of service that the server will allow on this connection. + + See MQTT5 Maximum QoS
          +
          +
          Returns:
          +
          The maximum message delivery quality of service that the server will allow on this connection.
          +
          +
          • +
        + + + +
          +
        • +

          getRetainAvailable

          +
          public Boolean getRetainAvailable()
          +
          Returns an indicator whether the server supports retained messages. If null, retained messages are + supported. + + See MQTT5 Retain Available
          +
          +
          Returns:
          +
          Whether the server supports retained messages
          +
          +
          • +
        + + + +
          +
        • +

          getMaximumPacketSize

          +
          public Long getMaximumPacketSize()
          +
          Returns the maximum packet size, in bytes, that the server is willing to accept. If null, there + is no limit beyond what is imposed by the MQTT spec itself. + + See MQTT5 Maximum Packet Size
          +
          +
          Returns:
          +
          The maximum packet size, in bytes, that the server is willing to accept.
          +
          +
          • +
        + + + +
          +
        • +

          getAssignedClientIdentifier

          +
          public String getAssignedClientIdentifier()
          +
          Returns a client identifier assigned to this connection by the server. Only valid when the client id of + the preceding ConnectPacket was left empty. + + See MQTT5 Assigned Client Identifier
          +
          +
          Returns:
          +
          Client identifier assigned to this connection by the server
          +
          +
          • +
        + + + +
          +
        • +

          getTopicAliasMaximum

          +
          public Integer getTopicAliasMaximum()
          +
          Returns the maximum topic alias value that the server will accept from the client. + + See MQTT5 Topic Alias Maximum
          +
          +
          Returns:
          +
          maximum allowed topic alias value
          +
          +
          • +
        + + + +
          +
        • +

          getReasonString

          +
          public String getReasonString()
          +
          Returns additional diagnostic information about the result of the connection attempt. + + See MQTT5 Reason String
          +
          +
          Returns:
          +
          Additional diagnostic information about the result of the connection attempt.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        + + + +
          +
        • +

          getWildcardSubscriptionsAvailable

          +
          public Boolean getWildcardSubscriptionsAvailable()
          +
          Returns whether the server supports wildcard subscriptions. If null, wildcard subscriptions + are supported. + + See MQTT5 Wildcard Subscriptions Available
          +
          +
          Returns:
          +
          Whether the server supports wildcard subscriptions.
          +
          +
          • +
        + + + +
          +
        • +

          getSubscriptionIdentifiersAvailable

          +
          public Boolean getSubscriptionIdentifiersAvailable()
          +
          Returns whether the server supports subscription identifiers. If null, subscription identifiers + are supported. + + See MQTT5 Subscription Identifiers Available
          +
          +
          Returns:
          +
          whether the server supports subscription identifiers.
          +
          +
          • +
        + + + +
          +
        • +

          getSharedSubscriptionsAvailable

          +
          public Boolean getSharedSubscriptionsAvailable()
          +
          Returns whether the server supports shared subscription topic filters. If null, shared subscriptions + are supported. + + See MQTT5 Shared Subscriptions Available
          +
          +
          Returns:
          +
          whether the server supports shared subscription topic filters.
          +
          +
          • +
        + + + +
          +
        • +

          getServerKeepAliveSeconds

          +
          public Integer getServerKeepAliveSeconds()
          +
          Returns server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent + by the client should be used. + + See MQTT5 Server Keep Alive
          +
          +
          Returns:
          +
          Server-requested override of the keep alive interval, in seconds
          +
          +
          • +
        + + + +
          +
        • +

          getServerKeepAlive

          +
          public Integer getServerKeepAlive()
          +
          Deprecated. +
          prefer getServerKeepAliveSeconds
          +
          +
          Returns server-requested override of the keep alive interval, in seconds. If null, the keep alive value sent + by the client should be used. + + See MQTT5 Server Keep Alive
          +
          +
          Returns:
          +
          Server-requested override of the keep alive interval, in seconds
          +
          +
          • +
        + + + +
          +
        • +

          getResponseInformation

          +
          public String getResponseInformation()
          +
          Returns a value that can be used in the creation of a response topic associated with this connection. MQTT5-based + request/response is outside the purview of the MQTT5 spec and this client. + + See MQTT5 Response Information
          +
          +
          Returns:
          +
          A value that can be used in the creation of a response topic associated with this connection.
          +
          +
          • +
        + + + +
          +
        • +

          getServerReference

          +
          public String getServerReference()
          +
          Returns property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint. Will only be set if the reason code indicates another + server may be used (ServerMoved, UseAnotherServer). + + See MQTT5 Server Reference
          +
          +
          Returns:
          +
          Property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnectPacket.ConnectPacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnectPacket.ConnectPacketBuilder.html new file mode 100644 index 000000000..1782ba6c6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnectPacket.ConnectPacketBuilder.html @@ -0,0 +1,660 @@ + + + + + +ConnectPacket.ConnectPacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class ConnectPacket.ConnectPacketBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ConnectPacket
      +
      +
      +
      public static final class ConnectPacket.ConnectPacketBuilder
+extends Object
      +
      A class to that allows for the creation of a ConnectPacket. Set all of the settings you want in the + packet and then use the build() function to get a ConnectPacket populated with the settings + defined in the builder.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConnectPacketBuilder

          +
          public ConnectPacketBuilder()
          +
          Creates a new ConnectPacketBuilder so a ConnectPacket can be created.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withKeepAliveIntervalSeconds

          +
          public ConnectPacket.ConnectPacketBuilder withKeepAliveIntervalSeconds​(Long keepAliveInteralSeconds)
          +
          Sets the maximum time interval, in seconds, that is permitted to elapse between the point at which the client + finishes transmitting one MQTT packet and the point it starts sending the next. The client will use + PINGREQ packets to maintain this property. + + If the responding ConnAckPacket contains a keep alive property value, then that is the negotiated keep alive value. + Otherwise, the keep alive sent by the client is the negotiated value. + + See MQTT5 Keep Alive + + NOTE: The keepAliveIntervalSeconds HAS to be larger than the pingTimeoutMs time set in the Mqtt5ClientOptions.
          +
          +
          Parameters:
          +
          keepAliveInteralSeconds - the maximum time interval, in seconds, that is permitted to elapse between the point + at which the client finishes transmitting one MQTT packet and the point it starts sending the next.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the keep alive interval.
          +
          +
          • +
        + + + +
          +
        • +

          withClientId

          +
          public ConnectPacket.ConnectPacketBuilder withClientId​(String clientId)
          +
          Sets the unique string identifying the client to the server. Used to restore session state between connections. + + If left empty, the broker will auto-assign a unique client id. When reconnecting, the Mqtt5Client will + always use the auto-assigned client id. + + See MQTT5 Client Identifier
          +
          +
          Parameters:
          +
          clientId - A unique string identifying the client to the server.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the client ID.
          +
          +
          • +
        + + + +
          +
        • +

          withUsername

          +
          public ConnectPacket.ConnectPacketBuilder withUsername​(String username)
          +
          Sets the string value that the server may use for client authentication and authorization. + + See MQTT5 User Name
          +
          +
          Parameters:
          +
          username - The string value that the server may use for client authentication and authorization.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the username.
          +
          +
          • +
        + + + +
          +
        • +

          withPassword

          +
          public ConnectPacket.ConnectPacketBuilder withPassword​(byte[] password)
          +
          Sets the opaque binary data that the server may use for client authentication and authorization. + + See MQTT5 Password
          +
          +
          Parameters:
          +
          password - Opaque binary data that the server may use for client authentication and authorization.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the password.
          +
          +
          • +
        + + + +
          +
        • +

          withSessionExpiryIntervalSeconds

          +
          public ConnectPacket.ConnectPacketBuilder withSessionExpiryIntervalSeconds​(Long sessionExpiryIntervalSeconds)
          +
          Sets the time interval, in seconds, that the client requests the server to persist this connection's MQTT session state + for. Has no meaning if the client has not been configured to rejoin sessions. Must be non-zero in order to + successfully rejoin a session. + + If the responding ConnAckPacket contains a session expiry property value, then that is the negotiated session expiry + value. Otherwise, the session expiry sent by the client is the negotiated value. + + See MQTT5 Session Expiry Interval
          +
          +
          Parameters:
          +
          sessionExpiryIntervalSeconds - A time interval, in seconds, that the client requests the server to persist this + connection's MQTT session state for.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the session expiry interval.
          +
          +
          • +
        + + + +
          +
        • +

          withRequestResponseInformation

          +
          public ConnectPacket.ConnectPacketBuilder withRequestResponseInformation​(Boolean requestResponseInformation)
          +
          Sets whether requests that the server send response information in the subsequent ConnAckPacket. This response + information may be used to set up request-response implementations over MQTT, but doing so is outside + the scope of the MQTT5 spec and client. + + See MQTT5 Request Response Information
          +
          +
          Parameters:
          +
          requestResponseInformation - If true, requests that the server send response information in the subsequent ConnAckPacket.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the request response information.
          +
          +
          • +
        + + + +
          +
        • +

          withRequestProblemInformation

          +
          public ConnectPacket.ConnectPacketBuilder withRequestProblemInformation​(Boolean requestProblemInformation)
          +
          Sets whether requests that the server send additional diagnostic information (via response string or + user properties) in DisconnectPacket or ConnAckPacket from the server. + + See MQTT5 Request Problem Information
          +
          +
          Parameters:
          +
          requestProblemInformation - If true, requests that the server send additional diagnostic information + (via response string or user properties) in DisconnectPacket or ConnAckPacket from the server.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the request problem information.
          +
          +
          • +
        + + + +
          +
        • +

          withReceiveMaximum

          +
          public ConnectPacket.ConnectPacketBuilder withReceiveMaximum​(Long receiveMaximum)
          +
          Sets the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle. If + omitted or null, then no limit is requested. + + See MQTT5 Receive Maximum
          +
          +
          Parameters:
          +
          receiveMaximum - The maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the receive maximum.
          +
          +
          • +
        + + + +
          +
        • +

          withMaximumPacketSizeBytes

          +
          public ConnectPacket.ConnectPacketBuilder withMaximumPacketSizeBytes​(Long maximumPacketSizeBytes)
          +
          Sets the maximum packet size the client is willing to handle. If + omitted or null, then no limit beyond the natural limits of MQTT packet size is requested. + + See MQTT5 Maximum Packet Size
          +
          +
          Parameters:
          +
          maximumPacketSizeBytes - The maximum packet size the client is willing to handle
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the maximum packet size.
          +
          +
          • +
        + + + +
          +
        • +

          withWillDelayIntervalSeconds

          +
          public ConnectPacket.ConnectPacketBuilder withWillDelayIntervalSeconds​(Long willDelayIntervalSeconds)
          +
          Sets the time interval, in seconds, that the server should wait (for a session reconnection) before sending the + will message associated with the connection's session. If omitted or null, the server will send the will when the + associated session is destroyed. If the session is destroyed before a will delay interval has elapsed, then + the will must be sent at the time of session destruction. + + See MQTT5 Will Delay Interval
          +
          +
          Parameters:
          +
          willDelayIntervalSeconds - A time interval, in seconds, that the server should wait (for a session reconnection) + before sending the will message associated with the connection's session.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the will message delay interval.
          +
          +
          • +
        + + + +
          +
        • +

          withWill

          +
          public ConnectPacket.ConnectPacketBuilder withWill​(PublishPacket will)
          +
          Sets the definition of a message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first. If null, then nothing will be sent. + + See MQTT5 Will
          +
          +
          Parameters:
          +
          will - The message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the will message.
          +
          +
          • +
        + + + +
          +
        • +

          withUserProperties

          +
          public ConnectPacket.ConnectPacketBuilder withUserProperties​(List<UserProperty> userProperties)
          +
          Sets the list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Parameters:
          +
          userProperties - List of MQTT5 user properties included with the packet.
          +
          Returns:
          +
          The ConnectPacketBuilder after setting the user properties.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public ConnectPacket build()
          +
          Creates a new ConnectPacket using the settings set in the builder.
          +
          +
          Returns:
          +
          The ConnectPacket created from the builder
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnectPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnectPacket.html new file mode 100644 index 000000000..865d88621 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/ConnectPacket.html @@ -0,0 +1,589 @@ + + + + + +ConnectPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class ConnectPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class ConnectPacket.ConnectPacketBuilder +
        A class to that allows for the creation of a ConnectPacket.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        StringgetClientId() +
        Returns a unique string identifying the client to the server.
        +
        LonggetKeepAliveIntervalSeconds() +
        Returns the maximum time interval, in seconds, that is permitted to elapse between the point at which the client + finishes transmitting one MQTT packet and the point it starts sending the next.
        +
        LonggetMaximumPacketSizeBytes() +
        Returns the maximum packet size the client is willing to handle.
        +
        byte[]getPassword() +
        Returns opaque binary data that the server may use for client authentication and authorization.
        +
        LonggetReceiveMaximum() +
        Returns the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
        +
        BooleangetRequestProblemInformation() +
        Returns a boolean that, if true, requests that the server send additional diagnostic information (via response string or + user properties) in DisconnectPacket or ConnAckPacket from the server.
        +
        BooleangetRequestResponseInformation() +
        Returns a boolean that, if true, requests that the server send response information in the subsequent ConnAckPacket.
        +
        LonggetSessionExpiryIntervalSeconds() +
        Returns a time interval, in seconds, that the client requests the server to persist this connection's MQTT session state + for.
        +
        StringgetUsername() +
        Returns a string value that the server may use for client authentication and authorization.
        +
        List<UserProperty>getUserProperties() +
        Returns a list of MQTT5 user properties included with the packet.
        +
        PublishPacketgetWill() +
        Returns the definition of a message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first.
        +
        LonggetWillDelayIntervalSeconds() +
        Returns a time interval, in seconds, that the server should wait (for a session reconnection) before sending the + will message associated with the connection's session.
        +
        + +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getKeepAliveIntervalSeconds

          +
          public Long getKeepAliveIntervalSeconds()
          +
          Returns the maximum time interval, in seconds, that is permitted to elapse between the point at which the client + finishes transmitting one MQTT packet and the point it starts sending the next. The client will use + PINGREQ packets to maintain this property. + + If the responding ConnAckPacket contains a keep alive property value, then that is the negotiated keep alive value. + Otherwise, the keep alive sent by the client is the negotiated value. + + See MQTT5 Keep Alive
          +
          +
          Returns:
          +
          The maximum time interval, in seconds, that is permitted to elapse between the point at which the client + finishes transmitting one MQTT packet and the point it starts sending the next.
          +
          +
          • +
        + + + +
          +
        • +

          getClientId

          +
          public String getClientId()
          +
          Returns a unique string identifying the client to the server. Used to restore session state between connections. + + If left empty, the broker will auto-assign a unique client id. When reconnecting, the Mqtt5Client will + always use the auto-assigned client id. + + See MQTT5 Client Identifier
          +
          +
          Returns:
          +
          A unique string identifying the client to the server.
          +
          +
          • +
        + + + +
          +
        • +

          getUsername

          +
          public String getUsername()
          +
          Returns a string value that the server may use for client authentication and authorization. + + See MQTT5 User Name
          +
          +
          Returns:
          +
          A string value that the server may use for client authentication and authorization.
          +
          +
          • +
        + + + +
          +
        • +

          getPassword

          +
          public byte[] getPassword()
          +
          Returns opaque binary data that the server may use for client authentication and authorization. + + See MQTT5 Password
          +
          +
          Returns:
          +
          Opaque binary data that the server may use for client authentication and authorization.
          +
          +
          • +
        + + + +
          +
        • +

          getSessionExpiryIntervalSeconds

          +
          public Long getSessionExpiryIntervalSeconds()
          +
          Returns a time interval, in seconds, that the client requests the server to persist this connection's MQTT session state + for. Has no meaning if the client has not been configured to rejoin sessions. Must be non-zero in order to + successfully rejoin a session. + + If the responding ConnAckPacket contains a session expiry property value, then that is the negotiated session expiry + value. Otherwise, the session expiry sent by the client is the negotiated value. + + See MQTT5 Session Expiry Interval
          +
          +
          Returns:
          +
          A time interval, in seconds, that the client requests the server to persist this connection's MQTT session + state for.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestResponseInformation

          +
          public Boolean getRequestResponseInformation()
          +
          Returns a boolean that, if true, requests that the server send response information in the subsequent ConnAckPacket. This response + information may be used to set up request-response implementations over MQTT, but doing so is outside + the scope of the MQTT5 spec and client. + + See MQTT5 Request Response Information
          +
          +
          Returns:
          +
          If true, requests that the server send response information in the subsequent ConnAckPacket.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestProblemInformation

          +
          public Boolean getRequestProblemInformation()
          +
          Returns a boolean that, if true, requests that the server send additional diagnostic information (via response string or + user properties) in DisconnectPacket or ConnAckPacket from the server. + + See MQTT5 Request Problem Information
          +
          +
          Returns:
          +
          If true, requests that the server send additional diagnostic information (via response string or + user properties) in DisconnectPacket or ConnAckPacket from the server.
          +
          +
          • +
        + + + +
          +
        • +

          getReceiveMaximum

          +
          public Long getReceiveMaximum()
          +
          Returns the maximum number of in-flight QoS 1 and 2 messages the client is willing to handle. If + omitted or null, then no limit is requested. + + See MQTT5 Receive Maximum
          +
          +
          Returns:
          +
          The maximum number of in-flight QoS 1 and 2 messages the client is willing to handle.
          +
          +
          • +
        + + + +
          +
        • +

          getMaximumPacketSizeBytes

          +
          public Long getMaximumPacketSizeBytes()
          +
          Returns the maximum packet size the client is willing to handle. If + omitted or null, then no limit beyond the natural limits of MQTT packet size is requested. + + See MQTT5 Maximum Packet Size
          +
          +
          Returns:
          +
          The maximum packet size the client is willing to handle
          +
          +
          • +
        + + + +
          +
        • +

          getWillDelayIntervalSeconds

          +
          public Long getWillDelayIntervalSeconds()
          +
          Returns a time interval, in seconds, that the server should wait (for a session reconnection) before sending the + will message associated with the connection's session. If omitted or null, the server will send the will when the + associated session is destroyed. If the session is destroyed before a will delay interval has elapsed, then + the will must be sent at the time of session destruction. + + See MQTT5 Will Delay Interval
          +
          +
          Returns:
          +
          A time interval, in seconds, that the server should wait (for a session reconnection) before sending the + will message associated with the connection's session.
          +
          +
          • +
        + + + +
          +
        • +

          getWill

          +
          public PublishPacket getWill()
          +
          Returns the definition of a message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first. If null, then nothing will be sent. + + See MQTT5 Will
          +
          +
          Returns:
          +
          The message to be published when the connection's session is destroyed by the server or when + the will delay interval has elapsed, whichever comes first.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.DisconnectPacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.DisconnectPacketBuilder.html new file mode 100644 index 000000000..105f799bc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.DisconnectPacketBuilder.html @@ -0,0 +1,461 @@ + + + + + +DisconnectPacket.DisconnectPacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class DisconnectPacket.DisconnectPacketBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      DisconnectPacket
      +
      +
      +
      public static final class DisconnectPacket.DisconnectPacketBuilder
+extends Object
      +
      A class to that allows for the creation of a DisconnectPacket. Set all of the settings you want in the + packet and then use the build() function to get a DisconnectPacket populated with the settings + defined in the builder.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DisconnectPacketBuilder

          +
          public DisconnectPacketBuilder()
          +
          Creates a new DisconnectPacketBuilder so a DisconnectPacket can be created.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          withSessionExpiryIntervalSeconds

          +
          public DisconnectPacket.DisconnectPacketBuilder withSessionExpiryIntervalSeconds​(long sessionExpiryIntervalSeconds)
          +
          Sets the change to the session expiry interval negotiated at connection time as part of the disconnect. Only + valid for DisconnectPackets sent from client to server. It is not valid to attempt to change session expiry + from zero to a non-zero value. + + See MQTT5 Session Expiry Interval
          +
          +
          Parameters:
          +
          sessionExpiryIntervalSeconds - the session expiry interval negotiated at connection time as part of the disconnect
          +
          Returns:
          +
          The DisconnectPacketBuilder after setting the session expiry interval.
          +
          +
          • +
        + + + +
          +
        • +

          withReasonString

          +
          public DisconnectPacket.DisconnectPacketBuilder withReasonString​(String reasonString)
          +
          Sets the additional diagnostic information about the reason that the sender is closing the connection + + See MQTT5 Reason String
          +
          +
          Parameters:
          +
          reasonString - Additional diagnostic information about the reason that the sender is closing the connection
          +
          Returns:
          +
          The DisconnectPacketBuilder after setting the reason string.
          +
          +
          • +
        + + + +
          +
        • +

          withUserProperties

          +
          public DisconnectPacket.DisconnectPacketBuilder withUserProperties​(List<UserProperty> userProperties)
          +
          Sets the list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Parameters:
          +
          userProperties - List of MQTT5 user properties included with the packet.
          +
          Returns:
          +
          The DisconnectPacketBuilder after setting the user properties.
          +
          +
          • +
        + + + +
          +
        • +

          withServerReference

          +
          public DisconnectPacket.DisconnectPacketBuilder withServerReference​(String serverReference)
          +
          Sets the property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint. Will only be set if the reason code indicates another + server may be used (ServerMoved, UseAnotherServer). + + See MQTT5 Server Reference
          +
          +
          Parameters:
          +
          serverReference - Property indicating an alternate server that the client may temporarily or permanently + attempt to connect to instead of the configured endpoint.
          +
          Returns:
          +
          The DisconnectPacketBuilder after setting the server reference.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public DisconnectPacket build()
          +
          Creates a new DisconnectPacket using the settings set in the builder.
          +
          +
          Returns:
          +
          The DisconnectPacket created from the builder
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.DisconnectReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.DisconnectReasonCode.html new file mode 100644 index 000000000..39a719c77 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.DisconnectReasonCode.html @@ -0,0 +1,950 @@ + + + + + +DisconnectPacket.DisconnectReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum DisconnectPacket.DisconnectReasonCode

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ADMINISTRATIVE_ACTION +
        Returned when the connection was closed due to an administrative action.
        +
        CONNECTION_RATE_EXCEEDED +
        Returned when the server disconnects the client due to the connection rate being too high.
        +
        DISCONNECT_WITH_WILL_MESSAGE +
        Returns when the client wants to disconnect but requires that the server publish the Will message configured + on the connection.
        +
        IMPLEMENTATION_SPECIFIC_ERROR +
        Returned when a valid packet was received by the remote endpoint, but could not be processed by the current implementation.
        +
        KEEP_ALIVE_TIMEOUT +
        Returned when the server closes the connection because no packet from the client has been received in + 1.5 times the KeepAlive time set when the connection was established.
        +
        MALFORMED_PACKET +
        Indicates the remote endpoint received a packet that does not conform to the MQTT specification.
        +
        MAXIMUM_CONNECT_TIME +
        Returned by the server when the maximum connection time authorized for the connection was exceeded.
        +
        MESSAGE_RATE_TOO_HIGH +
        Returned when the remote endpoint's incoming data rate was too high.
        +
        NORMAL_DISCONNECTION +
        Returned when the remote endpoint wishes to disconnect normally.
        +
        NOT_AUTHORIZED +
        Returned when the remote endpoint received a packet that represented an operation that was not authorized within + the current connection.
        +
        PACKET_TOO_LARGE +
        Returned when the remote endpoint received a packet whose size was greater than the maximum packet size limit + it established for itself when the connection was opened.
        +
        PAYLOAD_FORMAT_INVALID +
        Returned when the remote endpoint received a packet where payload format did not match the format specified + by the payload format indicator.
        +
        PROTOCOL_ERROR +
        Returned when an unexpected or out-of-order packet was received by the remote endpoint.
        +
        QOS_NOT_SUPPORTED +
        Returned when the client sends a QoS that is greater than the maximum QOS established when the connection was + opened.
        +
        QUOTA_EXCEEDED +
        Returned when an internal quota of the remote endpoint was exceeded.
        +
        RECEIVE_MAXIMUM_EXCEEDED +
        Returned when the remote endpoint reached a state where there were more in-progress QoS1+ publishes then the + limit it established for itself when the connection was opened.
        +
        RETAIN_NOT_SUPPORTED +
        Returned when the server does not support retained messages.
        +
        SERVER_BUSY +
        Returned when the server is busy and cannot continue processing packets from the client.
        +
        SERVER_MOVED +
        Returned by the server to tell the client to permanently use a different server.
        +
        SERVER_SHUTTING_DOWN +
        Returned when the server is shutting down.
        +
        SESSION_TAKEN_OVER +
        Returned when the server has established another connection with the same client ID as a client's current + connection, causing the current client to become disconnected.
        +
        SHARED_SUBSCRIPTIONS_NOT_SUPPORTED +
        Returned by the server to tell the client that shared subscriptions are not supported on the server.
        +
        SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED +
        Returned by the server when it received a SubscribePacket with a subscription identifier, but the server does + not support subscription identifiers.
        +
        TOPIC_ALIAS_INVALID +
        Returned when the remote endpoint receives a PublishPacket that contained a topic alias greater than the + maximum topic alias limit that it established for itself when the connection was opened.
        +
        TOPIC_FILTER_INVALID +
        Returned when the topic filter name is correctly formed but not accepted by the server.
        +
        TOPIC_NAME_INVALID +
        Returned when topic name is correctly formed, but is not accepted.
        +
        UNSPECIFIED_ERROR +
        Returned when the connection was closed but the sender does not want to specify a reason or none + of the other reason codes apply.
        +
        USE_ANOTHER_SERVER +
        Returned by the server to tell the client to temporarily use a different server.
        +
        WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED +
        Returned by the server when it received a SubscribePacket with a wildcard topic filter, but the server does + not support wildcard topic filters.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          NORMAL_DISCONNECTION

          +
          public static final DisconnectPacket.DisconnectReasonCode NORMAL_DISCONNECTION
          +
          Returned when the remote endpoint wishes to disconnect normally. Will not trigger the publish of a Will message if a + Will message was configured on the connection. + + May be sent by the client or server.
          +
          • +
        + + + +
          +
        • +

          DISCONNECT_WITH_WILL_MESSAGE

          +
          public static final DisconnectPacket.DisconnectReasonCode DISCONNECT_WITH_WILL_MESSAGE
          +
          Returns when the client wants to disconnect but requires that the server publish the Will message configured + on the connection. + + May only be sent by the client.
          +
          • +
        + + + +
          +
        • +

          UNSPECIFIED_ERROR

          +
          public static final DisconnectPacket.DisconnectReasonCode UNSPECIFIED_ERROR
          +
          Returned when the connection was closed but the sender does not want to specify a reason or none + of the other reason codes apply. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          MALFORMED_PACKET

          +
          public static final DisconnectPacket.DisconnectReasonCode MALFORMED_PACKET
          +
          Indicates the remote endpoint received a packet that does not conform to the MQTT specification. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          PROTOCOL_ERROR

          +
          public static final DisconnectPacket.DisconnectReasonCode PROTOCOL_ERROR
          +
          Returned when an unexpected or out-of-order packet was received by the remote endpoint. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          IMPLEMENTATION_SPECIFIC_ERROR

          +
          public static final DisconnectPacket.DisconnectReasonCode IMPLEMENTATION_SPECIFIC_ERROR
          +
          Returned when a valid packet was received by the remote endpoint, but could not be processed by the current implementation. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          NOT_AUTHORIZED

          +
          public static final DisconnectPacket.DisconnectReasonCode NOT_AUTHORIZED
          +
          Returned when the remote endpoint received a packet that represented an operation that was not authorized within + the current connection. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          SERVER_BUSY

          +
          public static final DisconnectPacket.DisconnectReasonCode SERVER_BUSY
          +
          Returned when the server is busy and cannot continue processing packets from the client. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          SERVER_SHUTTING_DOWN

          +
          public static final DisconnectPacket.DisconnectReasonCode SERVER_SHUTTING_DOWN
          +
          Returned when the server is shutting down. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          KEEP_ALIVE_TIMEOUT

          +
          public static final DisconnectPacket.DisconnectReasonCode KEEP_ALIVE_TIMEOUT
          +
          Returned when the server closes the connection because no packet from the client has been received in + 1.5 times the KeepAlive time set when the connection was established. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          SESSION_TAKEN_OVER

          +
          public static final DisconnectPacket.DisconnectReasonCode SESSION_TAKEN_OVER
          +
          Returned when the server has established another connection with the same client ID as a client's current + connection, causing the current client to become disconnected. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          TOPIC_FILTER_INVALID

          +
          public static final DisconnectPacket.DisconnectReasonCode TOPIC_FILTER_INVALID
          +
          Returned when the topic filter name is correctly formed but not accepted by the server. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          TOPIC_NAME_INVALID

          +
          public static final DisconnectPacket.DisconnectReasonCode TOPIC_NAME_INVALID
          +
          Returned when topic name is correctly formed, but is not accepted. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          RECEIVE_MAXIMUM_EXCEEDED

          +
          public static final DisconnectPacket.DisconnectReasonCode RECEIVE_MAXIMUM_EXCEEDED
          +
          Returned when the remote endpoint reached a state where there were more in-progress QoS1+ publishes then the + limit it established for itself when the connection was opened. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          TOPIC_ALIAS_INVALID

          +
          public static final DisconnectPacket.DisconnectReasonCode TOPIC_ALIAS_INVALID
          +
          Returned when the remote endpoint receives a PublishPacket that contained a topic alias greater than the + maximum topic alias limit that it established for itself when the connection was opened. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          PACKET_TOO_LARGE

          +
          public static final DisconnectPacket.DisconnectReasonCode PACKET_TOO_LARGE
          +
          Returned when the remote endpoint received a packet whose size was greater than the maximum packet size limit + it established for itself when the connection was opened. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          MESSAGE_RATE_TOO_HIGH

          +
          public static final DisconnectPacket.DisconnectReasonCode MESSAGE_RATE_TOO_HIGH
          +
          Returned when the remote endpoint's incoming data rate was too high. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          QUOTA_EXCEEDED

          +
          public static final DisconnectPacket.DisconnectReasonCode QUOTA_EXCEEDED
          +
          Returned when an internal quota of the remote endpoint was exceeded. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          ADMINISTRATIVE_ACTION

          +
          public static final DisconnectPacket.DisconnectReasonCode ADMINISTRATIVE_ACTION
          +
          Returned when the connection was closed due to an administrative action. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          PAYLOAD_FORMAT_INVALID

          +
          public static final DisconnectPacket.DisconnectReasonCode PAYLOAD_FORMAT_INVALID
          +
          Returned when the remote endpoint received a packet where payload format did not match the format specified + by the payload format indicator. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          RETAIN_NOT_SUPPORTED

          +
          public static final DisconnectPacket.DisconnectReasonCode RETAIN_NOT_SUPPORTED
          +
          Returned when the server does not support retained messages. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          QOS_NOT_SUPPORTED

          +
          public static final DisconnectPacket.DisconnectReasonCode QOS_NOT_SUPPORTED
          +
          Returned when the client sends a QoS that is greater than the maximum QOS established when the connection was + opened. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          USE_ANOTHER_SERVER

          +
          public static final DisconnectPacket.DisconnectReasonCode USE_ANOTHER_SERVER
          +
          Returned by the server to tell the client to temporarily use a different server. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          SERVER_MOVED

          +
          public static final DisconnectPacket.DisconnectReasonCode SERVER_MOVED
          +
          Returned by the server to tell the client to permanently use a different server. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          SHARED_SUBSCRIPTIONS_NOT_SUPPORTED

          +
          public static final DisconnectPacket.DisconnectReasonCode SHARED_SUBSCRIPTIONS_NOT_SUPPORTED
          +
          Returned by the server to tell the client that shared subscriptions are not supported on the server. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          CONNECTION_RATE_EXCEEDED

          +
          public static final DisconnectPacket.DisconnectReasonCode CONNECTION_RATE_EXCEEDED
          +
          Returned when the server disconnects the client due to the connection rate being too high. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          MAXIMUM_CONNECT_TIME

          +
          public static final DisconnectPacket.DisconnectReasonCode MAXIMUM_CONNECT_TIME
          +
          Returned by the server when the maximum connection time authorized for the connection was exceeded. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED

          +
          public static final DisconnectPacket.DisconnectReasonCode SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED
          +
          Returned by the server when it received a SubscribePacket with a subscription identifier, but the server does + not support subscription identifiers. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED

          +
          public static final DisconnectPacket.DisconnectReasonCode WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED
          +
          Returned by the server when it received a SubscribePacket with a wildcard topic filter, but the server does + not support wildcard topic filters. + + May only be sent by the server.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static DisconnectPacket.DisconnectReasonCode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (DisconnectPacket.DisconnectReasonCode c : DisconnectPacket.DisconnectReasonCode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static DisconnectPacket.DisconnectReasonCode valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static DisconnectPacket.DisconnectReasonCode getEnumValueFromInteger​(int value)
          +
          Creates a Java DisconnectReasonCode enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for DisconnectReasonCode
          +
          Returns:
          +
          a new DisconnectReasonCode value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.html new file mode 100644 index 000000000..ef8f2037b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/DisconnectPacket.html @@ -0,0 +1,413 @@ + + + + + +DisconnectPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class DisconnectPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getSessionExpiryIntervalSeconds

          +
          public Long getSessionExpiryIntervalSeconds()
          +
          Returns a change to the session expiry interval negotiated at connection time as part of the disconnect. Only + valid for DisconnectPackets sent from client to server. It is not valid to attempt to change session expiry + from zero to a non-zero value. + + See MQTT5 Session Expiry Interval.
          +
          +
          Returns:
          +
          A change to the session expiry interval negotiated at connection time as part of the disconnect.
          +
          +
          • +
        + + + +
          +
        • +

          getReasonString

          +
          public String getReasonString()
          +
          Returns additional diagnostic information about the reason that the sender is closing the connection + + See MQTT5 Reason String
          +
          +
          Returns:
          +
          Additional diagnostic information about the reason that the sender is closing the connection
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        + + + +
          +
        • +

          getServerReference

          +
          public String getServerReference()
          +
          Returns a property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint. Will only be set if the reason code indicates another + server may be used (ServerMoved, UseAnotherServer). + + See MQTT5 Server Reference
          +
          +
          Returns:
          +
          Property indicating an alternate server that the client may temporarily or permanently attempt + to connect to instead of the configured endpoint.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/PubAckPacket.PubAckReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/PubAckPacket.PubAckReasonCode.html new file mode 100644 index 000000000..ca403a129 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/PubAckPacket.PubAckReasonCode.html @@ -0,0 +1,568 @@ + + + + + +PubAckPacket.PubAckReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum PubAckPacket.PubAckReasonCode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SUCCESS

          +
          public static final PubAckPacket.PubAckReasonCode SUCCESS
          +
          Returned when the (QoS 1) publish was accepted by the recipient. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          NO_MATCHING_SUBSCRIBERS

          +
          public static final PubAckPacket.PubAckReasonCode NO_MATCHING_SUBSCRIBERS
          +
          Returned when the (QoS 1) publish was accepted but there were no matching subscribers. + + May only be sent by the server.
          +
          • +
        + + + +
          +
        • +

          UNSPECIFIED_ERROR

          +
          public static final PubAckPacket.PubAckReasonCode UNSPECIFIED_ERROR
          +
          Returned when the (QoS 1) publish was not accepted and the receiver does not want to specify a reason or none + of the other reason codes apply. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          IMPLEMENTATION_SPECIFIC_ERROR

          +
          public static final PubAckPacket.PubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR
          +
          Returned when the (QoS 1) publish was valid but the receiver was not willing to accept it. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          NOT_AUTHORIZED

          +
          public static final PubAckPacket.PubAckReasonCode NOT_AUTHORIZED
          +
          Returned when the (QoS 1) publish was not authorized by the receiver. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          TOPIC_NAME_INVALID

          +
          public static final PubAckPacket.PubAckReasonCode TOPIC_NAME_INVALID
          +
          Returned when the topic name was valid but the receiver was not willing to accept it. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          PACKET_IDENTIFIER_IN_USE

          +
          public static final PubAckPacket.PubAckReasonCode PACKET_IDENTIFIER_IN_USE
          +
          Returned when the packet identifier used in the associated PUBLISH was already in use. + This can indicate a mismatch in the session state between client and server. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          QUOTA_EXCEEDED

          +
          public static final PubAckPacket.PubAckReasonCode QUOTA_EXCEEDED
          +
          Returned when the associated PUBLISH failed because an internal quota on the recipient was exceeded. + + May be sent by the client or the server.
          +
          • +
        + + + +
          +
        • +

          PAYLOAD_FORMAT_INVALID

          +
          public static final PubAckPacket.PubAckReasonCode PAYLOAD_FORMAT_INVALID
          +
          Returned when the PUBLISH packet's payload format did not match its payload format indicator property. + + May be sent by the client or the server.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PubAckPacket.PubAckReasonCode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PubAckPacket.PubAckReasonCode c : PubAckPacket.PubAckReasonCode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PubAckPacket.PubAckReasonCode valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static PubAckPacket.PubAckReasonCode getEnumValueFromInteger​(int value)
          +
          Creates a Java PubAckReasonCode enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for PubAckReasonCode
          +
          Returns:
          +
          a new PubAckReasonCode value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/PubAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/PubAckPacket.html new file mode 100644 index 000000000..4239149a7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/PubAckPacket.html @@ -0,0 +1,350 @@ + + + + + +PubAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class PubAckPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getReasonCode

          +
          public PubAckPacket.PubAckReasonCode getReasonCode()
          +
          Returns success indicator or failure reason for the associated PublishPacket. + + See MQTT5 PUBACK Reason Code
          +
          +
          Returns:
          +
          Success indicator or failure reason for the associated PublishPacket.
          +
          +
          • +
        + + + +
          +
        • +

          getReasonString

          +
          public String getReasonString()
          +
          Returns additional diagnostic information about the result of the PUBLISH attempt. + + See MQTT5 Reason String
          +
          +
          Returns:
          +
          Additional diagnostic information about the result of the PUBLISH attempt.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.PayloadFormatIndicator.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.PayloadFormatIndicator.html new file mode 100644 index 000000000..e06d7caaa --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.PayloadFormatIndicator.html @@ -0,0 +1,435 @@ + + + + + +PublishPacket.PayloadFormatIndicator (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum PublishPacket.PayloadFormatIndicator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PublishPacket.PayloadFormatIndicator[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PublishPacket.PayloadFormatIndicator c : PublishPacket.PayloadFormatIndicator.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PublishPacket.PayloadFormatIndicator valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static PublishPacket.PayloadFormatIndicator getEnumValueFromInteger​(int value)
          +
          Creates a Java PayloadFormatIndicator enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for PayloadFormatIndicator
          +
          Returns:
          +
          a new PayloadFormatIndicator value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.PublishPacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.PublishPacketBuilder.html new file mode 100644 index 000000000..3577bc516 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.PublishPacketBuilder.html @@ -0,0 +1,638 @@ + + + + + +PublishPacket.PublishPacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class PublishPacket.PublishPacketBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PublishPacket
      +
      +
      +
      public static final class PublishPacket.PublishPacketBuilder
+extends Object
      +
      A class to that allows for the creation of a PublishPacket. Set all of the settings you want in the + packet and then use the build() function to get a PublishPacket populated with the settings + defined in the builder.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PublishPacketBuilder

          +
          public PublishPacketBuilder()
          +
          Creates a new PublishPacketBuilder so a PublishPacket can be created.
          +
          • +
        + + + +
          +
        • +

          PublishPacketBuilder

          +
          public PublishPacketBuilder​(String topic,
+                            QOS packetQOS,
+                            byte[] payload)
          +
          Creates a new PublishPacketBuilder with common parameters set.
          +
          +
          Parameters:
          +
          topic - The topic this message should be published to.
          +
          packetQOS - The MQTT quality of service level the message should be delivered with.
          +
          payload - The payload for the publish message.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withPayload

          +
          public PublishPacket.PublishPacketBuilder withPayload​(byte[] payload)
          +
          Sets the payload for the publish message. + + See MQTT5 Publish Payload
          +
          +
          Parameters:
          +
          payload - The payload for the publish message.
          +
          Returns:
          +
          The PublishPacketBuilder after setting the payload.
          +
          +
          • +
        + + + +
          +
        • +

          withQOS

          +
          public PublishPacket.PublishPacketBuilder withQOS​(QOS packetQOS)
          +
          Sets the MQTT quality of service level the message should be delivered with. + + See MQTT5 QoS
          +
          +
          Parameters:
          +
          packetQOS - The MQTT quality of service level the message should be delivered with.
          +
          Returns:
          +
          The PublishPacketBuilder after setting the QOS.
          +
          +
          • +
        + + + +
          +
        • +

          withRetain

          +
          public PublishPacket.PublishPacketBuilder withRetain​(Boolean retain)
          +
          Sets if this should be a retained message. + Null implies false. + + See MQTT5 Retain
          +
          +
          Parameters:
          +
          retain - if this is a retained message.
          +
          Returns:
          +
          The PublishPacketBuilder after setting the retain setting.
          +
          +
          • +
        + + + +
          +
        • +

          withTopic

          +
          public PublishPacket.PublishPacketBuilder withTopic​(String topic)
          +
          Sets the topic this message should be published to. + + See MQTT5 Topic Name
          +
          +
          Parameters:
          +
          topic - The topic this message should be published to.
          +
          Returns:
          +
          The PublishPacketBuilder after setting the topic.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withMessageExpiryIntervalSeconds

          +
          public PublishPacket.PublishPacketBuilder withMessageExpiryIntervalSeconds​(Long messageExpiryIntervalSeconds)
          +
          Sets the maximum amount of time allowed to elapse for message delivery before the server + should instead delete the message (relative to a recipient). + + If left null, indicates no expiration timeout. + + See MQTT5 Message Expiry Interval
          +
          +
          Parameters:
          +
          messageExpiryIntervalSeconds - The maximum amount of time allowed to elapse for message delivery before the server + should instead delete the message (relative to a recipient).
          +
          Returns:
          +
          The PublishPacketBuilder after setting the message expiry interval.
          +
          +
          • +
        + + + +
          +
        • +

          withTopicAlias

          +
          public PublishPacket.PublishPacketBuilder withTopicAlias​(long topicAlias)
          +
          Sets the topic alias to use when sending this publish. Will only be used if the outbound topic aliasing + behavior has been set to Manual. + + See MQTT5 Topic Alias
          +
          +
          Parameters:
          +
          topicAlias - alias value to use. Must be greater than 0 and less than 65536.
          +
          Returns:
          +
          The PublishPacketBuilder after setting the topic alias.
          +
          +
          • +
        + + + +
          +
        • +

          withResponseTopic

          +
          public PublishPacket.PublishPacketBuilder withResponseTopic​(String responseTopic)
          +
          Sets the opaque topic string intended to assist with request/response implementations. Not internally meaningful to + MQTT5 or this client. + + See MQTT5 Response Topic
          +
          +
          Parameters:
          +
          responseTopic - Topic string intended to assist with request/response implementations
          +
          Returns:
          +
          The PublishPacketBuilder after setting the response topic.
          +
          +
          • +
        + + + +
          +
        • +

          withCorrelationData

          +
          public PublishPacket.PublishPacketBuilder withCorrelationData​(byte[] correlationData)
          +
          Sets the opaque binary data used to correlate between publish messages, as a potential method for request-response + implementation. Not internally meaningful to MQTT5. + + See MQTT5 Correlation Data
          +
          +
          Parameters:
          +
          correlationData - Opaque binary data used to correlate between publish messages
          +
          Returns:
          +
          The PublishPacketBuilder after setting the correlation data.
          +
          +
          • +
        + + + +
          +
        • +

          withContentType

          +
          public PublishPacket.PublishPacketBuilder withContentType​(String contentType)
          +
          Sets the property specifying the content type of the payload. Not internally meaningful to MQTT5. + + See MQTT5 Content Type
          +
          +
          Parameters:
          +
          contentType - Property specifying the content type of the payload
          +
          Returns:
          +
          The PublishPacketBuilder after setting the content type.
          +
          +
          • +
        + + + +
          +
        • +

          withUserProperties

          +
          public PublishPacket.PublishPacketBuilder withUserProperties​(List<UserProperty> userProperties)
          +
          Sets the list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Parameters:
          +
          userProperties - List of MQTT5 user properties included with the packet.
          +
          Returns:
          +
          The PublishPacketBuilder after setting the user properties.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public PublishPacket build()
          +
          Creates a new PublishPacket using the settings set in the builder.
          +
          +
          Returns:
          +
          The PublishPacket created from the builder
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.html new file mode 100644 index 000000000..58c5ef22e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/PublishPacket.html @@ -0,0 +1,588 @@ + + + + + +PublishPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class PublishPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.PublishPacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPayload

          +
          public byte[] getPayload()
          +
          Returns the payload of the publish message. + + See MQTT5 Publish Payload
          +
          +
          Returns:
          +
          The payload of the publish message.
          +
          +
          • +
        + + + +
          +
        • +

          getQOS

          +
          public QOS getQOS()
          +
          Sent publishes - Returns the MQTT quality of service level this message should be delivered with. + + Received publishes - Returns the MQTT quality of service level this message was delivered at. + + See MQTT5 QoS
          +
          +
          Returns:
          +
          The MQTT quality of service associated with this PUBLISH packet.
          +
          +
          • +
        + + + +
          +
        • +

          getRetain

          +
          public Boolean getRetain()
          +
          Returns true if this is a retained message, false otherwise. + + Always set on received publishes; on sent publishes, null implies false. + + See MQTT5 Retain
          +
          +
          Returns:
          +
          True if this is a retained message, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getTopic

          +
          public String getTopic()
          +
          Sent publishes - Returns the topic this message should be published to. + + Received publishes - Returns the topic this message was published to. + + See MQTT5 Topic Name
          +
          +
          Returns:
          +
          The topic associated with this PUBLISH packet.
          +
          +
          • +
        + + + +
          +
        • +

          getPayloadFormat

          +
          public PublishPacket.PayloadFormatIndicator getPayloadFormat()
          +
          Returns the property specifying the format of the payload data. The Mqtt5Client does not enforce or use this + value in a meaningful way. + + See MQTT5 Payload Format Indicator
          +
          +
          Returns:
          +
          Property specifying the format of the payload data.
          +
          +
          • +
        + + + +
          +
        • +

          getMessageExpiryIntervalSeconds

          +
          public Long getMessageExpiryIntervalSeconds()
          +
          Sent publishes - Returns the maximum amount of time allowed to elapse for message delivery before the server + should instead delete the message (relative to a recipient). + + Received publishes - Returns the remaining amount of time (from the server's perspective) before the message would + have been deleted relative to the subscribing client. + + If left null, indicates no expiration timeout. + + See MQTT5 Message Expiry Interval
          +
          +
          Returns:
          +
          The message expiry interval associated with this PublishPacket.
          +
          +
          • +
        + + + +
          +
        • +

          getTopicAlias

          +
          public Long getTopicAlias()
          +
          Sent publishes - topic alias to use, if possible, when encoding this packet. Only used if the + client's outbound topic aliasing mode is set to Manual. + + Received publishes - topic alias used by the server when transmitting the publish to the client. + + See MQTT5 Topic Alias
          +
          +
          Returns:
          +
          The topic alias associated with this PublishPacket.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseTopic

          +
          public String getResponseTopic()
          +
          Returns a opaque topic string intended to assist with request/response implementations. Not internally meaningful to + MQTT5 or this client. + + See MQTT5 Response Topic
          +
          +
          Returns:
          +
          Opaque topic string intended to assist with request/response implementations.
          +
          +
          • +
        + + + +
          +
        • +

          getCorrelationData

          +
          public byte[] getCorrelationData()
          +
          Returns a opaque binary data used to correlate between publish messages, as a potential method for request-response + implementation. Not internally meaningful to MQTT5. + + See MQTT5 Correlation Data
          +
          +
          Returns:
          +
          Opaque binary data used to correlate between publish messages.
          +
          +
          • +
        + + + +
          +
        • +

          getContentType

          +
          public String getContentType()
          +
          Returns a property specifying the content type of the payload. Not internally meaningful to MQTT5. + + See MQTT5 Content Type
          +
          +
          Returns:
          +
          Property specifying the content type of the payload.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        + + + +
          +
        • +

          getSubscriptionIdentifiers

          +
          public List<Long> getSubscriptionIdentifiers()
          +
          Sent publishes - Ignored + + Received publishes - Returns the subscription identifiers of all the subscriptions this message matched. + + See MQTT5 Subscription Identifier
          +
          +
          Returns:
          +
          the subscription identifiers of all the subscriptions this message matched.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/SubAckPacket.SubAckReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubAckPacket.SubAckReasonCode.html new file mode 100644 index 000000000..fd113c678 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubAckPacket.SubAckReasonCode.html @@ -0,0 +1,606 @@ + + + + + +SubAckPacket.SubAckReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum SubAckPacket.SubAckReasonCode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          GRANTED_QOS_0

          +
          public static final SubAckPacket.SubAckReasonCode GRANTED_QOS_0
          +
          Returned when the subscription was accepted and the maximum QoS sent will be QoS 0.
          +
          • +
        + + + +
          +
        • +

          GRANTED_QOS_1

          +
          public static final SubAckPacket.SubAckReasonCode GRANTED_QOS_1
          +
          Returned when the subscription was accepted and the maximum QoS sent will be QoS 1.
          +
          • +
        + + + +
          +
        • +

          GRANTED_QOS_2

          +
          public static final SubAckPacket.SubAckReasonCode GRANTED_QOS_2
          +
          Returned when the subscription was accepted and the maximum QoS sent will be QoS 2.
          +
          • +
        + + + +
          +
        • +

          UNSPECIFIED_ERROR

          +
          public static final SubAckPacket.SubAckReasonCode UNSPECIFIED_ERROR
          +
          Returned when the connection was closed but the sender does not want to specify a reason or none + of the other reason codes apply.
          +
          • +
        + + + +
          +
        • +

          IMPLEMENTATION_SPECIFIC_ERROR

          +
          public static final SubAckPacket.SubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR
          +
          Returned when the subscription was valid but the server did not accept it.
          +
          • +
        + + + +
          +
        • +

          NOT_AUTHORIZED

          +
          public static final SubAckPacket.SubAckReasonCode NOT_AUTHORIZED
          +
          Returned when the client was not authorized to make the subscription on the server.
          +
          • +
        + + + +
          +
        • +

          TOPIC_FILTER_INVALID

          +
          public static final SubAckPacket.SubAckReasonCode TOPIC_FILTER_INVALID
          +
          Returned when the subscription topic filter was correctly formed but not allowed for the client.
          +
          • +
        + + + +
          +
        • +

          PACKET_IDENTIFIER_IN_USE

          +
          public static final SubAckPacket.SubAckReasonCode PACKET_IDENTIFIER_IN_USE
          +
          Returned when the packet identifier was already in use on the server.
          +
          • +
        + + + +
          +
        • +

          QUOTA_EXCEEDED

          +
          public static final SubAckPacket.SubAckReasonCode QUOTA_EXCEEDED
          +
          Returned when a subscribe-related quota set on the server was exceeded.
          +
          • +
        + + + +
          +
        • +

          SHARED_SUBSCRIPTIONS_NOT_SUPPORTED

          +
          public static final SubAckPacket.SubAckReasonCode SHARED_SUBSCRIPTIONS_NOT_SUPPORTED
          +
          Returned when the subscription's topic filter was a shared subscription and the server does not support + shared subscriptions.
          +
          • +
        + + + +
          +
        • +

          SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED

          +
          public static final SubAckPacket.SubAckReasonCode SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED
          +
          Returned when the SubscribePacket contained a subscription identifier and the server does not support + subscription identifiers.
          +
          • +
        + + + +
          +
        • +

          WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED

          +
          public static final SubAckPacket.SubAckReasonCode WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED
          +
          Returned when the subscription's topic filter contains a wildcard but the server does not support + wildcard subscriptions.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SubAckPacket.SubAckReasonCode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SubAckPacket.SubAckReasonCode c : SubAckPacket.SubAckReasonCode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SubAckPacket.SubAckReasonCode valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static SubAckPacket.SubAckReasonCode getEnumValueFromInteger​(int value)
          +
          Creates a Java SubAckReasonCode enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for SubAckReasonCode
          +
          Returns:
          +
          a new SubAckReasonCode value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/SubAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubAckPacket.html new file mode 100644 index 000000000..da2d5c2fb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubAckPacket.html @@ -0,0 +1,353 @@ + + + + + +SubAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class SubAckPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class SubAckPacket
+extends Object
      +
      Data model of an MQTT5 SUBACK packet.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getReasonString

          +
          public String getReasonString()
          +
          Returns additional diagnostic information about the result of the SUBSCRIBE attempt. + + See MQTT5 Reason String
          +
          +
          Returns:
          +
          Additional diagnostic information about the result of the SUBSCRIBE attempt.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        + + + +
          +
        • +

          getReasonCodes

          +
          public List<SubAckPacket.SubAckReasonCode> getReasonCodes()
          +
          Returns a list of reason codes indicating the result of each individual subscription entry in the + associated SubscribePacket. + + See MQTT5 Suback Payload
          +
          +
          Returns:
          +
          list of reason codes indicating the result of each individual subscription entry in the + associated SubscribePacket.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.RetainHandlingType.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.RetainHandlingType.html new file mode 100644 index 000000000..54d8d0385 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.RetainHandlingType.html @@ -0,0 +1,454 @@ + + + + + +SubscribePacket.RetainHandlingType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum SubscribePacket.RetainHandlingType

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SEND_ON_SUBSCRIBE

          +
          public static final SubscribePacket.RetainHandlingType SEND_ON_SUBSCRIBE
          +
          The server should always send all retained messages on topics that match a subscription's filter.
          +
          • +
        + + + +
          +
        • +

          SEND_ON_SUBSCRIBE_IF_NEW

          +
          public static final SubscribePacket.RetainHandlingType SEND_ON_SUBSCRIBE_IF_NEW
          +
          The server should send retained messages on topics that match the subscription's filter, but only for the + first matching subscription, per session.
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SubscribePacket.RetainHandlingType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SubscribePacket.RetainHandlingType c : SubscribePacket.RetainHandlingType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SubscribePacket.RetainHandlingType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static SubscribePacket.RetainHandlingType getEnumValueFromInteger​(int value)
          +
          Creates a Java RetainHandlingType enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for RetainHandlingType
          +
          Returns:
          +
          a new RetainHandlingType value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.SubscribePacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.SubscribePacketBuilder.html new file mode 100644 index 000000000..9686dd7f0 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.SubscribePacketBuilder.html @@ -0,0 +1,506 @@ + + + + + +SubscribePacket.SubscribePacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class SubscribePacket.SubscribePacketBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      SubscribePacket
      +
      +
      +
      public static final class SubscribePacket.SubscribePacketBuilder
+extends Object
      +
      A class to that allows for the creation of a SubscribePacket. Set all of the settings you want in the + packet and then use the build() function to get a SubscribePacket populated with the settings + defined in the builder.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SubscribePacketBuilder

          +
          public SubscribePacketBuilder()
          +
          Creates a new SubscribePacketBuilder so a SubscribePacket can be created.
          +
          • +
        + + + +
          +
        • +

          SubscribePacketBuilder

          +
          public SubscribePacketBuilder​(SubscribePacket.Subscription subscription)
          +
          Creates a new SubscribePacketBuilder with one subscription defined.
          +
          +
          Parameters:
          +
          subscription - The subscription to add within the SubscribePacket.
          +
          +
          • +
        + + + +
          +
        • +

          SubscribePacketBuilder

          +
          public SubscribePacketBuilder​(String topicFilter,
+                              QOS qos)
          +
          Creates a new SubscribePacketBuilder with one subscription defined.
          +
          +
          Parameters:
          +
          topicFilter - The topic filter to subscribe to.
          +
          qos - The maximum QoS on which the subscriber will accept publish messages.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withSubscription

          +
          public SubscribePacket.SubscribePacketBuilder withSubscription​(SubscribePacket.Subscription subscription)
          +
          Sets a single subscription within the SubscribePacket.
          +
          +
          Parameters:
          +
          subscription - The subscription to add within the SubscribePacket.
          +
          Returns:
          +
          The SubscribePacketBuilder after setting the subscription.
          +
          +
          • +
        + + + +
          +
        • +

          withSubscription

          +
          public SubscribePacket.SubscribePacketBuilder withSubscription​(String topicFilter,
+                                                               QOS qos,
+                                                               Boolean noLocal,
+                                                               Boolean retainAsPublished,
+                                                               SubscribePacket.RetainHandlingType retainHandlingType)
          +
          Sets a single subscription within the SubscribePacket.
          +
          +
          Parameters:
          +
          topicFilter - The topic filter to subscribe to
          +
          qos - The maximum QoS on which the subscriber will accept publish messages
          +
          noLocal - Whether the server will not send publishes to a client when that client was the one who + sent the publish
          +
          retainAsPublished - Whether messages sent due to this subscription keep the retain flag preserved + on the message
          +
          retainHandlingType - Whether retained messages on matching topics be sent in reaction to this subscription
          +
          Returns:
          +
          The SubscribePacketBuilder after setting the subscription.
          +
          +
          • +
        + + + +
          +
        • +

          withSubscription

          +
          public SubscribePacket.SubscribePacketBuilder withSubscription​(String topicFilter,
+                                                               QOS qos)
          +
          Sets a single subscription within the SubscribePacket.
          +
          +
          Parameters:
          +
          topicFilter - The topic filter to subscribe to
          +
          qos - The maximum QoS on which the subscriber will accept publish messages
          +
          Returns:
          +
          The SubscribePacketBuilder after setting the subscription.
          +
          +
          • +
        + + + +
          +
        • +

          withSubscriptionIdentifier

          +
          public SubscribePacket.SubscribePacketBuilder withSubscriptionIdentifier​(long subscriptionIdentifier)
          +
          Sets the positive long to associate with all topic filters in this request. Publish packets that match + a subscription in this request should include this identifier in the resulting message. + + See MQTT5 Subscription Identifier
          +
          +
          Parameters:
          +
          subscriptionIdentifier - A positive long to associate with all topic filters in this request.
          +
          Returns:
          +
          The SubscribePacketBuilder after setting the subscription identifier.
          +
          +
          • +
        + + + +
          +
        • +

          withUserProperties

          +
          public SubscribePacket.SubscribePacketBuilder withUserProperties​(List<UserProperty> userProperties)
          +
          Sets the list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Parameters:
          +
          userProperties - List of MQTT5 user properties to be included with the packet.
          +
          Returns:
          +
          The SubscribePacketBuilder after setting the user properties.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public SubscribePacket build()
          +
          Creates a new SUBSCRIBE packet using the settings set in the builder.
          +
          +
          Returns:
          +
          The SubscribePacket created from the builder
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.Subscription.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.Subscription.html new file mode 100644 index 000000000..6bba64708 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.Subscription.html @@ -0,0 +1,382 @@ + + + + + +SubscribePacket.Subscription (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class SubscribePacket.Subscription

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTopicFilter

          +
          public String getTopicFilter()
          +
          Returns the topic filter to subscribe to + + See MQTT5 Subscription Options
          +
          +
          Returns:
          +
          The topic filter to subscribe to
          +
          +
          • +
        + + + +
          +
        • +

          getQOS

          +
          public QOS getQOS()
          +
          Returns the maximum QoS on which the subscriber will accept publish messages. Negotiated QoS may be different. + + See MQTT5 Subscription Options
          +
          +
          Returns:
          +
          The maximum QoS on which the subscriber will accept publish messages
          +
          +
          • +
        + + + +
          +
        • +

          getNoLocal

          +
          public Boolean getNoLocal()
          +
          Returns whether the server should not send publishes to a client when that client was the one who sent the publish. If + null, this is assumed to be false. + + See MQTT5 Subscription Options
          +
          +
          Returns:
          +
          Whether the server will not send publishes to a client when that client was the one who sent the publish
          +
          +
          • +
        + + + +
          +
        • +

          getRetainAsPublished

          +
          public Boolean getRetainAsPublished()
          +
          Returns whether messages sent due to this subscription keep the retain flag preserved on the message. If null, + this is assumed to be false. + + See MQTT5 Subscription Options
          +
          +
          Returns:
          +
          Whether messages sent due to this subscription keep the retain flag preserved on the message
          +
          +
          • +
        + + + +
          +
        • +

          getRetainHandlingType

          +
          public SubscribePacket.RetainHandlingType getRetainHandlingType()
          +
          Returns whether retained messages on matching topics be sent in reaction to this subscription. If null, + this is assumed to be RetainHandlingType.SendOnSubscribe. + + See MQTT5 Subscription Options
          +
          +
          Returns:
          +
          Whether retained messages on matching topics be sent in reaction to this subscription
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.html new file mode 100644 index 000000000..a58d14b9e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/SubscribePacket.html @@ -0,0 +1,370 @@ + + + + + +SubscribePacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class SubscribePacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getSubscriptionIdentifier

          +
          public Long getSubscriptionIdentifier()
          +
          Returns the positive long to associate with all subscriptions in this request. Publish packets that match + a subscription in this request should include this identifier in the resulting message. + + See MQTT5 Subscription Identifier
          +
          +
          Returns:
          +
          A positive long to associate with all subscriptions in this request.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns the list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubAckPacket.UnsubAckReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubAckPacket.UnsubAckReasonCode.html new file mode 100644 index 000000000..01258bcc9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubAckPacket.UnsubAckReasonCode.html @@ -0,0 +1,518 @@ + + + + + +UnsubAckPacket.UnsubAckReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Enum UnsubAckPacket.UnsubAckReasonCode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SUCCESS

          +
          public static final UnsubAckPacket.UnsubAckReasonCode SUCCESS
          +
          Returned when the unsubscribe was successful and the client is no longer subscribed to the topic filter on the server.
          +
          • +
        + + + +
          +
        • +

          NO_SUBSCRIPTION_EXISTED

          +
          public static final UnsubAckPacket.UnsubAckReasonCode NO_SUBSCRIPTION_EXISTED
          +
          Returned when the topic filter did not match one of the client's existing topic filters on the server.
          +
          • +
        + + + +
          +
        • +

          UNSPECIFIED_ERROR

          +
          public static final UnsubAckPacket.UnsubAckReasonCode UNSPECIFIED_ERROR
          +
          Returned when the unsubscribe of the topic filter was not accepted and the server does not want to specify a + reason or none of the other reason codes apply.
          +
          • +
        + + + +
          +
        • +

          IMPLEMENTATION_SPECIFIC_ERROR

          +
          public static final UnsubAckPacket.UnsubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR
          +
          Returned when the topic filter was valid but the server does not accept an unsubscribe for it.
          +
          • +
        + + + +
          +
        • +

          NOT_AUTHORIZED

          +
          public static final UnsubAckPacket.UnsubAckReasonCode NOT_AUTHORIZED
          +
          Returned when the client was not authorized to unsubscribe from that topic filter on the server.
          +
          • +
        + + + +
          +
        • +

          TOPIC_FILTER_INVALID

          +
          public static final UnsubAckPacket.UnsubAckReasonCode TOPIC_FILTER_INVALID
          +
          Returned when the topic filter was correctly formed but is not allowed for the client on the server.
          +
          • +
        + + + +
          +
        • +

          PACKET_IDENTIFIER_IN_USE

          +
          public static final UnsubAckPacket.UnsubAckReasonCode PACKET_IDENTIFIER_IN_USE
          +
          Returned when the packet identifier was already in use on the server.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static UnsubAckPacket.UnsubAckReasonCode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (UnsubAckPacket.UnsubAckReasonCode c : UnsubAckPacket.UnsubAckReasonCode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static UnsubAckPacket.UnsubAckReasonCode valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          +
          Returns:
          +
          The native enum integer value associated with this Java enum value
          +
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static UnsubAckPacket.UnsubAckReasonCode getEnumValueFromInteger​(int value)
          +
          Creates a Java UnsubAckReasonCode enum value from a native integer value.
          +
          +
          Parameters:
          +
          value - native integer value for UnsubAckReasonCode
          +
          Returns:
          +
          a new UnsubAckReasonCode value
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubAckPacket.html new file mode 100644 index 000000000..de694c5ed --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubAckPacket.html @@ -0,0 +1,354 @@ + + + + + +UnsubAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class UnsubAckPacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getReasonString

          +
          public String getReasonString()
          +
          Returns additional diagnostic information about the result of the UNSUBSCRIBE attempt. + + See MQTT5 Reason String
          +
          +
          Returns:
          +
          Additional diagnostic information about the result of the UNSUBSCRIBE attempt.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        + + + +
          +
        • +

          getReasonCodes

          +
          public List<UnsubAckPacket.UnsubAckReasonCode> getReasonCodes()
          +
          Returns a list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the + associated UNSUBSCRIBE packet. + + See MQTT5 Unsuback Payload
          +
          +
          Returns:
          +
          A list of reason codes indicating the result of unsubscribing from each individual topic filter entry in the + associated UNSUBSCRIBE packet.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubscribePacket.UnsubscribePacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubscribePacket.UnsubscribePacketBuilder.html new file mode 100644 index 000000000..d3af77b1f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubscribePacket.UnsubscribePacketBuilder.html @@ -0,0 +1,394 @@ + + + + + +UnsubscribePacket.UnsubscribePacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class UnsubscribePacket.UnsubscribePacketBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      UnsubscribePacket
      +
      +
      +
      public static final class UnsubscribePacket.UnsubscribePacketBuilder
+extends Object
      +
      A class to that allows for the creation of a UnsubscribePacket. Set all of the settings you want in the + packet and then use the build() function to get a UnsubscribePacket populated with the settings + defined in the builder.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnsubscribePacketBuilder

          +
          public UnsubscribePacketBuilder()
          +
          Creates a new UnsubscribePacketBuilder so a UnsubscribePacket can be created.
          +
          • +
        + + + +
          +
        • +

          UnsubscribePacketBuilder

          +
          public UnsubscribePacketBuilder​(String topicFilter)
          +
          Creates a new UnsubscribePacketBuilder with one subscription defined.
          +
          +
          Parameters:
          +
          topicFilter - A single topic filter that the client wishes to unsubscribe from.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withSubscription

          +
          public UnsubscribePacket.UnsubscribePacketBuilder withSubscription​(String topicFilter)
          +
          Sets a single topic filter that the client wishes to unsubscribe from.
          +
          +
          Parameters:
          +
          topicFilter - A single topic filter that the client wishes to unsubscribe from.
          +
          Returns:
          +
          The UnsubscribePacketBuilder after setting the subscription.
          +
          +
          • +
        + + + +
          +
        • +

          withUserProperties

          +
          public UnsubscribePacket.UnsubscribePacketBuilder withUserProperties​(List<UserProperty> userProperties)
          +
          Sets the list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Parameters:
          +
          userProperties - List of MQTT5 user properties included with the packet.
          +
          Returns:
          +
          The UnsubscribePacketBuilder after setting the user properties.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public UnsubscribePacket build()
          +
          Creates a new UnsubscribePacket using the settings set in the builder.
          +
          +
          Returns:
          +
          The UnsubscribePacket created from the builder
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubscribePacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubscribePacket.html new file mode 100644 index 000000000..4d5fc1469 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/UnsubscribePacket.html @@ -0,0 +1,325 @@ + + + + + +UnsubscribePacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class UnsubscribePacket

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSubscriptions

          +
          public List<String> getSubscriptions()
          +
          Returns a list of subscriptions that the client wishes to unsubscribe from.
          +
          +
          Returns:
          +
          List of subscriptions that the client wishes to unsubscribe from.
          +
          +
          • +
        + + + +
          +
        • +

          getUserProperties

          +
          public List<UserProperty> getUserProperties()
          +
          Returns a list of MQTT5 user properties included with the packet. + + See MQTT5 User Property
          +
          +
          Returns:
          +
          List of MQTT5 user properties included with the packet.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/UserProperty.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/UserProperty.html new file mode 100644 index 000000000..f46960ebd --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/UserProperty.html @@ -0,0 +1,331 @@ + + + + + +UserProperty (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.mqtt5.packets
    +

    Class UserProperty

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.mqtt5.packets.UserProperty
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class UserProperty
+extends Object
      +
      A simple key-value pair struct to define a user property. + A user property is a name-value pair of utf-8 strings that can be added to MQTT5 packets.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UserProperty

          +
          public UserProperty​(String key,
+                    String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnAckPacket.ConnectReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnAckPacket.ConnectReasonCode.html new file mode 100644 index 000000000..1c9c0588e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnAckPacket.ConnectReasonCode.html @@ -0,0 +1,219 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket.ConnectReasonCode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnAckPacket.html new file mode 100644 index 000000000..1406441d9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnAckPacket.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.ConnAckPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnectPacket.ConnectPacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnectPacket.ConnectPacketBuilder.html new file mode 100644 index 000000000..fd76ef19e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnectPacket.ConnectPacketBuilder.html @@ -0,0 +1,279 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket.ConnectPacketBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnectPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnectPacket.html new file mode 100644 index 000000000..0e56f2029 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/ConnectPacket.html @@ -0,0 +1,242 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.ConnectPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.DisconnectPacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.DisconnectPacketBuilder.html new file mode 100644 index 000000000..23f9d24a6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.DisconnectPacketBuilder.html @@ -0,0 +1,230 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectPacketBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.DisconnectReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.DisconnectReasonCode.html new file mode 100644 index 000000000..cd73a76e8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.DisconnectReasonCode.html @@ -0,0 +1,240 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket.DisconnectReasonCode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.html new file mode 100644 index 000000000..3e80bdc55 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/DisconnectPacket.html @@ -0,0 +1,243 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PubAckPacket.PubAckReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PubAckPacket.PubAckReasonCode.html new file mode 100644 index 000000000..69f20f7ac --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PubAckPacket.PubAckReasonCode.html @@ -0,0 +1,219 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PubAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PubAckPacket.html new file mode 100644 index 000000000..6daeea989 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PubAckPacket.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.PayloadFormatIndicator.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.PayloadFormatIndicator.html new file mode 100644 index 000000000..158b4de09 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.PayloadFormatIndicator.html @@ -0,0 +1,236 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PayloadFormatIndicator

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.PublishPacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.PublishPacketBuilder.html new file mode 100644 index 000000000..5f7333904 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.PublishPacketBuilder.html @@ -0,0 +1,269 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.PublishPacket.PublishPacketBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.html new file mode 100644 index 000000000..321b91034 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/PublishPacket.html @@ -0,0 +1,268 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.PublishPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.PublishPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubAckPacket.SubAckReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubAckPacket.SubAckReasonCode.html new file mode 100644 index 000000000..278d1350b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubAckPacket.SubAckReasonCode.html @@ -0,0 +1,230 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket.SubAckReasonCode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubAckPacket.html new file mode 100644 index 000000000..3aec3b0a2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubAckPacket.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.SubAckPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.RetainHandlingType.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.RetainHandlingType.html new file mode 100644 index 000000000..2247e6fac --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.RetainHandlingType.html @@ -0,0 +1,240 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.RetainHandlingType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.SubscribePacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.SubscribePacketBuilder.html new file mode 100644 index 000000000..3b354ef98 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.SubscribePacketBuilder.html @@ -0,0 +1,230 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.SubscribePacketBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.Subscription.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.Subscription.html new file mode 100644 index 000000000..7b7c1e0ec --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.Subscription.html @@ -0,0 +1,231 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket.Subscription

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.html new file mode 100644 index 000000000..f12070332 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/SubscribePacket.html @@ -0,0 +1,225 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.SubscribePacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubAckPacket.UnsubAckReasonCode.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubAckPacket.UnsubAckReasonCode.html new file mode 100644 index 000000000..f531a099e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubAckPacket.UnsubAckReasonCode.html @@ -0,0 +1,230 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubAckPacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubAckPacket.html new file mode 100644 index 000000000..61f574f70 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubAckPacket.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubscribePacket.UnsubscribePacketBuilder.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubscribePacket.UnsubscribePacketBuilder.html new file mode 100644 index 000000000..7da984d45 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubscribePacket.UnsubscribePacketBuilder.html @@ -0,0 +1,204 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket.UnsubscribePacketBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubscribePacket.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubscribePacket.html new file mode 100644 index 000000000..acc8402d2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UnsubscribePacket.html @@ -0,0 +1,225 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.UnsubscribePacket

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UserProperty.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UserProperty.html new file mode 100644 index 000000000..adb207a16 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/class-use/UserProperty.html @@ -0,0 +1,298 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.mqtt5.packets.UserProperty (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.mqtt5.packets.UserProperty

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/package-summary.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/package-summary.html new file mode 100644 index 000000000..e88886269 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/package-summary.html @@ -0,0 +1,318 @@ + + + + + +software.amazon.awssdk.crt.mqtt5.packets (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.mqtt5.packets

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/package-tree.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/package-tree.html new file mode 100644 index 000000000..85f3941b7 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/package-tree.html @@ -0,0 +1,201 @@ + + + + + +software.amazon.awssdk.crt.mqtt5.packets Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.mqtt5.packets

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/mqtt5/packets/package-use.html b/docs/software/amazon/awssdk/crt/mqtt5/packets/package-use.html new file mode 100644 index 000000000..44fca7e10 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/mqtt5/packets/package-use.html @@ -0,0 +1,371 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.mqtt5.packets (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.mqtt5.packets

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/package-summary.html b/docs/software/amazon/awssdk/crt/package-summary.html new file mode 100644 index 000000000..620d1f5bb --- /dev/null +++ b/docs/software/amazon/awssdk/crt/package-summary.html @@ -0,0 +1,267 @@ + + + + + +software.amazon.awssdk.crt (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      AsyncCallback +
      Async io completion abstraction used by the native mqtt layer.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CRT +
      This class is responsible for loading the aws-crt-jni shared lib for the + current platform out of aws-crt-java.jar.
      +
      CrtPlatform 
      CrtResource +
      This wraps a native pointer and/or one or more references to an AWS Common Runtime resource.
      +
      Log +
      Static wrapper around native and crt logging.
      +
      Process +
      Encapsulates Process information and manipulation of process level operations.
      +
      SystemInfo +
      Utility class for querying system hardware properties
      +
      SystemInfo.CpuInfo 
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      Log.LogLevel +
      Enum that controls how detailed logging should be.
      +
      Log.LogSubject 
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      CRT.UnknownPlatformException +
      Exception thrown when we can't detect what platform we're running on and thus can't figure out + the native library name/path to load.
      +
      CrtRuntimeException +
      This exception will be thrown by any exceptional cases encountered within + the JNI bindings to the AWS Common Runtime
      +
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/package-tree.html b/docs/software/amazon/awssdk/crt/package-tree.html new file mode 100644 index 000000000..f8f6e0341 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/package-tree.html @@ -0,0 +1,208 @@ + + + + + +software.amazon.awssdk.crt Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/package-use.html b/docs/software/amazon/awssdk/crt/package-use.html new file mode 100644 index 000000000..9c5961b0b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/package-use.html @@ -0,0 +1,467 @@ + + + + + +Uses of Package software.amazon.awssdk.crt (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/ChecksumAlgorithm.html b/docs/software/amazon/awssdk/crt/s3/ChecksumAlgorithm.html new file mode 100644 index 000000000..fab9310e4 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/ChecksumAlgorithm.html @@ -0,0 +1,461 @@ + + + + + +ChecksumAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Enum ChecksumAlgorithm

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ChecksumAlgorithm[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ChecksumAlgorithm c : ChecksumAlgorithm.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ChecksumAlgorithm valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          • +
        + + + +
          +
        • +

          getEnumValueFromInteger

          +
          public static ChecksumAlgorithm getEnumValueFromInteger​(int value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/ChecksumConfig.ChecksumLocation.html b/docs/software/amazon/awssdk/crt/s3/ChecksumConfig.ChecksumLocation.html new file mode 100644 index 000000000..30588da5d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/ChecksumConfig.ChecksumLocation.html @@ -0,0 +1,412 @@ + + + + + +ChecksumConfig.ChecksumLocation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Enum ChecksumConfig.ChecksumLocation

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ChecksumConfig.ChecksumLocation[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ChecksumConfig.ChecksumLocation c : ChecksumConfig.ChecksumLocation.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ChecksumConfig.ChecksumLocation valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/ChecksumConfig.html b/docs/software/amazon/awssdk/crt/s3/ChecksumConfig.html new file mode 100644 index 000000000..f56c0d50d --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/ChecksumConfig.html @@ -0,0 +1,511 @@ + + + + + +ChecksumConfig (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class ChecksumConfig

    +
    +
    + +
    +
      +
    • +
      +
      public class ChecksumConfig
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChecksumConfig

          +
          public ChecksumConfig()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withChecksumLocation

          +
          public ChecksumConfig withChecksumLocation​(ChecksumConfig.ChecksumLocation location)
          +
          If NONE. No request payload checksum will be added and calculated. + + If HEADER, the checksum will be calculated by client and related header added + to the request sent. + + If TRAILER, the payload will be aws_chunked encoded, The checksum will be + calculated while reading the + payload by client. Related header will be added to the trailer part of the + encoded payload. Note the payload of + the original request cannot be aws-chunked encoded already. Otherwise, error + will be raised.
          +
          +
          Parameters:
          +
          location - The location of client added request payload checksum header.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withChecksumAlgorithm

          +
          public ChecksumConfig withChecksumAlgorithm​(ChecksumAlgorithm algorithm)
          +
          The checksum algorithm used to calculate the checksum of payload uploaded. + Must be set if location is not AWS_SCL_NONE. Must be AWS_SCA_NONE if location + is AWS_SCL_NONE.
          +
          +
          Parameters:
          +
          algorithm - The checksum algorithm used to calculate the checksum of + payload uploaded.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getChecksumAlgorithm

          +
          public ChecksumAlgorithm getChecksumAlgorithm()
          +
          +
          Returns:
          +
          The checksum algorithm used to calculate the checksum of payload + uploaded.
          +
          +
          • +
        + + + +
          +
        • +

          withValidateChecksum

          +
          public ChecksumConfig withValidateChecksum​(boolean validateChecksum)
          +
          Enable checksum mode header will be attached to get requests, this will tell + s3 to send back checksums headers if they exist. + + For object that has checksum, the checksum of whole object will be calculated + and validated. The result will finish with a did validate field. + + For object has checksum for parts, if ALL the parts have been validated, the + result will finish with a did validate field. If any part failed the + validation, AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH will be raised.
          +
          +
          Parameters:
          +
          validateChecksum - Validate the checksum of response if server provides.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getValidateChecksum

          +
          public boolean getValidateChecksum()
          +
          • +
        + + + +
          +
        • +

          withValidateChecksumAlgorithmList

          +
          public ChecksumConfig withValidateChecksumAlgorithmList​(List<ChecksumAlgorithm> validateChecksumAlgorithmList)
          +
          Ignored when validate_response_checksum is not set. + If not set all the algorithms will be selected as default behavior. + + The list of algorithms for user to pick up when validate the checksum. Client + will pick up the algorithm from the list with the priority based on + performance, and the algorithm sent by server. The priority based on + performance is [CRC64NVME, CRC32C, CRC32, SHA1, SHA256]. + + If the response checksum was validated by client, the result will indicate + which algorithm was picked.
          +
          +
          Parameters:
          +
          validateChecksumAlgorithmList - The list of algorithm picked to validate + checksum from response.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getValidateChecksumAlgorithmList

          +
          public List<ChecksumAlgorithm> getValidateChecksumAlgorithmList()
          +
          +
          Returns:
          +
          The list of algorithm picked to validate checksum from response.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/ResumeToken.PutResumeTokenBuilder.html b/docs/software/amazon/awssdk/crt/s3/ResumeToken.PutResumeTokenBuilder.html new file mode 100644 index 000000000..3e1aab989 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/ResumeToken.PutResumeTokenBuilder.html @@ -0,0 +1,396 @@ + + + + + +ResumeToken.PutResumeTokenBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class ResumeToken.PutResumeTokenBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ResumeToken
      +
      +
      +
      public static class ResumeToken.PutResumeTokenBuilder
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PutResumeTokenBuilder

          +
          public PutResumeTokenBuilder()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withPartSize

          +
          public ResumeToken.PutResumeTokenBuilder withPartSize​(long partSize)
          +
          +
          Parameters:
          +
          partSize - part size used for operation
          +
          Returns:
          +
          this resume token object
          +
          +
          • +
        + + + +
          +
        • +

          withTotalNumParts

          +
          public ResumeToken.PutResumeTokenBuilder withTotalNumParts​(long totalNumParts)
          +
          +
          Parameters:
          +
          totalNumParts - total num parts in operation
          +
          Returns:
          +
          this resume token object
          +
          +
          • +
        + + + +
          +
        • +

          withNumPartsCompleted

          +
          public ResumeToken.PutResumeTokenBuilder withNumPartsCompleted​(long numPartsCompleted)
          +
          +
          Parameters:
          +
          numPartsCompleted - number of parts completed
          +
          Returns:
          +
          this resume token object
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/ResumeToken.html b/docs/software/amazon/awssdk/crt/s3/ResumeToken.html new file mode 100644 index 000000000..390cf1a4e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/ResumeToken.html @@ -0,0 +1,408 @@ + + + + + +ResumeToken (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class ResumeToken

    +
    +
    + +
    +
      +
    • +
      +
      public class ResumeToken
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getPartSize

          +
          public long getPartSize()
          +
          +
          Returns:
          +
          part size
          +
          +
          • +
        + + + +
          +
        • +

          getTotalNumParts

          +
          public long getTotalNumParts()
          +
          +
          Returns:
          +
          total number of parts
          +
          +
          • +
        + + + +
          +
        • +

          getNumPartsCompleted

          +
          public long getNumPartsCompleted()
          +
          +
          Returns:
          +
          number of parts completed
          +
          +
          • +
        + + + +
          +
        • +

          getUploadId

          +
          public String getUploadId()
          +
          +
          Returns:
          +
          upload Id
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3Client.html b/docs/software/amazon/awssdk/crt/s3/S3Client.html new file mode 100644 index 000000000..d9af8a70b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3Client.html @@ -0,0 +1,361 @@ + + + + + +S3Client (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3Client

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3ClientOptions.html b/docs/software/amazon/awssdk/crt/s3/S3ClientOptions.html new file mode 100644 index 000000000..2515a8545 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3ClientOptions.html @@ -0,0 +1,1034 @@ + + + + + +S3ClientOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3ClientOptions

    +
    +
    + +
    +
      +
    • +
      +
      public class S3ClientOptions
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          S3ClientOptions

          +
          public S3ClientOptions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getRegion

          +
          public String getRegion()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          withCredentialsProvider

          +
          public S3ClientOptions withCredentialsProvider​(CredentialsProvider credentialsProvider)
          +
          Deprecated. +
          Please use withSigningConfig(AwsSigningConfig) instead. + The credentials provider will be used to create the signing Config when the client was created. + Client will use `AwsSigningConfig.getDefaultS3SigningConfig(region, credentialsProvider);` to create the signing config.
          +
          +
          +
          Parameters:
          +
          credentialsProvider - provide credentials for signing.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withSigningConfig

          +
          public S3ClientOptions withSigningConfig​(AwsSigningConfig signingConfig)
          +
          The configuration related to signing used by S3 client. + `AwsSigningConfig.getDefaultS3SigningConfig(region, credentialsProvider);` can be used as helper to create the default configuration to be used for S3. + In case of public object, or the http message already has a presigned URL, signing can be skipped. + + If not set, a default config will be used with anonymous credentials and skip signing the request. + If set: + - Credentials provider is required. Other configs are all optional, and will be default to what + needs to sign the request for S3, only overrides when Non-zero/Not-empty is set. + - S3 Client will derive the right config for signing process based on this. + + Notes: + - For SIGV4_S3EXPRESS, S3 client will use the credentials in the config to derive the S3 Express + credentials that are used in the signing process. + - Client may make modifications to signing config before passing it on to signer.
          +
          +
          Parameters:
          +
          signingConfig - configuration related to signing via an AWS signing process.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withPartSize

          +
          public S3ClientOptions withPartSize​(long partSize)
          +
          • +
        + + + +
          +
        • +

          getPartSize

          +
          public long getPartSize()
          +
          • +
        + + + +
          +
        • +

          withMultipartUploadThreshold

          +
          public S3ClientOptions withMultipartUploadThreshold​(long multipartUploadThreshold)
          +
          • +
        + + + +
          +
        • +

          getMultiPartUploadThreshold

          +
          public long getMultiPartUploadThreshold()
          +
          • +
        + + + +
          +
        • +

          withThroughputTargetGbps

          +
          public S3ClientOptions withThroughputTargetGbps​(double throughputTargetGbps)
          +
          • +
        + + + +
          +
        • +

          getThroughputTargetGbps

          +
          public double getThroughputTargetGbps()
          +
          • +
        + + + +
          +
        • +

          withReadBackpressureEnabled

          +
          public S3ClientOptions withReadBackpressureEnabled​(boolean enable)
          +
          Set whether backpressure is enabled (false by default), to prevent response data downloading faster than you can handle it. +

          + If false, no backpressure is applied and data will download as fast as possible. +

          + If true, each S3MetaRequest has a flow-control window that shrinks as + response body data is downloaded (headers do not affect the window). + withInitialReadWindowSize(long) determines the starting size of each S3MetaRequest's window, in bytes. + Data stops downloading data whenever the window reaches zero. + Increment the window to keep data flowing by calling S3MetaRequest.incrementReadWindow(long), + or by returning a size from S3MetaRequestResponseHandler.onResponseBody(java.nio.ByteBuffer, long, long). + Maintain a larger window to keep up a high download throughput, + parts cannot download in parallel unless the window is large enough to hold multiple parts. + Maintain a smaller window to limit the amount of data buffered in memory. +

          + WARNING: This feature is experimental. + Currently, backpressure is only applied to GetObject requests which are split into multiple parts, + and you may still receive some data after the window reaches zero.

          +
          +
          Parameters:
          +
          enable - whether to enable or disable backpressure
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getReadBackpressureEnabled

          +
          public boolean getReadBackpressureEnabled()
          +
          • +
        + + + +
          +
        • +

          withInitialReadWindowSize

          +
          public S3ClientOptions withInitialReadWindowSize​(long bytes)
          +
          The starting size of each S3MetaRequest's flow-control window (if backpressure is enabled).
          +
          +
          Parameters:
          +
          bytes - size in bytes
          +
          Returns:
          +
          this
          +
          See Also:
          +
          withReadBackpressureEnabled(boolean)
          +
          +
          • +
        + + + +
          +
        • +

          getInitialReadWindowSize

          +
          public long getInitialReadWindowSize()
          +
          • +
        + + + + + + + +
          +
        • +

          getEndpoint

          +
          public String getEndpoint()
          +
          • +
        + + + + + + + +
          +
        • +

          getTlsContext

          +
          public TlsContext getTlsContext()
          +
          • +
        + + + +
          +
        • +

          withMaxConnections

          +
          public S3ClientOptions withMaxConnections​(int maxConnections)
          +
          • +
        + + + +
          +
        • +

          getMaxConnections

          +
          public int getMaxConnections()
          +
          • +
        + + + + + + + +
          +
        • +

          getComputeContentMd5

          +
          public Boolean getComputeContentMd5()
          +
          • +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          withConnectTimeoutMs

          +
          public S3ClientOptions withConnectTimeoutMs​(int connectTimeoutMs)
          +
          • +
        + + + +
          +
        • +

          getConnectTimeoutMs

          +
          public int getConnectTimeoutMs()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          withHttpMonitoringOptions

          +
          public S3ClientOptions withHttpMonitoringOptions​(HttpMonitoringOptions monitoringOptions)
          +
          Options for detecting bad HTTP connections. + If the transfer throughput falls below the specified thresholds + for long enough, the operation is retried on a new connection. + If left unset, default values are used.
          +
          +
          Parameters:
          +
          monitoringOptions - monitoring options
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withEnableS3Express

          +
          public S3ClientOptions withEnableS3Express​(boolean enableS3Express)
          +
          To enable S3 Express support for client + The typical usage for a S3 Express request is to set this to true and let the request to be signed with + AwsSigningConfig.AwsSigningAlgorithm.SIGV4_S3EXPRESS, either from the client level signingConfig or override from request.
          +
          +
          Parameters:
          +
          enableS3Express - To enable S3 Express support for client
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getEnableS3Express

          +
          public boolean getEnableS3Express()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          withMemoryLimitInBytes

          +
          public S3ClientOptions withMemoryLimitInBytes​(long memoryLimitBytes)
          +
          The amount of memory the CRT client is allowed to use. + The client makes a best-effort attempt at memory limiting but might exceed this limit in some cases. + If not provided, the client calculates this optimally from other settings, such as targetThroughput. + On a 64-bit system, the default is between 2Gib-8Gib. + It must be at least 1GiB and will be capped to SIZE_MAX of the system.
          +
          +
          Parameters:
          +
          memoryLimitBytes - Memory limit in bytes.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getMemoryLimitInBytes

          +
          public long getMemoryLimitInBytes()
          +
          Retrieves the memory limit set for the CRT client in bytes. + If not set, this will return 0.
          +
          +
          Returns:
          +
          long memory limit in bytes
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProperties.html b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProperties.html new file mode 100644 index 000000000..bee679c6c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProperties.html @@ -0,0 +1,351 @@ + + + + + +S3ExpressCredentialsProperties (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3ExpressCredentialsProperties

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class S3ExpressCredentialsProperties
+extends Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProvider.html b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProvider.html new file mode 100644 index 000000000..5e7f0c822 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProvider.html @@ -0,0 +1,333 @@ + + + + + +S3ExpressCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3ExpressCredentialsProvider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.S3ExpressCredentialsProvider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class S3ExpressCredentialsProvider
+extends Object
      +
      The Java object for Native code to invoke.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProviderFactory.html b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProviderFactory.html new file mode 100644 index 000000000..9a91d6a22 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProviderFactory.html @@ -0,0 +1,266 @@ + + + + + +S3ExpressCredentialsProviderFactory (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Interface S3ExpressCredentialsProviderFactory

    +
    +
    +
    +
      +
    • +
      +
      public interface S3ExpressCredentialsProviderFactory
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createS3ExpressCredentialsProvider

          +
          S3ExpressCredentialsProvider createS3ExpressCredentialsProvider​(S3Client client)
          +
          A handler to create a S3ExpressCredentialsProvider for the client to use. + + Warning: + You cannot use the client while creating the provider + (You can use the client for fetching credentials)
          +
          +
          Parameters:
          +
          client - The S3Client creates and owns the provider.
          +
          Returns:
          +
          S3ExpressCredentialsProvider created.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProviderHandler.html b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProviderHandler.html new file mode 100644 index 000000000..0915bc0ac --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3ExpressCredentialsProviderHandler.html @@ -0,0 +1,287 @@ + + + + + +S3ExpressCredentialsProviderHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Interface S3ExpressCredentialsProviderHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface S3ExpressCredentialsProviderHandler
      +
      Interface to override the S3Express Credentials provider.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getS3ExpressCredentials

          +
          CompletableFuture<Credentials> getS3ExpressCredentials​(S3ExpressCredentialsProperties properties,
+                                                       Credentials origCredentials)
          +
          To resolve the S3Express Credentials. Invoked when a single request needs to be signed.
          +
          +
          Parameters:
          +
          properties - The properties needed to derive the S3Express credentials from.
          +
          origCredentials - The original Credentials for fetching S3Express credentials.
          +
          Returns:
          +
          The future to be resolved when the S3 Express credentials are resolved.
          +
          +
          • +
        + + + +
          +
        • +

          destroyProvider

          +
          CompletableFuture<Void> destroyProvider()
          +
          Invoked when the S3 client starts to destroy to clean up related resource.
          +
          +
          Returns:
          +
          The future to be resolved when the resource finishes cleaning up.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3FinishedResponseContext.html b/docs/software/amazon/awssdk/crt/s3/S3FinishedResponseContext.html new file mode 100644 index 000000000..522b6bfd2 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3FinishedResponseContext.html @@ -0,0 +1,390 @@ + + + + + +S3FinishedResponseContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3FinishedResponseContext

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.S3FinishedResponseContext
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class S3FinishedResponseContext
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getErrorCode

          +
          public int getErrorCode()
          +
          • +
        + + + +
          +
        • +

          getResponseStatus

          +
          public int getResponseStatus()
          +
          • +
        + + + +
          +
        • +

          getErrorPayload

          +
          public byte[] getErrorPayload()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          isChecksumValidated

          +
          public boolean isChecksumValidated()
          +
          • +
        + + + +
          +
        • +

          getCause

          +
          public Throwable getCause()
          +
          Cause of the error, such as a Java exception from a callback. May be NULL if there was no exception in a callback.
          +
          +
          Returns:
          +
          throwable
          +
          +
          • +
        + + + +
          +
        • +

          getErrorHeaders

          +
          public HttpHeader[] getErrorHeaders()
          +
          In the case of a failed HTTP response, get the headers of the response. May be NULL.
          +
          +
          Returns:
          +
          array of headers
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3MetaRequest.html b/docs/software/amazon/awssdk/crt/s3/S3MetaRequest.html new file mode 100644 index 000000000..6bd60163b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3MetaRequest.html @@ -0,0 +1,418 @@ + + + + + +S3MetaRequest (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3MetaRequest

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          S3MetaRequest

          +
          public S3MetaRequest()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          cancel

          +
          public void cancel()
          +
          • +
        + + + +
          +
        • +

          pause

          +
          public ResumeToken pause()
          +
          Pauses meta request and returns a token that can be used to resume a meta request. + For PutObject resume, input stream should always start at the beginning, + already uploaded parts will be skipped, but checksums on those will be verified if request specified checksum algo.
          +
          +
          Returns:
          +
          token to resume request. might be null if request has not started executing yet
          +
          +
          • +
        + + + +
          +
        • +

          incrementReadWindow

          +
          public void incrementReadWindow​(long bytes)
          +
          Increment the flow-control window, so that response data continues downloading. +

          + If the client was created with S3ClientOptions.withReadBackpressureEnabled(boolean) set true, + each S3MetaRequest has a flow-control window that shrinks as response + body data is downloaded (headers do not affect the size of the window). + S3ClientOptions.withInitialReadWindowSize(long) sets the starting size for each S3MetaRequest's window. + Whenever the window reaches zero, data stops downloading. + Increment the window to keep data flowing. + Maintain a larger window to keep up a high download throughput, + parts cannot download in parallel unless the window is large enough to hold multiple parts. + Maintain a smaller window to limit the amount of data buffered in memory. +

          + If backpressure is disabled this call has no effect, data is downloaded as fast as possible. +

          + WARNING: This feature is experimental. + Currently, backpressure is only applied to GetObject requests which are split into multiple parts, + and you may still receive some data after the window reaches zero.

          +
          +
          Parameters:
          +
          bytes - size to increment window by
          +
          See Also:
          +
          S3ClientOptions.withReadBackpressureEnabled(boolean)
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.MetaRequestType.html b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.MetaRequestType.html new file mode 100644 index 000000000..014e99b34 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.MetaRequestType.html @@ -0,0 +1,465 @@ + + + + + +S3MetaRequestOptions.MetaRequestType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Enum S3MetaRequestOptions.MetaRequestType

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Serializable, Comparable<S3MetaRequestOptions.MetaRequestType>
      +
      +
      +
      Enclosing class:
      +
      S3MetaRequestOptions
      +
      +
      +
      public static enum S3MetaRequestOptions.MetaRequestType
+extends Enum<S3MetaRequestOptions.MetaRequestType>
      +
      A Meta Request represents a group of generated requests that are being done on behalf of the + original request. For example, one large GetObject request can be transformed into a series + of ranged GetObject requests that are executed in parallel to improve throughput. + + The MetaRequestType is a hint of transformation to be applied.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          DEFAULT

          +
          public static final S3MetaRequestOptions.MetaRequestType DEFAULT
          +
          The Default meta request type sends any request to S3 as-is (with no transformation). For example, + it can be used to pass a CreateBucket request.
          +
          • +
        + + + +
          +
        • +

          GET_OBJECT

          +
          public static final S3MetaRequestOptions.MetaRequestType GET_OBJECT
          +
          The GetObject request will be split into a series of ranged GetObject requests that are + executed in parallel to improve throughput, when possible.
          +
          • +
        + + + +
          +
        • +

          PUT_OBJECT

          +
          public static final S3MetaRequestOptions.MetaRequestType PUT_OBJECT
          +
          The PutObject request will be split into MultiPart uploads that are executed in parallel + to improve throughput, when possible.
          +
          • +
        + + + +
          +
        • +

          COPY_OBJECT

          +
          public static final S3MetaRequestOptions.MetaRequestType COPY_OBJECT
          +
          The CopyObject meta request performs a multi-part copy using multiple S3 UploadPartCopy requests + in parallel, or bypasses a CopyObject request to S3 if the object size is not large enough for + a multipart upload.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static S3MetaRequestOptions.MetaRequestType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (S3MetaRequestOptions.MetaRequestType c : S3MetaRequestOptions.MetaRequestType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static S3MetaRequestOptions.MetaRequestType valueOf​(String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          IllegalArgumentException - if this enum type has no constant with the specified name
          +
          NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getNativeValue

          +
          public int getNativeValue()
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.ResponseFileOption.html b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.ResponseFileOption.html new file mode 100644 index 000000000..8241a2118 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.ResponseFileOption.html @@ -0,0 +1,457 @@ + + + + + +S3MetaRequestOptions.ResponseFileOption (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Enum S3MetaRequestOptions.ResponseFileOption

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.html b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.html new file mode 100644 index 000000000..d031ce580 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestOptions.html @@ -0,0 +1,997 @@ + + + + + +S3MetaRequestOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3MetaRequestOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.S3MetaRequestOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class S3MetaRequestOptions
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          S3MetaRequestOptions

          +
          public S3MetaRequestOptions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          withOperationName

          +
          public S3MetaRequestOptions withOperationName​(String operationName)
          +
          The S3 operation name (eg: "CreateBucket"), + this MUST be set for S3MetaRequestOptions.MetaRequestType.DEFAULT, + it is ignored for other meta request types since the operation is implicit. + + See + S3 API documentation for the canonical list of names. + + This name is used to fill out details in metrics and error reports. + It also drives some operation-specific behavior. + If you pass the wrong name, you risk getting the wrong behavior. + + For example, every operation except "GetObject" has its response checked + for error, even if the HTTP status-code was 200 OK + (see knowledge center). + If you used the DEFAULT type to do + GetObject, + but mis-named it "Download", and the object looked like XML with an error code, + then the meta-request would fail. You risk logging the full response body, + and leaking sensitive data.
          +
          +
          Parameters:
          +
          operationName - the operation name for this S3MetaRequestOptions.MetaRequestType.DEFAULT meta request
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getOperationName

          +
          public String getOperationName()
          +
          • +
        + + + +
          +
        • +

          withChecksumConfig

          +
          public S3MetaRequestOptions withChecksumConfig​(ChecksumConfig checksumConfig)
          +
          The config related to checksum used for the meta request. See ChecksumConfig for details.
          +
          +
          Parameters:
          +
          checksumConfig - The checksum config used for the meta request
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getChecksumConfig

          +
          public ChecksumConfig getChecksumConfig()
          +
          • +
        + + + +
          +
        • +

          withChecksumAlgorithm

          +
          public S3MetaRequestOptions withChecksumAlgorithm​(ChecksumAlgorithm checksumAlgorithm)
          +
          Deprecated. +
          Please use withChecksumConfig(ChecksumConfig) instead. + Specify the checksum algorithm to use use for put requests, if unset defaults to NONE and no checksum will be calculated. + The location of the checksum will be default to trailer.
          +
          +
          +
          Parameters:
          +
          checksumAlgorithm - the checksum algorithm to use use for put requests
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getChecksumAlgorithm

          +
          public ChecksumAlgorithm getChecksumAlgorithm()
          +
          Deprecated.
          +
          +
          Returns:
          +
          the checksum algorithm to use use for put requests
          +
          +
          • +
        + + + +
          +
        • +

          withValidateChecksum

          +
          public S3MetaRequestOptions withValidateChecksum​(boolean validateChecksum)
          +
          Deprecated. +
          Please use withChecksumConfig(ChecksumConfig) instead. + validateChecksum defaults to false, if set to true, it will cause the client to compare a streamed + calculation of the objects checksum to a remotely stored checksum assigned to the object if one exists. + The checksumValidated field passed in parameter of the finished callback will inform + the user if validation ocurred. A mismatch will result in a AWS_ERROR_S3_RESPONSE_CHECKSUM_MISMATCH error
          +
          +
          +
          Parameters:
          +
          validateChecksum - Validate the checksum of response if server provides.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getValidateChecksum

          +
          public boolean getValidateChecksum()
          +
          Deprecated.
          +
          +
          Returns:
          +
          Validate the checksum of response if server provides.
          +
          +
          • +
        + + + +
          +
        • +

          withHttpRequest

          +
          public S3MetaRequestOptions withHttpRequest​(HttpRequest httpRequest)
          +
          Set the initial HTTP request. + + Note: When uploading a file, you can get better performance by setting + withRequestFilePath(java.nio.file.Path) instead of setting a body stream on the HttpRequest. + (If both are set, the file path is used and body stream is ignored)
          +
          +
          Parameters:
          +
          httpRequest - initial HTTP request message.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getHttpRequest

          +
          public HttpRequest getHttpRequest()
          +
          • +
        + + + +
          +
        • +

          withRequestFilePath

          +
          public S3MetaRequestOptions withRequestFilePath​(Path requestFilePath)
          +
          If set, this file is sent as the request's body, and the withHttpRequest(software.amazon.awssdk.crt.http.HttpRequest) body stream is ignored. + + This can give better upload performance than sending data using the body stream.
          +
          +
          Parameters:
          +
          requestFilePath - path to file to send as the request's body.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getRequestFilePath

          +
          public Path getRequestFilePath()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          withCredentialsProvider

          +
          public S3MetaRequestOptions withCredentialsProvider​(CredentialsProvider credentialsProvider)
          +
          Deprecated. +
          Please use withSigningConfig(AwsSigningConfig) instead. + The credentials provider will be used to create the signing Config to override the client level config. + The client config will be used.
          +
          +
          +
          Parameters:
          +
          credentialsProvider - provide credentials for signing.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + +
          +
        • +

          withSigningConfig

          +
          public S3MetaRequestOptions withSigningConfig​(AwsSigningConfig signingConfig)
          +
          The configuration related to signing used by S3 client. It will override the client level configuration if provided. + `AwsSigningConfig.getDefaultS3SigningConfig(region, credentialsProvider);` can be used as helper to create the default configuration to be used for S3. + + If not set, the client configuration will be used. + If set: + - All fields are optional. The credentials will be resolve from client if not set. + - S3 Client will derive the right config for signing process based on this. + + Notes: + - For SIGV4_S3EXPRESS, S3 client will use the credentials in the config to derive the S3Express + credentials that are used in the signing process. + - Client may make modifications to signing config before passing it on to signer.
          +
          +
          Parameters:
          +
          signingConfig - configuration related to signing via an AWS signing process.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getEndpoint

          +
          public URI getEndpoint()
          +
          • +
        + + + + + + + +
          +
        • +

          getResumeToken

          +
          public ResumeToken getResumeToken()
          +
          • +
        + + + + + + + +
          +
        • +

          getObjectSizeHint

          +
          public Long getObjectSizeHint()
          +
          • +
        + + + + + + + +
          +
        • +

          getResponseFilePath

          +
          public Path getResponseFilePath()
          +
          • +
        + + + + + + + + + + + + + + + +
          +
        • +

          getResponseFilePosition

          +
          public long getResponseFilePosition()
          +
          • +
        + + + +
          +
        • +

          withResponseFileDeleteOnFailure

          +
          public S3MetaRequestOptions withResponseFileDeleteOnFailure​(boolean responseFileDeleteOnFailure)
          +
          Sets whether to delete the response file on failure when downloading an + object from S3. + This option is only applicable when a response file path is set.
          +
          +
          Parameters:
          +
          responseFileDeleteOnFailure - True to delete the response file on + failure, + False to leave it as-is.
          +
          Returns:
          +
          this
          +
          +
          • +
        + + + +
          +
        • +

          getResponseFileDeleteOnFailure

          +
          public boolean getResponseFileDeleteOnFailure()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3MetaRequestProgress.html b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestProgress.html new file mode 100644 index 000000000..b807103b1 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestProgress.html @@ -0,0 +1,372 @@ + + + + + +S3MetaRequestProgress (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3MetaRequestProgress

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.S3MetaRequestProgress
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class S3MetaRequestProgress
+extends Object
      +
      Information about the meta request progress.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          S3MetaRequestProgress

          +
          public S3MetaRequestProgress()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          withBytesTransferred

          +
          public S3MetaRequestProgress withBytesTransferred​(long bytesTransferred)
          +
          +
          Parameters:
          +
          bytesTransferred - bytes transferred since the previous progress update
          +
          Returns:
          +
          this progress object
          +
          +
          • +
        + + + +
          +
        • +

          getBytesTransferred

          +
          public long getBytesTransferred()
          +
          +
          Returns:
          +
          bytes transferred since the previous progress update
          +
          +
          • +
        + + + +
          +
        • +

          withContentLength

          +
          public S3MetaRequestProgress withContentLength​(long contentLength)
          +
          +
          Parameters:
          +
          contentLength - length of the entire meta request operation
          +
          Returns:
          +
          this progress object
          +
          +
          • +
        + + + +
          +
        • +

          getContentLength

          +
          public long getContentLength()
          +
          +
          Returns:
          +
          length of the entire meta request operation
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3MetaRequestResponseHandler.html b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestResponseHandler.html new file mode 100644 index 000000000..bbb33a68b --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3MetaRequestResponseHandler.html @@ -0,0 +1,357 @@ + + + + + +S3MetaRequestResponseHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Interface S3MetaRequestResponseHandler

    +
    +
    +
    +
      +
    • +
      +
      public interface S3MetaRequestResponseHandler
      +
      Interface called by native code to provide S3MetaRequest responses.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onResponseHeaders

          +
          default void onResponseHeaders​(int statusCode,
+                               HttpHeader[] headers)
          +
          Invoked to provide response headers received during the execution of the meta request. + Note: the statusCode in this callback is not the final statusCode. It is possible that the statusCode in `onResponseHeaders` + is 200, and then the request fail leading to a different statusCode in the final `onFinished` callback.
          +
          +
          Parameters:
          +
          statusCode - statusCode of the HTTP response
          +
          headers - the headers received
          +
          +
          • +
        + + + +
          +
        • +

          onResponseBody

          +
          default int onResponseBody​(ByteBuffer bodyBytesIn,
+                           long objectRangeStart,
+                           long objectRangeEnd)
          +
          Invoked to provide the response body as it is received. +

          + Note that if the client was created with S3ClientOptions.withReadBackpressureEnabled(boolean) set true, + you must maintain the flow-control window. + The flow-control window shrinks as you receive body data via this callback. + Whenever the flow-control window reaches zero, data will stop downloading. + To keep data flowing, you must increment the window by returning a number + from this method, or by calling S3MetaRequest.incrementReadWindow(long). +

          + If backpressure is disabled, you do not need to maintain the flow-control window, + data will arrive as fast as possible.
          +
          +
          Parameters:
          +
          bodyBytesIn - The body data for this chunk of the object
          +
          objectRangeStart - The byte index of the object that this refers to. For example, for an HTTP message that + has a range header, the first chunk received will have a range_start that matches the range header's range-start
          +
          objectRangeEnd - corresponds to the past-of-end chunk offset, i.e. objectRangeStart + the chunk length
          +
          Returns:
          +
          The number of bytes to increment the flow-control window by + (calling S3MetaRequest.incrementReadWindow(long) has the same effect). + This value is ignored if backpressure is disabled.
          +
          See Also:
          +
          S3ClientOptions.withReadBackpressureEnabled(boolean)
          +
          +
          • +
        + + + +
          +
        • +

          onFinished

          +
          default void onFinished​(S3FinishedResponseContext context)
          +
          Invoked when the entire meta request execution is complete.
          +
          +
          Parameters:
          +
          context - a wrapper object containing the following fields
          +
          +
          • +
        + + + +
          +
        • +

          onProgress

          +
          default void onProgress​(S3MetaRequestProgress progress)
          +
          Invoked to report progress of the meta request execution. + The meaning of "progress" depends on the S3MetaRequestOptions.MetaRequestType. + For PUT_OBJECT, it refers to bytes uploaded. + For COPY_OBJECT, it refers to bytes copied. + For GET_OBJECT, it refers to bytes downloaded. + For anything else, it refers to response body bytes received.
          +
          +
          Parameters:
          +
          progress - information about the progress of the meta request execution
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/S3TcpKeepAliveOptions.html b/docs/software/amazon/awssdk/crt/s3/S3TcpKeepAliveOptions.html new file mode 100644 index 000000000..4ceaf6c39 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/S3TcpKeepAliveOptions.html @@ -0,0 +1,381 @@ + + + + + +S3TcpKeepAliveOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.s3
    +

    Class S3TcpKeepAliveOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class S3TcpKeepAliveOptions
+extends Object
      +
      This class provides access to setting Tcp Keep Alive Options. + If interval or timeout are zero, then default values are used.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          S3TcpKeepAliveOptions

          +
          public S3TcpKeepAliveOptions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getKeepAliveIntervalSec

          +
          public short getKeepAliveIntervalSec()
          +
          • +
        + + + +
          +
        • +

          setKeepAliveIntervalSec

          +
          public void setKeepAliveIntervalSec​(short keepAliveIntervalSec)
          +
          • +
        + + + +
          +
        • +

          getKeepAliveTimeoutSec

          +
          public short getKeepAliveTimeoutSec()
          +
          • +
        + + + +
          +
        • +

          setKeepAliveTimeoutSec

          +
          public void setKeepAliveTimeoutSec​(short keepAliveTimeoutSec)
          +
          • +
        + + + +
          +
        • +

          getKeepAliveMaxFailedProbes

          +
          public short getKeepAliveMaxFailedProbes()
          +
          • +
        + + + +
          +
        • +

          setKeepAliveMaxFailedProbes

          +
          public void setKeepAliveMaxFailedProbes​(short keepAliveMaxFailedProbes)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumAlgorithm.html b/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumAlgorithm.html new file mode 100644 index 000000000..735119d21 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumAlgorithm.html @@ -0,0 +1,285 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.ChecksumAlgorithm (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.ChecksumAlgorithm

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumConfig.ChecksumLocation.html b/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumConfig.ChecksumLocation.html new file mode 100644 index 000000000..097a26443 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumConfig.ChecksumLocation.html @@ -0,0 +1,227 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.ChecksumConfig.ChecksumLocation

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumConfig.html b/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumConfig.html new file mode 100644 index 000000000..0fad94e0f --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/ChecksumConfig.html @@ -0,0 +1,241 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.ChecksumConfig (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.ChecksumConfig

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/ResumeToken.PutResumeTokenBuilder.html b/docs/software/amazon/awssdk/crt/s3/class-use/ResumeToken.PutResumeTokenBuilder.html new file mode 100644 index 000000000..2b8572768 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/ResumeToken.PutResumeTokenBuilder.html @@ -0,0 +1,223 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.ResumeToken.PutResumeTokenBuilder

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/ResumeToken.html b/docs/software/amazon/awssdk/crt/s3/class-use/ResumeToken.html new file mode 100644 index 000000000..663e40e65 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/ResumeToken.html @@ -0,0 +1,222 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.ResumeToken (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.ResumeToken

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3Client.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3Client.html new file mode 100644 index 000000000..08e0cd29e --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3Client.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3Client (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3Client

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3ClientOptions.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3ClientOptions.html new file mode 100644 index 000000000..eef8db3ce --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3ClientOptions.html @@ -0,0 +1,333 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3ClientOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3ClientOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProperties.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProperties.html new file mode 100644 index 000000000..e962c1366 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProperties.html @@ -0,0 +1,225 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3ExpressCredentialsProperties

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProvider.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProvider.html new file mode 100644 index 000000000..115bf934c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProvider.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3ExpressCredentialsProvider (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3ExpressCredentialsProvider

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProviderFactory.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProviderFactory.html new file mode 100644 index 000000000..88accfe0c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProviderFactory.html @@ -0,0 +1,210 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderFactory (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderFactory

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProviderHandler.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProviderHandler.html new file mode 100644 index 000000000..6f1477873 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3ExpressCredentialsProviderHandler.html @@ -0,0 +1,193 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.s3.S3ExpressCredentialsProviderHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3FinishedResponseContext.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3FinishedResponseContext.html new file mode 100644 index 000000000..812fc0463 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3FinishedResponseContext.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3FinishedResponseContext (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3FinishedResponseContext

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequest.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequest.html new file mode 100644 index 000000000..d2b986513 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequest.html @@ -0,0 +1,195 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3MetaRequest (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3MetaRequest

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.MetaRequestType.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.MetaRequestType.html new file mode 100644 index 000000000..541fd72d3 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.MetaRequestType.html @@ -0,0 +1,235 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3MetaRequestOptions.MetaRequestType

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.ResponseFileOption.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.ResponseFileOption.html new file mode 100644 index 000000000..2c6072cce --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.ResponseFileOption.html @@ -0,0 +1,233 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3MetaRequestOptions.ResponseFileOption

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.html new file mode 100644 index 000000000..9016c1eb6 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestOptions.html @@ -0,0 +1,324 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3MetaRequestOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3MetaRequestOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestProgress.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestProgress.html new file mode 100644 index 000000000..46291cebf --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestProgress.html @@ -0,0 +1,217 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3MetaRequestProgress (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3MetaRequestProgress

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestResponseHandler.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestResponseHandler.html new file mode 100644 index 000000000..79c9ce34c --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3MetaRequestResponseHandler.html @@ -0,0 +1,210 @@ + + + + + +Uses of Interface software.amazon.awssdk.crt.s3.S3MetaRequestResponseHandler (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Interface
    software.amazon.awssdk.crt.s3.S3MetaRequestResponseHandler

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/class-use/S3TcpKeepAliveOptions.html b/docs/software/amazon/awssdk/crt/s3/class-use/S3TcpKeepAliveOptions.html new file mode 100644 index 000000000..0d702d8ee --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/class-use/S3TcpKeepAliveOptions.html @@ -0,0 +1,210 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.s3.S3TcpKeepAliveOptions

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/package-summary.html b/docs/software/amazon/awssdk/crt/s3/package-summary.html new file mode 100644 index 000000000..6040e42dc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/package-summary.html @@ -0,0 +1,276 @@ + + + + + +software.amazon.awssdk.crt.s3 (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.s3

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/package-tree.html b/docs/software/amazon/awssdk/crt/s3/package-tree.html new file mode 100644 index 000000000..df65f06b8 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/package-tree.html @@ -0,0 +1,206 @@ + + + + + +software.amazon.awssdk.crt.s3 Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.s3

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/s3/package-use.html b/docs/software/amazon/awssdk/crt/s3/package-use.html new file mode 100644 index 000000000..f6701aa97 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/s3/package-use.html @@ -0,0 +1,271 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.s3 (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.s3

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/ByteBufferUtils.html b/docs/software/amazon/awssdk/crt/utils/ByteBufferUtils.html new file mode 100644 index 000000000..480f0caa9 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/ByteBufferUtils.html @@ -0,0 +1,282 @@ + + + + + +ByteBufferUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.utils
    +

    Class ByteBufferUtils

    +
    +
    + +
    +
      +
    • +
      +
      public class ByteBufferUtils
+extends Object
      +
      Utility Class with Helper functions for working with ByteBuffers
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          transferData

          +
          public static int transferData​(ByteBuffer in,
+                               ByteBuffer out)
          +
          Transfers as much data as possible from an input ByteBuffer to an output ByteBuffer
          +
          +
          Parameters:
          +
          in - The input ByteBuffer
          +
          out - The output ByteBuffer
          +
          Returns:
          +
          The number of bytes transferred
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/PackageInfo.Version.html b/docs/software/amazon/awssdk/crt/utils/PackageInfo.Version.html new file mode 100644 index 000000000..14b249acc --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/PackageInfo.Version.html @@ -0,0 +1,402 @@ + + + + + +PackageInfo.Version (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.utils
    +

    Class PackageInfo.Version

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.awssdk.crt.utils.PackageInfo.Version
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      PackageInfo
      +
      +
      +
      public static class PackageInfo.Version
+extends Object
      +
      Class representing the introspected semantic version of the CRT library
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          major

          +
          public final int major
          +
          • +
        + + + +
          +
        • +

          minor

          +
          public final int minor
          +
          • +
        + + + +
          +
        • +

          patch

          +
          public final int patch
          +
          • +
        + + + +
          +
        • +

          tag

          +
          public final String tag
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Version

          +
          public Version​(String v)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/PackageInfo.html b/docs/software/amazon/awssdk/crt/utils/PackageInfo.html new file mode 100644 index 000000000..5fc0875ca --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/PackageInfo.html @@ -0,0 +1,345 @@ + + + + + +PackageInfo (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.utils
    +

    Class PackageInfo

    +
    +
    + +
    +
      +
    • +
      +
      public final class PackageInfo
+extends Object
      +
      Class that wraps version and package introspection
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class PackageInfo.Version +
        Class representing the introspected semantic version of the CRT library
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        PackageInfo.Versionversion +
        the introspected semantic version of the CRT library instance
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PackageInfo() +
        Default constructor
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          version

          +
          public PackageInfo.Version version
          +
          the introspected semantic version of the CRT library instance
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PackageInfo

          +
          public PackageInfo()
          +
          Default constructor
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/PemUtils.html b/docs/software/amazon/awssdk/crt/utils/PemUtils.html new file mode 100644 index 000000000..3d8408f70 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/PemUtils.html @@ -0,0 +1,373 @@ + + + + + +PemUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.utils
    +

    Class PemUtils

    +
    +
    + +
    +
      +
    • +
      +
      public class PemUtils
+extends Object
      +
      Utility Class used for Cleaning Up and Sanity Checking PEM formatted Strings + for Validity.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          removeInvalidPemChars

          +
          public static String removeInvalidPemChars​(String pem)
          +
          Removes characters that are not valid in PEM format (non-base64 chars). No other cleanup is + done.
          +
          +
          Parameters:
          +
          pem - The input "dirty" PEM
          +
          Returns:
          +
          The output "clean" PEM
          +
          +
          • +
        + + + +
          +
        • +

          cleanUpPem

          +
          public static String cleanUpPem​(String pem)
          +
          Cleanup Function that removes most formatting and copy/paste mistakes from + PEM formatted Strings.
          +
          +
          Parameters:
          +
          pem - The input "dirty" PEM
          +
          Returns:
          +
          The output "clean" PEM
          +
          +
          • +
        + + + +
          +
        • +

          sanityCheck

          +
          public static void sanityCheck​(String pem,
+                               int maxChainLength,
+                               String expectedPemTypeSubString)
          +
          Performs various sanity checks on a PEM Formatted String, and should be + tolerant of common minor mistakes in formatting.
          +
          +
          Parameters:
          +
          pem - The PEM or PEM Chain to validate.
          +
          maxChainLength - The max number of PEM encoded objects in the + String.
          +
          expectedPemTypeSubString - A Substring that is expected to be present in + the PEM Type.
          +
          Throws:
          +
          IllegalArgumentException - if there is a problem with the PEM formatted + String.
          +
          +
          • +
        + + + +
          +
        • +

          safeSanityCheck

          +
          public static boolean safeSanityCheck​(String pem,
+                                      int maxChainLength,
+                                      String expectedPemTypeSubString)
          +
          Returns false if there is a problem with a PEM instead of throwing an + Exception.
          +
          +
          Parameters:
          +
          pem - The PEM to sanity check.
          +
          maxChainLength - The Max number of PEM Objects in the PEM + String
          +
          expectedPemTypeSubString - A Substring that is expected to be present in + the PEM Type.
          +
          Returns:
          +
          True if the PEM passes all sanity Checks, false otherwise.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/StringUtils.html b/docs/software/amazon/awssdk/crt/utils/StringUtils.html new file mode 100644 index 000000000..afc197efa --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/StringUtils.html @@ -0,0 +1,368 @@ + + + + + +StringUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.awssdk.crt.utils
    +

    Class StringUtils

    +
    +
    + +
    +
      +
    • +
      +
      public class StringUtils
+extends Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StringUtils

          +
          public StringUtils()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          join

          +
          public static String join​(CharSequence delimiter,
+                          Iterable<? extends CharSequence> elements)
          +
          Returns a new String composed of copies of the CharSequence elements joined together with a copy of the specified delimiter. + Like `Strings.join()` but works on Android before API 26.
          +
          +
          Parameters:
          +
          delimiter - a sequence of characters that is used to separate each of the elements in the resulting String
          +
          elements - an Iterable that will have its elements joined together
          +
          Returns:
          +
          a new String that is composed from the elements argument
          +
          +
          • +
        + + + +
          +
        • +

          base64Encode

          +
          public static byte[] base64Encode​(byte[] data)
          +
          Encode a byte array into a Base64 byte array.
          +
          +
          Parameters:
          +
          data - The byte array to encode
          +
          Returns:
          +
          The byte array encoded as Byte64
          +
          +
          • +
        + + + +
          +
        • +

          base64Decode

          +
          public static byte[] base64Decode​(byte[] data)
          +
          Decode a Base64 byte array into a non-Base64 byte array.
          +
          +
          Parameters:
          +
          data - The byte array to decode.
          +
          Returns:
          +
          Byte array decoded from Base64.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/class-use/ByteBufferUtils.html b/docs/software/amazon/awssdk/crt/utils/class-use/ByteBufferUtils.html new file mode 100644 index 000000000..caae621d5 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/class-use/ByteBufferUtils.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.utils.ByteBufferUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.utils.ByteBufferUtils

    +
    +
    No usage of software.amazon.awssdk.crt.utils.ByteBufferUtils
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/class-use/PackageInfo.Version.html b/docs/software/amazon/awssdk/crt/utils/class-use/PackageInfo.Version.html new file mode 100644 index 000000000..b01eef4c4 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/class-use/PackageInfo.Version.html @@ -0,0 +1,223 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.utils.PackageInfo.Version (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.utils.PackageInfo.Version

    +
    +
    + +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/class-use/PackageInfo.html b/docs/software/amazon/awssdk/crt/utils/class-use/PackageInfo.html new file mode 100644 index 000000000..910b5a928 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/class-use/PackageInfo.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.utils.PackageInfo (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.utils.PackageInfo

    +
    +
    No usage of software.amazon.awssdk.crt.utils.PackageInfo
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/class-use/PemUtils.html b/docs/software/amazon/awssdk/crt/utils/class-use/PemUtils.html new file mode 100644 index 000000000..f07a5dc36 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/class-use/PemUtils.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.utils.PemUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.utils.PemUtils

    +
    +
    No usage of software.amazon.awssdk.crt.utils.PemUtils
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/class-use/StringUtils.html b/docs/software/amazon/awssdk/crt/utils/class-use/StringUtils.html new file mode 100644 index 000000000..aac46b0fd --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/class-use/StringUtils.html @@ -0,0 +1,151 @@ + + + + + +Uses of Class software.amazon.awssdk.crt.utils.StringUtils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    software.amazon.awssdk.crt.utils.StringUtils

    +
    +
    No usage of software.amazon.awssdk.crt.utils.StringUtils
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/package-summary.html b/docs/software/amazon/awssdk/crt/utils/package-summary.html new file mode 100644 index 000000000..7d8d96caa --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/package-summary.html @@ -0,0 +1,194 @@ + + + + + +software.amazon.awssdk.crt.utils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.awssdk.crt.utils

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ByteBufferUtils +
      Utility Class with Helper functions for working with ByteBuffers
      +
      PackageInfo +
      Class that wraps version and package introspection
      +
      PackageInfo.Version +
      Class representing the introspected semantic version of the CRT library
      +
      PemUtils +
      Utility Class used for Cleaning Up and Sanity Checking PEM formatted Strings + for Validity.
      +
      StringUtils 
      +
      • +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/package-tree.html b/docs/software/amazon/awssdk/crt/utils/package-tree.html new file mode 100644 index 000000000..d866c2012 --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/package-tree.html @@ -0,0 +1,170 @@ + + + + + +software.amazon.awssdk.crt.utils Class Hierarchy (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.awssdk.crt.utils

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    +
    + +

    Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.

    +
    + + diff --git a/docs/software/amazon/awssdk/crt/utils/package-use.html b/docs/software/amazon/awssdk/crt/utils/package-use.html new file mode 100644 index 000000000..971b1a0ec --- /dev/null +++ b/docs/software/amazon/awssdk/crt/utils/package-use.html @@ -0,0 +1,211 @@ + + + + + +Uses of Package software.amazon.awssdk.crt.utils (AWS Common Runtime for Java/JVM) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Package
    software.amazon.awssdk.crt.utils

    +
    +
    + +
    +
    + + + diff --git a/docs/stylesheet.css b/docs/stylesheet.css new file mode 100644 index 000000000..de945eda2 --- /dev/null +++ b/docs/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/docs/type-search-index.js b/docs/type-search-index.js new file mode 100644 index 000000000..3cd5f4526 --- /dev/null +++ b/docs/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"l":"All Classes","url":"allclasses-index.html"},{"p":"software.amazon.awssdk.crt","l":"AsyncCallback"},{"p":"software.amazon.awssdk.crt.cal","l":"EccKeyPair.AwsEccCurve"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningConfig.AwsSignatureType"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningConfig.AwsSignedBodyHeaderType"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningConfig.AwsSignedBodyValue"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigner"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningConfig.AwsSigningAlgorithm"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningConfig"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningResult"},{"p":"software.amazon.awssdk.crt.auth.signing","l":"AwsSigningUtils"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"EcsCredentialsProvider.Builder"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"ProfileCredentialsProvider.Builder"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"StsCredentialsProvider.Builder"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"StsWebIdentityCredentialsProvider.Builder"},{"p":"software.amazon.awssdk.crt.utils","l":"ByteBufferUtils"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"CachedCredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"CachedCredentialsProvider.CachedCredentialsProviderBuilder"},{"p":"software.amazon.awssdk.crt.s3","l":"ChecksumAlgorithm"},{"p":"software.amazon.awssdk.crt.s3","l":"ChecksumConfig"},{"p":"software.amazon.awssdk.crt.s3","l":"ChecksumConfig.ChecksumLocation"},{"p":"software.amazon.awssdk.crt.io","l":"ClientBootstrap"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ClientConnection"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ClientConnectionContinuation"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ClientConnectionContinuationHandler"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ClientConnectionHandler"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions.ClientOfflineQueueBehavior"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions.ClientSessionBehavior"},{"p":"software.amazon.awssdk.crt.io","l":"ClientTlsContext"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"CognitoCredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"CognitoCredentialsProvider.CognitoCredentialsProviderBuilder"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"CognitoCredentialsProvider.CognitoLoginTokenPair"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"ConnAckPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"ConnectPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"ConnectPacket.ConnectPacketBuilder"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"ConnAckPacket.ConnectReasonCode"},{"p":"software.amazon.awssdk.crt","l":"SystemInfo.CpuInfo"},{"p":"software.amazon.awssdk.crt.checksums","l":"CRC32"},{"p":"software.amazon.awssdk.crt.checksums","l":"CRC32C"},{"p":"software.amazon.awssdk.crt.checksums","l":"CRC64NVME"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"Credentials"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"CredentialsProvider"},{"p":"software.amazon.awssdk.crt","l":"CRT"},{"p":"software.amazon.awssdk.crt","l":"CrtPlatform"},{"p":"software.amazon.awssdk.crt","l":"CrtResource"},{"p":"software.amazon.awssdk.crt","l":"CrtRuntimeException"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"DefaultChainCredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"DefaultChainCredentialsProvider.DefaultChainCredentialsProviderBuilder"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"DelegateCredentialsHandler"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"DelegateCredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"DelegateCredentialsProvider.DelegateCredentialsProviderBuilder"},{"p":"software.amazon.awssdk.crt.io","l":"DirectoryEntry"},{"p":"software.amazon.awssdk.crt.io","l":"DirectoryTraversal"},{"p":"software.amazon.awssdk.crt.io","l":"DirectoryTraversalHandler"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"DisconnectPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"DisconnectPacket.DisconnectPacketBuilder"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"DisconnectPacket.DisconnectReasonCode"},{"p":"software.amazon.awssdk.crt.cal","l":"EccKeyPair"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"EcsCredentialsProvider"},{"p":"software.amazon.awssdk.crt.io","l":"EventLoopGroup"},{"p":"software.amazon.awssdk.crt.io","l":"ExponentialBackoffRetryOptions"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions"},{"p":"software.amazon.awssdk.crt.eventstream","l":"Header"},{"p":"software.amazon.awssdk.crt.eventstream","l":"HeaderType"},{"p":"software.amazon.awssdk.crt.io","l":"HostResolver"},{"p":"software.amazon.awssdk.crt.http","l":"Http2ClientConnection"},{"p":"software.amazon.awssdk.crt.http","l":"Http2ConnectionSetting"},{"p":"software.amazon.awssdk.crt.http","l":"Http2ConnectionSettingListBuilder"},{"p":"software.amazon.awssdk.crt.http","l":"Http2ClientConnection.Http2ErrorCode"},{"p":"software.amazon.awssdk.crt.http","l":"Http2Request"},{"p":"software.amazon.awssdk.crt.http","l":"Http2Stream"},{"p":"software.amazon.awssdk.crt.http","l":"Http2StreamManager"},{"p":"software.amazon.awssdk.crt.http","l":"Http2StreamManagerOptions"},{"p":"software.amazon.awssdk.crt.http","l":"HttpClientConnection"},{"p":"software.amazon.awssdk.crt.http","l":"HttpClientConnectionManager"},{"p":"software.amazon.awssdk.crt.http","l":"HttpClientConnectionManagerOptions"},{"p":"software.amazon.awssdk.crt.http","l":"HttpException"},{"p":"software.amazon.awssdk.crt.http","l":"HttpHeader"},{"p":"software.amazon.awssdk.crt.http","l":"HttpHeaderBlock"},{"p":"software.amazon.awssdk.crt.http","l":"HttpManagerMetrics"},{"p":"software.amazon.awssdk.crt.http","l":"HttpMonitoringOptions"},{"p":"software.amazon.awssdk.crt.http","l":"HttpProxyOptions.HttpProxyAuthorizationType"},{"p":"software.amazon.awssdk.crt.http","l":"HttpProxyOptions.HttpProxyConnectionType"},{"p":"software.amazon.awssdk.crt.http","l":"HttpProxyEnvironmentVariableSetting"},{"p":"software.amazon.awssdk.crt.http","l":"HttpProxyEnvironmentVariableSetting.HttpProxyEnvironmentVariableType"},{"p":"software.amazon.awssdk.crt.http","l":"HttpProxyOptions"},{"p":"software.amazon.awssdk.crt.http","l":"HttpRequest"},{"p":"software.amazon.awssdk.crt.http","l":"HttpRequestBase"},{"p":"software.amazon.awssdk.crt.http","l":"HttpRequestBodyStream"},{"p":"software.amazon.awssdk.crt.http","l":"HttpStream"},{"p":"software.amazon.awssdk.crt.http","l":"HttpStreamBase"},{"p":"software.amazon.awssdk.crt.http","l":"HttpStreamBaseResponseHandler"},{"p":"software.amazon.awssdk.crt.http","l":"HttpStreamMetrics"},{"p":"software.amazon.awssdk.crt.http","l":"HttpStreamResponseHandler"},{"p":"software.amazon.awssdk.crt.http","l":"HttpStream.HttpStreamWriteChunkCompletionCallback"},{"p":"software.amazon.awssdk.crt.http","l":"HttpVersion"},{"p":"software.amazon.awssdk.crt.http","l":"Http2ConnectionSetting.ID"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"TopicAliasingOptions.InboundTopicAliasBehaviorType"},{"p":"software.amazon.awssdk.crt.io","l":"Pkcs11Lib.InitializeFinalizeBehavior"},{"p":"software.amazon.awssdk.crt.io","l":"ExponentialBackoffRetryOptions.JitterMode"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions.LifecycleEvents"},{"p":"software.amazon.awssdk.crt","l":"Log"},{"p":"software.amazon.awssdk.crt","l":"Log.LogLevel"},{"p":"software.amazon.awssdk.crt","l":"Log.LogSubject"},{"p":"software.amazon.awssdk.crt.eventstream","l":"Message"},{"p":"software.amazon.awssdk.crt.eventstream","l":"MessageFlags"},{"p":"software.amazon.awssdk.crt.eventstream","l":"MessageFlushCallback"},{"p":"software.amazon.awssdk.crt.eventstream","l":"MessageType"},{"p":"software.amazon.awssdk.crt.s3","l":"S3MetaRequestOptions.MetaRequestType"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5Client"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOperationStatistics"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions.Mqtt5ClientOptionsBuilder"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5WebsocketHandshakeTransformArgs"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttClient"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttClientConnection"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttClientConnectionEvents"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttClientConnectionOperationStatistics"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttConnectionConfig"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttException"},{"p":"software.amazon.awssdk.crt.mqtt","l":"MqttMessage"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"NegotiatedSettings"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"OnAttemptingConnectReturn"},{"p":"software.amazon.awssdk.crt.mqtt","l":"OnConnectionClosedReturn"},{"p":"software.amazon.awssdk.crt.mqtt","l":"OnConnectionFailureReturn"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"OnConnectionFailureReturn"},{"p":"software.amazon.awssdk.crt.mqtt","l":"OnConnectionSuccessReturn"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"OnConnectionSuccessReturn"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"OnDisconnectionReturn"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"OnStoppedReturn"},{"p":"software.amazon.awssdk.crt.eventstream","l":"OperationRoutingServerConnectionHandler"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"TopicAliasingOptions.OutboundTopicAliasBehaviorType"},{"p":"software.amazon.awssdk.crt.utils","l":"PackageInfo"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"PublishPacket.PayloadFormatIndicator"},{"p":"software.amazon.awssdk.crt.utils","l":"PemUtils"},{"p":"software.amazon.awssdk.crt.io","l":"Pkcs11Lib"},{"p":"software.amazon.awssdk.crt","l":"Process"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"ProfileCredentialsProvider"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"PubAckPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"PubAckPacket.PubAckReasonCode"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"Mqtt5ClientOptions.PublishEvents"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"PublishPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"PublishPacket.PublishPacketBuilder"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"PublishResult"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"PublishResult.PublishResultType"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"PublishReturn"},{"p":"software.amazon.awssdk.crt.s3","l":"ResumeToken.PutResumeTokenBuilder"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"QOS"},{"p":"software.amazon.awssdk.crt.mqtt","l":"QualityOfService"},{"p":"software.amazon.awssdk.crt","l":"CrtResource.ResourceInstance"},{"p":"software.amazon.awssdk.crt.s3","l":"S3MetaRequestOptions.ResponseFileOption"},{"p":"software.amazon.awssdk.crt.s3","l":"ResumeToken"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"SubscribePacket.RetainHandlingType"},{"p":"software.amazon.awssdk.crt.s3","l":"S3Client"},{"p":"software.amazon.awssdk.crt.s3","l":"S3ClientOptions"},{"p":"software.amazon.awssdk.crt.s3","l":"S3ExpressCredentialsProperties"},{"p":"software.amazon.awssdk.crt.s3","l":"S3ExpressCredentialsProvider"},{"p":"software.amazon.awssdk.crt.s3","l":"S3ExpressCredentialsProviderFactory"},{"p":"software.amazon.awssdk.crt.s3","l":"S3ExpressCredentialsProviderHandler"},{"p":"software.amazon.awssdk.crt.s3","l":"S3FinishedResponseContext"},{"p":"software.amazon.awssdk.crt.s3","l":"S3MetaRequest"},{"p":"software.amazon.awssdk.crt.s3","l":"S3MetaRequestOptions"},{"p":"software.amazon.awssdk.crt.s3","l":"S3MetaRequestProgress"},{"p":"software.amazon.awssdk.crt.s3","l":"S3MetaRequestResponseHandler"},{"p":"software.amazon.awssdk.crt.s3","l":"S3TcpKeepAliveOptions"},{"p":"software.amazon.awssdk.crt.io","l":"ServerBootstrap"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ServerConnection"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ServerConnectionContinuation"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ServerConnectionContinuationHandler"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ServerConnectionHandler"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ServerListener"},{"p":"software.amazon.awssdk.crt.eventstream","l":"ServerListenerHandler"},{"p":"software.amazon.awssdk.crt.io","l":"ServerTlsContext"},{"p":"software.amazon.awssdk.crt.io","l":"SocketOptions.SocketDomain"},{"p":"software.amazon.awssdk.crt.io","l":"SocketOptions"},{"p":"software.amazon.awssdk.crt.io","l":"SocketOptions.SocketType"},{"p":"software.amazon.awssdk.crt.io","l":"StandardRetryOptions"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"StaticCredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"StaticCredentialsProvider.StaticCredentialsProviderBuilder"},{"p":"software.amazon.awssdk.crt.utils","l":"StringUtils"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"StsCredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"StsWebIdentityCredentialsProvider"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"SubAckPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"SubAckPacket.SubAckReasonCode"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"SubscribePacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"SubscribePacket.SubscribePacketBuilder"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"SubscribePacket.Subscription"},{"p":"software.amazon.awssdk.crt","l":"SystemInfo"},{"p":"software.amazon.awssdk.crt.io","l":"TlsCipherPreference"},{"p":"software.amazon.awssdk.crt.io","l":"TlsConnectionOptions"},{"p":"software.amazon.awssdk.crt.io","l":"TlsContext"},{"p":"software.amazon.awssdk.crt.io","l":"TlsContextCustomKeyOperationOptions"},{"p":"software.amazon.awssdk.crt.io","l":"TlsContextOptions"},{"p":"software.amazon.awssdk.crt.io","l":"TlsContextPkcs11Options"},{"p":"software.amazon.awssdk.crt.io","l":"TlsHashAlgorithm"},{"p":"software.amazon.awssdk.crt.io","l":"TlsKeyOperation"},{"p":"software.amazon.awssdk.crt.io","l":"TlsKeyOperationHandler"},{"p":"software.amazon.awssdk.crt.io","l":"TlsSignatureAlgorithm"},{"p":"software.amazon.awssdk.crt.io","l":"TlsContextOptions.TlsVersions"},{"p":"software.amazon.awssdk.crt.mqtt5","l":"TopicAliasingOptions"},{"p":"software.amazon.awssdk.crt.io","l":"TlsKeyOperation.Type"},{"p":"software.amazon.awssdk.crt","l":"CRT.UnknownPlatformException"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"UnsubAckPacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"UnsubAckPacket.UnsubAckReasonCode"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"UnsubscribePacket"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"UnsubscribePacket.UnsubscribePacketBuilder"},{"p":"software.amazon.awssdk.crt.io","l":"Uri"},{"p":"software.amazon.awssdk.crt.mqtt5.packets","l":"UserProperty"},{"p":"software.amazon.awssdk.crt.utils","l":"PackageInfo.Version"},{"p":"software.amazon.awssdk.crt.mqtt","l":"WebsocketHandshakeTransformArgs"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"X509CredentialsProvider"},{"p":"software.amazon.awssdk.crt.auth.credentials","l":"X509CredentialsProvider.X509CredentialsProviderBuilder"}] \ No newline at end of file diff --git a/docs/type-search-index.zip b/docs/type-search-index.zip new file mode 100644 index 000000000..a8843c7b1 Binary files /dev/null and b/docs/type-search-index.zip differ