IPWorks Cloud 2020 Android Edition

Questions / Feedback?

AmazonGlacier Component

Properties   Methods   Events   Configuration Settings   Errors  

The AmazonGlacier component provides a quick way to interface with Amazon's Glacier service.

Syntax

IPWorksCloud.Amazonglacier

Remarks

The AmazonGlacier component allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the component you must first have an AWS account and sign up for the Glacier service. To use the component first set AccessKey and SecretKey.

To create a vault call CreateVault. Once the vault is created you are ready to upload archives to store in the vault. Set LocalFile to the file you want to upload and call UploadArchive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call CreateJob. Use the SetNotificationInfo method to set notification options at the vault level. You may also supply an Amazon SNS topic to CreateJob to which Amazon will publish notification about the job status.

You can also call CreateJob to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use GetJobOutput to retrieve the data.

Additionally, multipart uploads are supported through the StartMultipartUpload and CompleteMultipartUpload methods. Various other operations such as DeleteArchive, GetJobInfo, ListJobs, ListMultipartUploads, ListVaults, and more provide additional functionality.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AccessKeyThe access key to use for authentication.
ArchiveDataHolds the archive data.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
InventoryDataHolds the inventory data.
JobMarkerA marker used to get the next page of results.
JobsA collection providing details about the jobs.
LocalFileThe path to a local file for uploading or downloading.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MultipartUploadMarkerA marker used to get the next page of results.
MultipartUploadsA collection of multipart upload details.
NotificationInfoHolds information about the notification settings for a vault.
OtherHeadersOther headers as determined by the user (optional).
OverwriteWhether or not the component should overwrite files during transfer.
ParsedHeadersCollection of headers returned from the last request.
PartMarkerA marker used to get the next page of results.
PartsA collection of multipart upload parts.
ProxyA set of properties related to proxy access.
RegionThe region the component will make requests against.
SecretKeyThe secret key to use for authentication.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
UseSSLWhether to use SSL/TLS when connecting.
VaultMarkerA marker used to get the next page of results.
VaultsA collection of vault information.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

abortMultipartUploadAborts a multipart upload.
completeMultipartUploadCompletes a multipart upload.
configSets or retrieves a configuration setting.
createJobCreates a new job.
createVaultCreates a new vault.
deleteArchiveDeletes an archive.
deleteNotificationInfoDeletes the notification information for the vault.
deleteVaultDeletes the specified vault.
doEventsProcesses events from the internal message queue.
getJobInfoRetrieves information about the specified job.
getJobOutputRetrieves the output from the job.
getNotificationInfoRetrieves the notification information for the vault.
getVaultInfoRetrieves vault details.
interruptInterrupt the current method.
listJobsLists the jobs in a vault.
listMultipartUploadsLists multipart uploads.
listPartsLists the parts of a multipart upload.
listVaultsLists the vaults.
resetResets the component to its initial state.
setDownloadStreamSets the stream to which the downloaded data from the server will be written.
setNotificationInfoSets notification information for a vault.
setUploadStreamSets the stream to be uploaded to the server.
startMultipartUploadStarts a multipart upload.
uploadArchiveUploads an archive to a vault.
uploadPartUploads a single part in a multipart upload.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
JobListFires once for each job returned when calling ListJobs or GetJobInfo.
LogFires once for each log message.
MultipartUploadListFires once for each multipart upload when ListMultipartUploads is called.
PartListFires once for each part when calling ListParts.
ProgressFires during an upload or download to indicate transfer progress.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).
VaultListFires once for each vault returned when calling ListVaults.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

AccumulatePagesWhether the component should accumulate subsequent pages of results when listing them.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
IsJobPagedWhether or not the ListJobs results are paged.
IsMultipartUploadPagedWhether or not the ListMultipartUploads results are paged.
IsPartPagedWhether or not the ListParts results are paged.
IsVaultPagedWhether or not the ListVaults results are paged.
JobCompletionFilterSpecifies the state of jobs to return when calling ListJobs.
JobDescriptionThe description for the job.
JobInventoryFormatThe format of data returned from an inventory retrieval.
JobOutputByteRangeThe byte range to retrieve.
JobRetrievalByteRangeA range of bytes to retrieve.
JobStatusFilterSpecifies the status of jobs to return when calling ListJobs.
LocationURIThe relative URI of the resource.
MaxListJobResultsThe maximum number of Jobs to return.
MaxListMultipartUploadResultsThe maximum number of Multipart Uploads to return.
MaxListPartResultsThe maximum number of Parts to return.
MaxListVaultResultsThe maximum number of Vaults to return.
PartSizeThe size in megabytes of each part in a multipart upload.
ProgressAbsoluteWhether the component should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RequestIdThe Amazon generated RequestId.
TransferredDataReturns the entire XML response received from the server.
URLIf set, the default URL will be overridden by this value.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLContextProtocolThe protocol used when getting an SSLContext instance.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithmThe algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the component are daemon threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Android Edition - Version 20.0 [Build 8265]