CkHttp Java Reference Documentation

CkHttp

Class for sending HTTP requests and receiving server responses.

  • Supports GET, POST, HEAD, PUT, DELETE, WebDav, and custom HTTP request methods.
  • HTTP Authentication: Basic, NTLM, Digest, Negotiate
  • HTTPS (SSL/TLS) with client-side certificate capabilities.
  • Cookie caching, auto-resend, persisting to XML files.
  • Content caching.
  • Supports HTTP proxies
  • Auto-follow redirects if desired.
  • Amazon S3 methods.
  • XML HTTP Request
  • HTTP file upload capabilities
  • Asynchronous features -- putting HTTP requests in background threads.
  • Supports SOCK5/SOCKS4 proxies.
  • IPv6 capable.

Object Creation

CkHttp obj = new CkHttp();

Properties

boolean get_AbortCurrent();
void put_AbortCurrent(boolean newVal);

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

void get_Accept(CkString str);
String ck_accept();
void put_Accept(String newVal);

The Accept header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "*/*".

void get_AcceptCharset(CkString str);
String acceptCharset();
void put_AcceptCharset(String newVal);

The AcceptCharset header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "ISO-8859-1,utf-8;q=0.7,*;q=0.7".

void get_AcceptLanguage(CkString str);
String acceptLanguage();
void put_AcceptLanguage(String newVal);

The AcceptLanguage header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "en-us,en;q=0.5".

boolean get_AllowGzip();
void put_AllowGzip(boolean newVal);

Controls whether the "Accept-Encoding: gzip" header is added to HTTP requests sent via any method that sends an HTTP request without using the HttpRequest object (such as QuickGetStr). If false, then the empty Accept-Encoding header is added which means the server response should contain the uncompressed content. The default value is true, which means the server, if it chooses, may send a gzipped response.

boolean get_AllowHeaderFolding();
void put_AllowHeaderFolding(boolean newVal);

Introduced in version 9.5.0.63

If this property is set to false, then no MIME header folding will be automatically applied to any request header. The default is true.

void get_AuthToken(CkString str);
String authToken();
void put_AuthToken(String newVal);

Introduced in version 9.5.0.67

If set, then automatically adds the "Authorization: Bearer " header to all requests.

boolean get_AutoAddHostHeader();
void put_AutoAddHostHeader(boolean newVal);

If set to true, the "Host" header field will automatically be added to the request header for any QuickGet or QuickGetStr method calls. The value of the Host header field is taken from the hostname part of the URL passed to QuickGet/QuickGetStr.

void get_AwsAccessKey(CkString str);
String awsAccessKey();
void put_AwsAccessKey(String newVal);

The AWS Access Key to be used with the Amazon S3 methods listed below.

void get_AwsEndpoint(CkString str);
String awsEndpoint();
void put_AwsEndpoint(String newVal);

The regional endpoint (domain) to be used for Amazon S3 method calls. The default value is "s3.amazonaws.com". This can be set to any valid Amazon S3 endpoint, such as "s3-eu-west-1.amazonaws.com", or the endpoints for S3-API compatible services from other different providers.

void get_AwsRegion(CkString str);
String awsRegion();
void put_AwsRegion(String newVal);

Introduced in version 9.5.0.56

The AWS (S3) region, such as "us-east-1", "us-west-2", "eu-west-1", "eu-central-1", etc. This propery defaults to "us-east-1". It is only used when the AwsSignatureVersion property is set to 4. When the AwsSignatureVersion property is set to 2, then this property is unused.

void get_AwsSecretKey(CkString str);
String awsSecretKey();
void put_AwsSecretKey(String newVal);

The AWS Secret Key to be used with the Amazon S3 methods listed below.

int get_AwsSignatureVersion();
void put_AwsSignatureVersion(int newVal);

Introduced in version 9.5.0.56

Selects the AWS Signature Version algorithm. The default value is 2. May be set to 4 to select AWS Signature Version 4.

void get_AwsSubResources(CkString str);
String awsSubResources();
void put_AwsSubResources(String newVal);

The AWS sub-resources to be used with the Amazon S3 methods listed below.

If the S3 request needs to address a sub-resource, like ?versioning, ?policy, ?location, ?acl, or ?torrent, or ?versionid append the sub-resource and its value if it has one. Note that in case of multiple sub-resources, sub-resources must be lexicographically sorted by sub-resource name and separated by '&'. e.g. "acl&versionId=value"

The list of sub-resources that can be included are: acl, location, logging, notification, partNumber, policy, requestPayment, torrent, uploadId, uploads, versionId, versioning, versions and website.

int get_BandwidthThrottleDown();
void put_BandwidthThrottleDown(int newVal);

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the download bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

int get_BandwidthThrottleUp();
void put_BandwidthThrottleUp(int newVal);

Introduced in version 9.5.0.49

If non-zero, limits (throttles) the upload bandwidth to approximately this maximum number of bytes per second. The default value of this property is 0.

boolean get_BasicAuth();
void put_BasicAuth(boolean newVal);

If HTTP basic authentication is needed, this property must be set to true. The HTTP protocol allows for several different types of authentication schemes, such as NTLM, Digest, OAuth1, etc. A given server will support (or allow) certain authentication schemes (also known as authentication methods). Except for the "Basic" authentication method, the other forms of authentication do not involve sending the login and password in plain unencrypted text over the connection. The Basic authentication method is insecure in that it sends the login/password for all to see. If the connection is SSL/TLS, then this might be considered OK. Chilkat takes the safe approach and will not allow Basic authentication unless this property has been explicitly set to true. The default value of this property is false.

Note: It is not required to know the authentication methods accepted by the server beforehand (except for the case of Basic authentication). When authentication is required, Chilkat will first send the request without the Authorization header, receive back the 401 Authorization Required response along with information about what authentication methods are accepted, and then re-send with an accepted authentication method. If the authentication method is known in advance, then an application may set the appropriate property, such as NtlmAuth to true so that the extra (internal) round-trip is not required.

void get_BgLastErrorText(CkString str);
String bgLastErrorText();

This property is deprecated. It will be removed in a future version.

When a background-enabled method is run asynchronously in a background thread, the last-error information is saved here and not in the LastErrorText property. If the background method fails, this will contain information about what transpired. (This property also contains information when the background method succeeds.)

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

int get_BgPercentDone();

This property is deprecated. It will be removed in a future version.

The integer percent completed for a background HTTP method call. The value will be between 0 and 100 while a background method call is in progress. Otherwise, the value is meaningless. The BgPercentDone only applies in cases where it is possible to track completion by a percentage. If an HTTP response is chunked, then there is no way of knowing how much response data is forthcoming, and therefore it is not possible to track the percentage completed.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

void get_BgResultData(CkByteData byteData);

This property is deprecated. It will be removed in a future version.

If a backgrounded method returns a byte array, the returned data is found here.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

int get_BgResultInt();

This property is deprecated. It will be removed in a future version.

If a backgrounded method returns an integer, the return value is found here.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

void get_BgResultString(CkString str);
String bgResultString();

This property is deprecated. It will be removed in a future version.

If a backgrounded method returns a string, the return value is found here.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

boolean get_BgTaskFinished();

This property is deprecated. It will be removed in a future version.

Becomes true when the background method completes. Your application would periodically check for this condition.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

boolean get_BgTaskRunning();

This property is deprecated. It will be removed in a future version.

If true then the object instance already has a backgrounded method running. Another backgrounded method cannot be started until the 1st completes. (Multiple simultaneous background methods may run by using multiple object instances.)

If false, then no method is currently running in a background thread.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

boolean get_BgTaskSuccess();

This property is deprecated. It will be removed in a future version.

This property's value is only meaningful (true or false) after a backgrounded method completes.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

void get_ClientIpAddress(CkString str);
String clientIpAddress();
void put_ClientIpAddress(String newVal);

The IP address to use for computers with multiple network interfaces or IP addresses. For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".

Important Bind to Adapter Notes for Windows

int get_ConnectFailReason();

Introduced in version 9.5.0.56

This property will be set to the status of the last HTTP connection made (or failed to be made) by any HTTP method.

Possible values are:

0 = success

Normal (non-TLS) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)
50 = HTTP proxy authentication failure.
98 = Async operation in progress.
99 = Product is not unlocked.

SSL/TLS:
100 = TLS internal error.
101 = Failed to send client hello.
102 = Unexpected handshake message.
103 = Failed to read server hello.
104 = No server certificate.
105 = Unexpected TLS protocol version.
106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
107 = Unacceptable TLS protocol version.
109 = Failed to read handshake messages.
110 = Failed to send client certificate handshake message.
111 = Failed to send client key exchange handshake message.
112 = Client certificate's private key not accessible.
113 = Failed to send client cert verify handshake message.
114 = Failed to send change cipher spec handshake message.
115 = Failed to send finished handshake message.
116 = Server's Finished message is invalid.

void get_Connection(CkString str);
String connection();
void put_Connection(String newVal);

The Connection header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Keep-Alive". To prevent the Connection header from being added to the HTTP header, set this property to the empty string.

int get_ConnectTimeout();
void put_ConnectTimeout(int newVal);

The amount of time in seconds to wait before timing out when connecting to an HTTP server. The default ConnectTimeout is 30 seconds.

Note: This is the maximum number of seconds to wait for a server to accept a TCP connection. Once the connection is accepted, and bytes begin flowing back-and-forth, then it is the ReadTimeout property that applies. It is the ReadTimeout that applies when receiving data, which includes the reads that occur during a TLS handshake.

void get_CookieDir(CkString str);
String cookieDir();
void put_CookieDir(String newVal);

Specifies a directory where cookies are automatically persisted if the Http.SaveCookies property is turned on. Cookies are stored in XML formatted files, one per domain, to main it easy for other programs to understand and parse. May be set to the string "memory" to cache cookies in memory.

(Android™) Saving Cookies to XML Files

(Java) Saving Cookies to XML Files

(Android™) Caching cookies in-memory.

(Java) Caching cookies in-memory.

void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

int get_DefaultFreshPeriod();
void put_DefaultFreshPeriod(int newVal);

The default freshness period (in minutes) for cached documents when the FreshnessAlgorithm property is set to 0. The default value is 10080 (1 week).

boolean get_DigestAuth();
void put_DigestAuth(boolean newVal);

Setting this property to true causes the HTTP component to use digest authentication. The default value is false.

(Android™) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

(Java) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

int get_EventLogCount();

This property is deprecated. It will be removed in a future version.

If the KeepEventLog property is set to true, then this property will contain the number of events that have accumulated in the in-memory event log. The events are indexed from 0 to EventLogCount-1. The ClearEventLog method may be called to clear the event log. The name and value of each event can be retrieved via the EventLogName and EventLogValue methods.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

boolean get_FetchFromCache();
void put_FetchFromCache(boolean newVal);

Set to true if pages should be fetched from cache when possible. Only HTTP GET requests are cached. HTTP responses that include Set-Cookie headers are not cached. A page is fetched from the disk cache if it is present and it is "fresh" according to the FreshnessAlgorithm property. If a page exists in cache but is not fresh, the HTTP component will issue a revalidate request and update the cache appropriately according to the response.

void get_FinalRedirectUrl(CkString str);
String finalRedirectUrl();

If an HTTP GET was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL, assuming the FollowRedirects property is true.

Note: Starting in v9.5.0.49, this property will contain the redirect URL for 301/302 responses even if FollowRedirects is not set to true.

(Android™) Tracing HTTP Redirects

(Java) Tracing HTTP Redirects

boolean get_FollowRedirects();
void put_FollowRedirects(boolean newVal);

If true, then 301, 302, 303, and 307 redirects are automatically followed when calling QuickGet and QuickGetStr. FollowRedirects is true by default.

int get_FreshnessAlgorithm();
void put_FreshnessAlgorithm(int newVal);

The freshness algorithm to use when determining the freshness of a cached HTTP GET response. A value of 1 causes an LM-factor algorithm to be used. This is the default. The LMFactor property is a value between 1 and 100 indicating the percentage of time based on the last-modified date of the HTML page. For example, if the LMFactor is 50, and an HTML page was modified 10 days ago, then the page will expire (i.e. no longer be fresh) in 5 days (50% of 10 days). This only applies to HTTP responses that do not have page expiration information. If the FreshnessAlgorithm = 0, then a constant expire time period determined by the DefaultFreshPeriod property is used.

int get_HeartbeatMs();
void put_HeartbeatMs(int newVal);

This property is only valid in programming environment and languages that allow for event callbacks.

Specifies the time interval in milliseconds between AbortCheck events. A value of 0 (the default) indicate that no AbortCheck events will fire. Any HTTP operation can be aborted via the AbortCheck event.

boolean get_IgnoreMustRevalidate();
void put_IgnoreMustRevalidate(boolean newVal);

Some HTTP responses contain a "Cache-Control: must-revalidate" header. If this is present, the server is requesting that the client always issue a revalidate HTTP request instead of serving the page directly from cache. If IgnoreMustRevalidate is set to true, then Chilkat HTTP will serve the page directly from cache without revalidating until the page is no longer fresh.

The default value of this property is false.

boolean get_IgnoreNoCache();
void put_IgnoreNoCache(boolean newVal);

Some HTTP responses contain headers of various types that indicate that the page should not be cached. Chilkat HTTP will adhere to this unless this property is set to true.

The default value of this property is false.

boolean get_KeepEventLog();
void put_KeepEventLog(boolean newVal);

This property is deprecated. It will be removed in a future version.

If true, an in-memory event log is kept for any method that communicates with an HTTP server (such as Download, PostUrlEncoded, QuickGetStr, SynchronousRequest, etc.). When HTTP methods are called asynchronously, the event log can be checked while the HTTP operation is in in progress. This is done by examining the EventLogCount property and then fetching each event's name and value via the EventLogName and EventLogValue methods. See this example: Asynchronous HTTP.

The ClearBgEventLog method may be called to clear the in-memory event log.

Important: If event logging is enabled, make sure to clear the event log after each HTTP method call. Otherwise the log will continue to grow without bounds.

The default value of this property is false.

The following items may be found in the event log:

NameValue
SocketConnecthostname:port, called when initiating a connection.
SocketConnectedhostname:port, called after successfully connected.
HttpProxyConnecthostname:port
SslHandshake "Starting"/"Finished"
HttpGetBeginURL
HttpCacheHit"Returning page from cache."
HttpInfovarious conditions...
"Begin reading response" -- called when beginning to read the response.
"Finished reading response"
"Existing connection with HTTP server no longer open, restarting GET with new connection."
"Reading chunked response."
"UnGzipping response data"
"Connection:close header is present"
GetRequestthe full HTTP GET request to be sent to the server.
ResponseHeaderthe header of the HTTP response.
HttpStatusCodeHTTP response status code (integer)
ChunkSizeSize (in bytes) of next chunk in response.
ResponseContentLengthNon-chunked response size in bytes.
UnGzippedLengthIf the response was gzip compressed, this is the uncompressed size.
HostnameResolvehostname, Called when starting to resolve a hostname (to an IP address)
ResolvedToIpdotted IP address, called after hostname is resolved.
HttpAuthone of the following strings:
"Starting Negotiate Authentication"
"Starting NTLM Authentication"
"Adding Basic Authentication Header"
"Adding Proxy Authentication Header"
"Starting Proxy NTLM Authentication"
"Starting Digest Authentication"
CookieToSendValue of a Set-Cookie header field to be added to the outgoing request.
SavingCookie XML of cookie being persisted.
HttpRedirectRedirect URL
Socks4Connectdomain:port
Socks5Connectdomain:port
HttpRequestBeginVerb (such as POST, GET, PUT), domain:port/path
RequestHeaderThe full HTTP request header to be sent.
StartSendingRequestSize of entire request, including header, in number of bytes. (Not called for QuickGet) For uploads, this is the size of the entire upload (headers and all files combined)
SubPartHeaderThe header for one of the parts within a multipart request.
UploadFilenameThe file about to be uploaded (streamed from file to socket..)

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

boolean get_KeepResponseBody();
void put_KeepResponseBody(boolean newVal);

Introduced in version 9.5.0.55

If true, then the response body, if text, is saved to the LastResponseBody property for all methods that do not return an HttpResponse object. The default value of this property is false.

void get_LastContentType(CkString str);
String lastContentType();

The content-type of the last HTTP response received by the HTTP component.

void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastHeader(CkString str);
String lastHeader();

The text of the last HTTP header sent by any of this class's methods. The purpose of this property is to allow the developer to examine the exact HTTP header for debugging purposes.

boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

void get_LastModDate(CkString str);
String lastModDate();

The value of the Last-Modified header in the last HTTP response received by the HTTP component.

void get_LastResponseBody(CkString str);
String lastResponseBody();

Introduced in version 9.5.0.55

The response body of the last HTTP response received by the HTTP component (for methods that do not return an HttpResponse object). The last response body is only saved to this property IF the KeepResponseBody property is set to true.

void get_LastResponseHeader(CkString str);
String lastResponseHeader();

The entire response header for the last HTTP response received by the HTTP component (for methods that do not return an HttpResponse object).

int get_LastStatus();

The last HTTP status value received by the HTTP component. This only applies to methods that do not return an HTTP response object. For methods that return an HTTP response object, such as SynchronousRequest, the status code is found in the StatusCode property of the response object.

void get_LastStatusText(CkString str);
String lastStatusText();

Introduced in version 9.5.0.69

The last HTTP status text received by the HTTP component. This only applies to methods that do not return an HTTP response object. For methods that return an HTTP response object, such as SynchronousRequest, the status text is found in the StatusText property of the response object.

int get_LMFactor();
void put_LMFactor(int newVal);

An integer between 1 and 100 that indicates the percentage of time from the HTTP page's last-modified date that will be used for the freshness period. The default value is 25. For example, if a page is fetched with a last-modified date of 4 weeks ago, and the LMFactor = 25, then the page will be considered fresh in the cache for 1 week (25% of 4 weeks).

void get_Login(CkString str);
String login();
void put_Login(String newVal);

The HTTP login for pages requiring a login/password. Chilkat HTTP can do Basic, Digest, and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use Basic authentication, the BasicAuth property must be set equal to true. It is not necessary to set the NtlmAuth or DigestAuth properties beforehand if NTLM or Digest authentication is needed. However, it is most efficient to pre-set these properties when the type of authentication is known in advance.

(Android™) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

(Java) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

void get_LoginDomain(CkString str);
String loginDomain();
void put_LoginDomain(String newVal);

The optional domain name to be used with NTLM / Kerberos / Negotiate authentication.

int get_MaxConnections();
void put_MaxConnections(int newVal);

The maximum number of simultaneous open HTTP connections managed by the HTTP component. The Chilkat HTTP component automatically manages HTTP connections. If the number of open HTTP connections is about to be exceeded, the connection with the least recent activity is automatically closed.

int get_MaxFreshPeriod();
void put_MaxFreshPeriod(int newVal);

Limits the amount of time a document can be kept "fresh" in the cache. The MaxFreshPeriod is specified in minutes, and the default value is 525600 which is equal to 1 year.

int get_MaxResponseSize();
void put_MaxResponseSize(int newVal);

The maximum HTTP response size to be accepted by the calling program. A value of 0 (the default) indicates that there is no maximum value.

int get_MaxUrlLen();
void put_MaxUrlLen(int newVal);

The Http class will automatically fail any URL longer than this length. The default MaxUrlLen is 800 characters.

boolean get_MimicFireFox();
void put_MimicFireFox(boolean newVal);

If set to true, then the appropriate headers to mimic Mozilla/FireFox are automatically added to requests sent via the QuickGet and QuickGetStr methods.

boolean get_MimicIE();
void put_MimicIE(boolean newVal);

If set to true, then the appropriate headers to mimic Internet Explorer are automatically added to requests sent via the QuickGet and QuickGetStr methods.

int get_MinFreshPeriod();
void put_MinFreshPeriod(int newVal);

The freshness period for a document in cache will not be less than this value (in minutes). The default value is 30.

boolean get_NegotiateAuth();
void put_NegotiateAuth(boolean newVal);

Set this property equal to true for Negotiate authentication. Negotiate authentication will dynamically select Kerberos or NTLM authentication depending on what the server requires.

Note: The NegotiateAuth property is only available for the Microsoft Windows operating system.

(Android™) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

(Java) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

boolean get_NtlmAuth();
void put_NtlmAuth(boolean newVal);

Setting this property to true causes the HTTP component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server. The default value is false.

(Android™) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

(Java) HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)

int get_NumCacheLevels();
void put_NumCacheLevels(int newVal);

The number of directory levels to be used under each cache root. The default is 0, meaning that each cached HTML page is stored in a cache root directory. A value of 1 causes each cached page to be stored in one of 255 subdirectories named "0","1", "2", ..."255" under a cache root. A value of 2 causes two levels of subdirectories ("0..255/0..255") under each cache root. The HTTP control automatically creates subdirectories as needed. The reason for mutliple levels is to alleviate problems that may arise with unrelated software when huge numbers of files are stored in a single directory. For example, Windows Explorer does not behave well when trying to display the contents of directories with thousands of files.

int get_NumCacheRoots();

The number of cache roots to be used for the HTTP cache. This allows the disk cache spread out over multiple disk drives. Each cache root is a string indicating the drive letter and directory path. For example, "E:\Cache". An example of a very large low-cost cache might be four USB external drives. To create a cache with four roots, call AddCacheRoot once for each directory root.

boolean get_OAuth1();
void put_OAuth1(boolean newVal);

If true then causes an OAuth Authorization header to be added to any request sent by the HTTP object. For example:

Authorization: OAuth realm="http://sp.example.com/",
                oauth_consumer_key="0685bd9184jfhq22",
                oauth_token="ad180jjd733klru7",
                oauth_signature_method="HMAC-SHA1",
                oauth_signature="wOJIO9A2W5mFwDgiDvZbTSMK%2FPY%3D",
                oauth_timestamp="137131200",
                oauth_nonce="4572616e48616d6d65724c61686176",
                oauth_version="1.0"
The information used to compute the OAuth Authorization header is obtained from the other OAuth* properties, such as OAuthConsumerKey, OAuthConsumerSecret, OAuthRealm, etc.

(Android™) Twitter OAuth -- Tweet to Your Own Account

(Java) Twitter OAuth -- Tweet to Your Own Account

(Android™) Quickbooks OAuth1 Authorization (3-legged)

(Java) Quickbooks OAuth1 Authorization (3-legged)

(Android™) Twitter OAuth1 Authorization (3-legged)

(Java) Twitter OAuth1 Authorization (3-legged)

(Android™) Xero OAuth1 Authorization (3-legged)

(Java) Xero OAuth1 Authorization (3-legged)

void get_OAuthCallback(CkString str);
String oAuthCallback();
void put_OAuthCallback(String newVal);

Introduced in version 9.5.0.53

The OAuth 1.0 callback URL. Defaults to "oob".

void get_OAuthConsumerKey(CkString str);
String oAuthConsumerKey();
void put_OAuthConsumerKey(String newVal);

The OAuth consumer key to be used in the Authorization header.

void get_OAuthConsumerSecret(CkString str);
String oAuthConsumerSecret();
void put_OAuthConsumerSecret(String newVal);

The OAuth consumer secret to be used in computing the contents of the Authorization header.

void get_OAuthRealm(CkString str);
String oAuthRealm();
void put_OAuthRealm(String newVal);

The OAuth realm to be used in the Authorization header.

void get_OAuthSigMethod(CkString str);
String oAuthSigMethod();
void put_OAuthSigMethod(String newVal);

The OAuth signature method, such as "HMAC-SHA1" to be used in the Authorization header. The default is "HMAC-SHA1". It is also possible to choose "HMAC-SHA256", "RSA-SHA1" or "RSA-SHA2". For RSA algorithms, an RSA private key would need to be provided via the SetOAuthRsaKey method.

Note: RSA-SHA2 is supported starting in Chilkat v9.5.0.56

void get_OAuthToken(CkString str);
String oAuthToken();
void put_OAuthToken(String newVal);

The OAuth token to be used in the Authorization header.

(Android™) Twitter OAuth -- Tweet to Your Own Account

(Java) Twitter OAuth -- Tweet to Your Own Account

void get_OAuthTokenSecret(CkString str);
String oAuthTokenSecret();
void put_OAuthTokenSecret(String newVal);

The OAuth token secret to be used in computing the Authorization header.

void get_OAuthVerifier(CkString str);
String oAuthVerifier();
void put_OAuthVerifier(String newVal);

The OAuth verifier to be used in the Authorization header.

void get_Password(CkString str);
String password();
void put_Password(String newVal);

The HTTP password for pages requiring a login/password. Chilkat HTTP can do Basic, Digest, and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use Basic authentication, the BasicAuth property must be set equal to true. It is not necessary to set the NtlmAuth or DigestAuth properties beforehand if NTLM or Digest authentication is needed. However, it is most efficient to pre-set these properties when the type of authentication is known in advance.

int get_PercentDoneScale();
void put_PercentDoneScale(int newVal);

Introduced in version 9.5.0.49

This property is only valid in programming environment and languages that allow for event callbacks.

Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks. The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a method that (1) is event enabled and (2) is such that it is possible to measure progress as a percentage completed. This property may be set to larger numbers to get more fine-grained PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This property is clamped to a minimum value of 10, and a maximum value of 100000.

boolean get_PreferIpv6();
void put_PreferIpv6(boolean newVal);

If true, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is false, which will choose IPv4 over IPv6.

void get_ProxyAuthMethod(CkString str);
String proxyAuthMethod();
void put_ProxyAuthMethod(String newVal);

Set this to "basic" if you know in advance that Basic authentication is to be used for the HTTP proxy. Otherwise leave this property unset. Note: It is not necessary to set this property. The HTTP component will automatically handle proxy authentication for any of the supported authentication methods: NTLM, Digest, or Basic. Setting this property equal to "basic" prevents the 407 response which is automatically handled internal to Chilkat and never seen by your application.

Note: If NTLM authentication does not succeed, set the Global.DefaultNtlmVersion property equal to 1 and then retry.

void get_ProxyDomain(CkString str);
String proxyDomain();
void put_ProxyDomain(String newVal);

The domain name of a proxy host if an HTTP proxy is used.

void get_ProxyLogin(CkString str);
String proxyLogin();
void put_ProxyLogin(String newVal);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.

void get_ProxyLoginDomain(CkString str);
String proxyLoginDomain();
void put_ProxyLoginDomain(String newVal);

The NTLM authentication domain (optional) if NTLM authentication is used.

void get_ProxyPassword(CkString str);
String proxyPassword();
void put_ProxyPassword(String newVal);

If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.

int get_ProxyPort();
void put_ProxyPort(int newVal);

The port number of a proxy server if an HTTP proxy is used.

int get_ReadTimeout();
void put_ReadTimeout(int newVal);

The amount of time in seconds to wait before timing out when reading from an HTTP server. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long download, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire download.

The default value is 20 seconds.

void get_RedirectVerb(CkString str);
String redirectVerb();
void put_RedirectVerb(String newVal);

Indicates the HTTP verb, such as GET, POST, PUT, etc. to be used for a redirect when the FollowRedirects property is set to true. The default value of this property is "GET". This will produce the same behavior as a web browser (such as FireFox). If this property is set to the empty string, then it will cause the same verb as the original HTTP request to be used.

Note: Prior to version 9.5.0.44, the default value of this property was the empty string.

void get_Referer(CkString str);
String referer();
void put_Referer(String newVal);

The Referer header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string which causes the Referer field to be omitted from the request header.

void get_RequiredContentType(CkString str);
String requiredContentType();
void put_RequiredContentType(String newVal);

If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the content-type in the response header does not match this setting. If the content-type does not match, only the header of the HTTP response is read, the connection to the HTTP server is closed, and the remainder of the response is never read.

This property is empty (zero-length string) by default.

Some typical content-types are "text/html", "text/xml", "image/gif", "image/jpeg", "application/zip", "application/msword", "application/pdf", etc.

boolean get_RequireSslCertVerify();
void put_RequireSslCertVerify(boolean newVal);

If true, then the HTTP client will verify the server's SSL certificate. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is false.

(Android™) Require that the Web Server's SSL Certificate is Non-Expired and the Signature is Valid

(Java) Require that the Web Server's SSL Certificate is Non-Expired and the Signature is Valid

boolean get_S3Ssl();
void put_S3Ssl(boolean newVal);

If true, then all S3_* methods will use a secure SSL/TLS connection for communications. (If true, Chilkat uses TLS 1.2) The default value is false.

boolean get_SaveCookies();
void put_SaveCookies(boolean newVal);

If this property is true, cookies are automatically persisted to XML files in the directory specified by the CookiesDir property (or in memory if CookieDir = "memory"). Both CookiesDir and SaveCookies must be set for cookies to be persisted.

(Android™) Caching cookies in-memory.

(Java) Caching cookies in-memory.

int get_SendBufferSize();
void put_SendBufferSize(int newVal);

The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 65535.

boolean get_SendCookies();
void put_SendCookies(boolean newVal);

If true, then cookies previously persisted to the CookiesDir are automatically added to all HTTP requests. Only cookies matching the domain and path are added.

(Android™) Caching cookies in-memory.

(Java) Caching cookies in-memory.

void get_SessionLogFilename(CkString str);
String sessionLogFilename();
void put_SessionLogFilename(String newVal);

Enables file-based session logging. If set to a filename (or relative/absolute filepath), then the exact HTTP requests and responses are logged to a file. The file is created if it does not already exist, otherwise it is appended.

(Android™) Debugging HTTP

(Java) Debugging HTTP

(Android™) HTTP Session Logging

(Java) HTTP Session Logging

void get_SocksHostname(CkString str);
String socksHostname();
void put_SocksHostname(String newVal);

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

(Android™) HTTP/HTTPS using SOCKS5 Proxy

(Java) HTTP/HTTPS using SOCKS5 Proxy

(Android™) HTTP/HTTPS using SOCKS4 Proxy

(Java) HTTP/HTTPS using SOCKS4 Proxy

void get_SocksPassword(CkString str);
String socksPassword();
void put_SocksPassword(String newVal);

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

int get_SocksPort();
void put_SocksPort(int newVal);

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

void get_SocksUsername(CkString str);
String socksUsername();
void put_SocksUsername(String newVal);

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

(Android™) HTTP/HTTPS using SOCKS5 Proxy

(Java) HTTP/HTTPS using SOCKS5 Proxy

(Android™) HTTP/HTTPS using SOCKS4 Proxy

(Java) HTTP/HTTPS using SOCKS4 Proxy

int get_SocksVersion();
void put_SocksVersion(int newVal);

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

(Android™) HTTP/HTTPS using SOCKS5 Proxy

(Java) HTTP/HTTPS using SOCKS5 Proxy

(Android™) HTTP/HTTPS using SOCKS4 Proxy

(Java) HTTP/HTTPS using SOCKS4 Proxy

int get_SoRcvBuf();
void put_SoRcvBuf(int newVal);

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.

This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.

More Information about TCP performance and Buffer Sizes

int get_SoSndBuf();
void put_SoSndBuf(int newVal);

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.

This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.

More Information about TCP performance and Buffer Sizes

void get_SslAllowedCiphers(CkString str);
String sslAllowedCiphers();
void put_SslAllowedCiphers(String newVal);

Introduced in version 9.5.0.48

Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections. The default (empty string) indicates that all implemented ciphers are possible. The TLS ciphers supported in Chilkat v9.5.0.55 and later are:

TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_RC4_128_SHA
TLS_RSA_WITH_RC4_128_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
To restrict SSL/TLS connections to one or more specific ciphers, set this property to a comma-separated list of ciphers such as "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384". The order should be in terms of preference, with the preferred algorithms listed first. (Note that the client cannot specifically choose the algorithm is picked because it is the server that chooses. The client simply provides the server with a list from which to choose.)

The property can also disallow connections with servers having certificates with RSA keys less than a certain size. By default, server certificates having RSA keys of 512 bits or greater are allowed. Add the keyword "rsa1024" to disallow connections with servers having keys smaller than 1024 bits. Add the keyword "rsa2048" to disallow connections with servers having keys smaller than 2048 bits.

Note: Prior to Chilkat v9.5.0.55, it was not possible to explicitly list allowed cipher suites. The deprecated means for indicating allowed ciphers was both incomplete and unprecise. For example, the following keywords could be listed to allow matching ciphers: "aes256-cbc", "aes128-cbc", "3des-cbc", and "rc4". These keywords will still be recognized, but programs should be updated to explicitly list the allowed ciphers.

secure-renegotiation: Starting in Chilkat v9.5.0.55, the keyword "secure-renegotiation" may be added to require that all renegotions be done securely (as per RFC 5746).

best-practices: Starting in Chilkat v9.5.0.55, this property may be set to the single keyword "best-practices". This will allow ciphers based on the current best practices. As new versions of Chilkat are released, the best practices may change. Changes will be noted here. The current best practices are:

  • If the server uses an RSA key, it must be 1024 bits or greater.
  • All renegotations must be secure renegotiations.
  • All ciphers using RC4, DES, or 3DES are disallowed.

Example: The following string would restrict to 2 specific cipher suites, require RSA keys to be 1024 bits or greater, and require secure renegotiations: "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024, secure-renegotiation"

void get_SslProtocol(CkString str);
String sslProtocol();
void put_SslProtocol(String newVal);

Introduced in version 9.5.0.46

Selects the secure protocol to be used for secure (SSL/TLS) connections. Possible values are:

default
TLS 1.2
TLS 1.1
TLS 1.0
SSL 3.0
TLS 1.2 or higher
TLS 1.1 or higher
TLS 1.0 or higher
The default value is "default" which will choose the, which allows for the protocol to be selected dynamically at runtime based on the requirements of the server. Choosing an exact protocol will cause the connection to fail unless that exact protocol is negotiated. It is better to choose "X or higher" than an exact protocol. The "default" is effectively "SSL 3.0 or higher".

void get_StreamResponseBodyPath(CkString str);
String streamResponseBodyPath();
void put_StreamResponseBodyPath(String newVal);

Introduced in version 9.5.0.49

Allows for the HTTP response body to be streamed directly into a file. If this property is set, then any method returning an HTTP response object will stream the response body directly to the file path specified. The HTTP response object will still contain the response header. (This property is useful when the HTTP response is too large to fit into memory.)

void get_TlsCipherSuite(CkString str);
String tlsCipherSuite();

Introduced in version 9.5.0.49

Contains the current or last negotiated TLS cipher suite. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. A sample cipher suite string looks like this: TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.

void get_TlsPinSet(CkString str);
String tlsPinSet();
void put_TlsPinSet(String newVal);

Introduced in version 9.5.0.55

Specifies a set of pins for Public Key Pinning for TLS connections. This property lists the expected SPKI fingerprints for the server certificates. If the server's certificate (sent during the TLS handshake) does not match any of the SPKI fingerprints, then the TLS handshake is aborted and the connection fails. The format of this string property is as follows:

hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...
For example, the following string specifies a single sha256 base64-encoded SPKI fingerprint:
"sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="
This example specifies two SPKI fingerprints:
"sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="
Any of the following hash algorithms are allowed:.sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160,ripemd256, or ripemd320.

The following encodings are allowed: base64, hex, and any of the encodings indicated in the link below.

Encodings Supported by Chilkat

(Android™) HTTP Public Key Pinning

(Java) HTTP Public Key Pinning

void get_TlsVersion(CkString str);
String tlsVersion();

Introduced in version 9.5.0.49

Contains the current or last negotiated TLS protocol version. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. Possible values are "SSL 3.0", "TLS 1.0", "TLS 1.1", and "TLS 1.2".

boolean get_UpdateCache();
void put_UpdateCache(boolean newVal);

Controls whether the cache is automatically updated with the responses from HTTP GET requests.

boolean get_UseBgThread();
void put_UseBgThread(boolean newVal);

This property is deprecated. It will be removed in a future version.

If true, then background-enabled methods will run in a background thread. Normally, a method will return after its work is completed. However, when UseBgThread is true, the method will return immediately and a background thread is started to carry out the method's task.

Background-enabled HTTP methods are:

  • Download
  • DownloadAppend
  • GetHead
  • PostBinary
  • PostMime
  • PostUrlEncoded
  • PostXml
  • PutText
  • QuickDeleteStr
  • QuickGet
  • QuickGetObj
  • QuickGetStr
  • QuickPutStr
  • ResumeDownload
  • SynchronousRequest
  • XmlRpc
  • XmlRpcPut
  • This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

boolean get_UseIEProxy();
void put_UseIEProxy(boolean newVal);

If true, the proxy host/port used by Internet Explorer will also be used by Chilkat HTTP.

void get_UserAgent(CkString str);
String userAgent();
void put_UserAgent(String newVal);

The UserAgent header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:49.0) Gecko/20100101 Firefox/49.0". The reason for this default is to get the same server behavior for a recent version of a typical and popular browser. Some sites may respond differently depending on the User-Agent, and the goal is to avoid strange responses that are different than what a typical browser would receive.

boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

void get_Version(CkString str);
String version();

Version of the component/library, such as "9.5.0.63"

boolean get_WasRedirected();

Indicates whether the last HTTP GET was redirected.

Methods

void AddCacheRoot(String dir);

This method must be called at least once if disk caching is to be used. The file path (including drive letter) such as "E:\MyHttpCache\" is passed to AddCacheRoot to specify the root directory. The cache can be spread across multiple disk drives by calling AddCacheRoot multiple times, each with a directory path on a separate disk drive.

boolean AddQuickHeader(String headerFieldName, String headerFieldValue);

This method is deprecated. It will be removed in a future version.

Adds a custom header field to any HTTP request sent by a method that does not use the HTTP request object. These methods include Download, DownloadAppend, GetHead, PostBinary, PostMime, PostXml, PutBinary, PutText, QuickDeleteStr, QuickGet, QuickGetObj, QuickGetStr, QuickPutStr, XmlRpc, and XmlRpcPut.

Cookies may be explictly added by calling this method passing "Cookie" for the headerFieldName.

The RemoveQuickHeader method can be called to remove a custom header.

* Note: This method is deprecated. It is identical to the SetRequestHeader method. The SetRequestHeader method should be called instead because AddQuickHeader will be removed in a future version.

Returns true for success, false for failure.

(Android™) Adding Cookies to an HTTP Request

(Java) Adding Cookies to an HTTP Request

CkHttpResponse BgResponseObject();

This method is deprecated. It will be removed in a future version.

If a backgrounded method returns an Http response object, it may be retrieved by calling this method.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

Returns nil on failure

void BgTaskAbort();

This method is deprecated. It will be removed in a future version.

Call this to force the currently running backgrounded method to abort.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

void ClearBgEventLog();

This method is deprecated. It will be removed in a future version.

Clears the in-memory event log (which is enabled by setting the KeepEventLog property = true).

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

void ClearInMemoryCookies();

Clears all cookies cached in memory. Calling this only makes sense if the CookieDir property is set to the string "memory".

void ClearUrlVars();

Introduced in version 9.5.0.67

Clears all URL variable values previously set by one or more calls to SetUrlVar.

boolean CloseAllConnections();

Closes all connections still open from previous HTTP requests.

An HTTP object instance will maintain up to 10 connections. If the HTTP server's response does not include a "Connection: Close" header, the connection will remain open and will be re-used if possible for the next HTTP request to the same hostname:port. (It uses the IP address (in string form) or the domain name, whichever is used in the URL provided by the application.) If 10 connections are already open and another is needed, the object will close the least recently used connection.

Returns true for success, false for failure.

CkTask CloseAllConnectionsAsync();

Creates an asynchronous task to call the CloseAllConnections method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

void DnsCacheClear();

Introduced in version 9.5.0.38

Clears the Chilkat-wide in-memory hostname-to-IP address DNS cache. Chilkat automatically maintains this in-memory cache to prevent redundant DNS lookups. If the TTL on the DNS A records being accessed are short and/or these DNS records change frequently, then this method can be called clear the internal cache. Note: The DNS cache is used/shared among all Chilkat objects in a program, and clearing the cache affects all Chilkat objects.

boolean Download(String url, String localFilePath);

Retrieves the content at a URL and saves to a file. All content is saved in streaming mode such that the memory footprint is small and steady. HTTPS is fully supported, as it is with all the methods of this class.

Returns true for success, false for failure.

(Android™) HTTP Download any Type of File (binary or text)

(Java) HTTP Download any Type of File (binary or text)

(Android™) Debugging HTTP

(Java) Debugging HTTP

CkTask DownloadAsync(String url, String localFilePath);

Creates an asynchronous task to call the Download method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean DownloadAppend(String url, String filename);

Same as the Download method, but the output file is open for append.

Returns true for success, false for failure.

CkTask DownloadAppendAsync(String url, String filename);

Creates an asynchronous task to call the DownloadAppend method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean DownloadBd(String url, CkBinData binData);

Introduced in version 9.5.0.63

Downloads the content at the url into a BinData object.

Returns true for success, false for failure.

(Android™) Upload In-Memory Binary Data to Google Cloud Storage

(Java) Upload In-Memory Binary Data to Google Cloud Storage

CkTask DownloadBdAsync(String url, CkBinData binData);

Introduced in version 9.5.0.63

Creates an asynchronous task to call the DownloadBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean DownloadHash(String url, String hashAlgorithm, String encoding, CkString outStr);
String downloadHash(String url, String hashAlgorithm, String encoding);

Retrieves the content at a URL and computes and returns a hash of the content. The hash is returned as an encoded string according to the encoding, which may be "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986". The hashAlgorithm may be "sha1", "sha256", "sha384", "sha512", "md2", "md5", "haval", "ripemd128", "ripemd160","ripemd256", or "ripemd320".

Returns true for success, false for failure.

CkTask DownloadHashAsync(String url, String hashAlgorithm, String encoding);

Creates an asynchronous task to call the DownloadHash method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean DownloadSb(String url, String charset, CkStringBuilder sb);

Introduced in version 9.5.0.63

Downloads the content at the url into a Chilkat StringBuilder object. The charset tells Chilkat how to interpret the bytes received. The sb is appended with the downloaded text data.

Returns true for success, false for failure.

CkTask DownloadSbAsync(String url, String charset, CkStringBuilder sb);

Introduced in version 9.5.0.63

Creates an asynchronous task to call the DownloadSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean EventLogName(int index, CkString outStr);
String eventLogName(int index);

This method is deprecated. It will be removed in a future version.

Returns the name of the Nth event in the in-memory event log. Refer to the documentation for the KeepEventLog property for the full list of event names. Indexing is from 0 to EventLogCount-1.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

Returns true for success, false for failure.

boolean EventLogValue(int index, CkString outStr);
String eventLogValue(int index);

This method is deprecated. It will be removed in a future version.

Returns the value of the Nth event in the in-memory event log. Indexing is from 0 to EventLogCount-1.

This functionality is replaced by the new model for asynchronous programming introduced in Chilkat v9.5.0.52. Applications should use the new model, which is identified by methods having names ending with "Async" and return a task object.

Returns true for success, false for failure.

boolean ExtractMetaRefreshUrl(String htmlContent, CkString outStr);
String extractMetaRefreshUrl(String htmlContent);

Convenience method for extracting the META refresh URL from HTML. For example, if the htmlContent contains a META refresh tag, such as:

<meta http-equiv="refresh" content="5;URL='http://example.com/'">
Then the return value of this method would be "http://example.com/".

Returns true for success, false for failure.

boolean G_SvcOauthAccessToken(String iss, String scope, String subEmail, int numSec, CkCert cert, CkString outStr);
String g_SvcOauthAccessToken(String iss, String scope, String subEmail, int numSec, CkCert cert);

Introduced in version 9.5.0.44

Makes an access token request to obtain a Google API OAuth2 access token for a service account. Access tokens issued by the Google OAuth 2.0 Authorization Server expire one hour after they are issued. When an access token expires, then the application should generate another JWT, sign it, and request another access token. The iss is the service account email address of the application making the access token request. The scope is a space-delimited list of the permissions that the application requests. (See https://developers.google.com/accounts/docs/OAuth2ServiceAccount )

The subEmail is the email address of the user for which the application is requesting delegated access. The subEmail may be left empty if there is no such email address.

Returns true for success, false for failure.

(Android™) Get XOAUTH2 Access Token from Google OAuth 2.0 Authorization Server

(Java) Get XOAUTH2 Access Token from Google OAuth 2.0 Authorization Server

CkTask G_SvcOauthAccessTokenAsync(String iss, String scope, String subEmail, int numSec, CkCert cert);

Introduced in version 9.5.0.44

Creates an asynchronous task to call the G_SvcOauthAccessToken method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean G_SvcOauthAccessToken2(CkHashtable claimParams, int numSec, CkCert cert, CkString outStr);
String g_SvcOauthAccessToken2(CkHashtable claimParams, int numSec, CkCert cert);

Introduced in version 9.5.0.51

The same as the G_SvcOauthAccessToken method, but with added flexibility for more customization. The 1st three args of the G_SvcOauthAccessToken are replaced with claimParams allowing for future expansion of name-value params. See the example below.

Returns true for success, false for failure.

(Android™) Get OAuth 2.0 Access Token using G_SvcOauthAccessToken2

(Java) Get OAuth 2.0 Access Token using G_SvcOauthAccessToken2

CkTask G_SvcOauthAccessToken2Async(CkHashtable claimParams, int numSec, CkCert cert);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the G_SvcOauthAccessToken2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean GenTimeStamp(CkString outStr);
String genTimeStamp();

Returns the current GMT (also known as UTC) date/time in a string that is compliant with RFC 2616 format.

Returns true for success, false for failure.

boolean GetCacheRoot(int index, CkString outStr);
String getCacheRoot(int index);

Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times.

Returns true for success, false for failure.

boolean GetCookieXml(String domain, CkString outStr);
String getCookieXml(String domain);

Returns the cookies in XML format for a specific domain. Cookies are only persisted if the SaveCookies property is set to true. If the CookieDir property is set to the keyword "memory", then cookies are saved in-memory.

Returns true for success, false for failure.

(Android™) Demonstrates how to Get Cookies Sent by the HTTP Server

(Java) Demonstrates how to Get Cookies Sent by the HTTP Server

boolean GetDomain(String url, CkString outStr);
String getDomain(String url);

Utility method for extracting the domain name from a full URL. For example, if "http://www.chilkatsoft.com/default.asp" is the URL passed in, then "www.chilkatsoft.com" is returned.

Returns true for success, false for failure.

CkHttpResponse GetHead(String url);

Sends an HTTP HEAD request for a URL and returns a response object. (Note: HEAD requests will never automatically follow redirects.)

Returns nil on failure

(Android™) HTTP HEAD Request

(Java) HTTP HEAD Request

CkTask GetHeadAsync(String url);

Creates an asynchronous task to call the GetHead method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

boolean GetRequestHeader(String name, CkString outStr);
String getRequestHeader(String name);

Returns the value of a header field that has been pre-defined to be sent with all HTTP GET requests issued by the QuickGet and QuickGetStr methods. By default, this includes header fields such as Accept, AcceptCharset, AcceptLanguage, Connection, UserAgent, etc.

Returns true for success, false for failure.

CkCert GetServerSslCert(String domain, int port);

Establishes an SSL/TLS connection with a web server for the purpose of retrieving the server's SSL certificate (public-key only of course...). Nothing is retrieved from the web server. This method simply makes a connection, gets the certificate information, and closes the connection.

Returns nil on failure

(Android™) Get the Server Certificate, Certificate Chain, and Root CA Certificate

(Java) Get the Server Certificate, Certificate Chain, and Root CA Certificate

(Android™) Get Web Server's SPKI Fingerprint

(Java) Get Web Server's SPKI Fingerprint

CkTask GetServerSslCertAsync(String domain, int port);

Creates an asynchronous task to call the GetServerSslCert method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

boolean GetUrlPath(String url, CkString outStr);
String getUrlPath(String url);

Returns the path part of a URL. The syntax of a URL is <scheme>://<user>:<password>@<host>:<port>/<path>;<params>?<query>#<frag>. This method returns the "path" part.

Returns true for success, false for failure.

boolean HasRequestHeader(String name);

Returns true if the specified header field is defined such that it will be sent with all GET requests issued by the QuickGet and QuickGetStr methods.

boolean IsUnlocked();

Returns true if the Http class has been unlocked. It is necessary to call Http.UnlockComponent before calling any other methods. Passing any string to UnlockComponent will automatically activate a 30-day trial period.

CkHttpResponse PBinary(String verb, String url, CkByteData byteData, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.45

Sends an HTTP request to the url. The verb can be "POST", "PUT", "PATCH", etc. The body of the HTTP request contains the bytes passed in byteData. The contentType is a content type such as "image/gif", "application/pdf", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the byteData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the byteData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns nil on failure

CkTask PBinaryAsync(String verb, String url, CkByteData byteData, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.45

Creates an asynchronous task to call the PBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PBinaryBd(String verb, String url, CkBinData data, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.69

The same as PBinary, but the data to be uploaded is passed in data.

Returns nil on failure

(Android™) Upload In-Memory Binary Data to Google Cloud Storage

(Java) Upload In-Memory Binary Data to Google Cloud Storage

CkTask PBinaryBdAsync(String verb, String url, CkBinData data, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.69

Creates an asynchronous task to call the PBinaryBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

boolean PostBinary(String url, CkByteData byteData, String contentType, boolean md5, boolean gzip, CkString outStr);
String postBinary(String url, CkByteData byteData, String contentType, boolean md5, boolean gzip);

Sends an HTTP POST request to the url. The body of the HTTP request contains the bytes passed in byteData. The contentType is a content type such as "image/gif", "application/pdf", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the byteData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the byteData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns the text body of the HTTP response if the HTTP response has a success status code. Otherwise the method is considered to have failed. If more details of the HTTP response are required, call PBinary instead (which returns the HTTP response object).

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

Returns true for success, false for failure.

CkTask PostBinaryAsync(String url, CkByteData byteData, String contentType, boolean md5, boolean gzip);

Creates an asynchronous task to call the PostBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

CkHttpResponse PostJson(String url, String jsonText);

A simplified way of sending a JSON POST and receiving the JSON response. The HTTP response is returned in an HTTP response object. The content type of the HTTP request is "applicatoin/jsonrequest". To send a JSON POST using "application/json", call the PostJson2 method where the content type can be explicitly provided.

Returns nil on failure

(Android™) HTTP POST JSON

(Java) HTTP POST JSON

CkTask PostJsonAsync(String url, String jsonText);

Creates an asynchronous task to call the PostJson method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PostJson2(String url, String contentType, String jsonText);

The same as PostJson,except it allows for the content type to be explicitly provided. The PostJson method automatically uses "application/jsonrequest". If the application needs for the content type to be "application/json", or some other content type, then PostJson2 provides the means.

Returns nil on failure

(Android™) HTTP POST JSON (application/json)

(Java) HTTP POST JSON (application/json)

CkTask PostJson2Async(String url, String contentType, String jsonText);

Creates an asynchronous task to call the PostJson2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PostJson3(String url, String contentType, CkJsonObject json);

Introduced in version 9.5.0.68

The same as PostJson2,except a JSON object is passed in for the request body.

Returns nil on failure

(Android™) Auth0 Server-to-Server Access Token (Client Credentials flow)

(Java) Auth0 Server-to-Server Access Token (Client Credentials flow)

CkTask PostJson3Async(String url, String contentType, CkJsonObject json);

Introduced in version 9.5.0.68

Creates an asynchronous task to call the PostJson3 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PostUrlEncoded(String url, CkHttpRequest req);

Sends a simple URL encoded POST. The form parameters are sent in the body of the HTTP request in x-www-form-urlencoded format. The content-type is "application/x-www-form-urlencoded".

Returns nil on failure

(Android™) Duplicating a Simple HTML Form Submission (POST)

(Java) Duplicating a Simple HTML Form Submission (POST)

(Android™) HTTP POST x-www-form-urlencoded

(Java) HTTP POST x-www-form-urlencoded

(Android™) Debugging HTTP

(Java) Debugging HTTP

(Android™) PostUrlEncoded Clarified

(Java) PostUrlEncoded Clarified

CkTask PostUrlEncodedAsync(String url, CkHttpRequest req);

Creates an asynchronous task to call the PostUrlEncoded method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PostXml(String endpointUrl, String xmlContent, String xmlCharset);

A simplified way of posting XML content to a web server. This method is good for making SOAP calls using HTTP POST. The xmlCharset should match the character encoding used in the xmlContent, which is typically "utf-8". The HTTP response is returned in an HTTP response object.

Important: This method sends the POST with a "Content-Type" header value of "text/xml". Sometimes a server might require the Content-Type header to be "application/xml". To use "application/xml" instead of the default "text/xml", call SetRequestHeader("Content-Type","application/xml") prior to calling this method.

To use HTTPS simply pass an endpointUrl beginning with "https://" instead of "http://". This applies to any Chilkat method where a URL is passed as an argument.

Returns nil on failure

(Android™) Send XMLHttpRequest and Get Response

(Java) Send XMLHttpRequest and Get Response

(Android™) Calling a SOAP Web Service using PostXml

(Java) Calling a SOAP Web Service using PostXml

(Android™) Debugging HTTP

(Java) Debugging HTTP

(Android™) Send SOAP 1.2 Request to Web Service Requiring Authentication

(Java) Send SOAP 1.2 Request to Web Service Requiring Authentication

CkTask PostXmlAsync(String endpointUrl, String xmlContent, String xmlCharset);

Creates an asynchronous task to call the PostXml method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PText(String verb, String url, String textData, String charset, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.46

Sends an HTTP request to the url. The verb can be "POST", "PUT", "PATCH", etc. The body of the HTTP request contains the text passed in textData. The contentType is a content type such as "text/xml", "application/json", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the contentType is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns nil on failure

CkTask PTextAsync(String verb, String url, String textData, String charset, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.46

Creates an asynchronous task to call the PText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

CkHttpResponse PTextSb(String verb, String url, CkStringBuilder textData, String charset, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.69

The same as PText, but the data to be uploaded is passed in textData.

Returns nil on failure

(Android™) Upload String to Google Cloud Storage

(Java) Upload String to Google Cloud Storage

CkTask PTextSbAsync(String verb, String url, CkStringBuilder textData, String charset, String contentType, boolean md5, boolean gzip);

Introduced in version 9.5.0.69

Creates an asynchronous task to call the PTextSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

boolean PutBinary(String url, CkByteData byteData, String contentType, boolean md5, boolean gzip, CkString outStr);
String putBinary(String url, CkByteData byteData, String contentType, boolean md5, boolean gzip);

Sends an HTTP PUT request to the url. The body of the HTTP request is byteData. The contentType is a content type such as "image/gif", "application/pdf", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the byteData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the byteData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns the text body of the HTTP response if the HTTP response has a success status code. Otherwise the method is considered to have failed. If more details of the HTTP response are required, call PBinary instead (which returns the HTTP response object).

Returns true for success, false for failure.

CkTask PutBinaryAsync(String url, CkByteData byteData, String contentType, boolean md5, boolean gzip);

Creates an asynchronous task to call the PutBinary method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean PutText(String url, String textData, String charset, String contentType, boolean md5, boolean gzip, CkString outStr);
String putText(String url, String textData, String charset, String contentType, boolean md5, boolean gzip);

Sends an HTTP PUT request to the url. The body of the HTTP request is textData. The charset should be set to a charset name such as "iso-8859-1", "windows-1252", "Shift_JIS", "utf-8", etc. The string "ansi" may also be used as a charset name. The contentType is a content type such as "text/plain", "text/xml", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the textData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server).

Returns the text body of the HTTP response if the HTTP response has a success status code. Otherwise the method is considered to have failed. If more details of the HTTP response are required, call PText instead (which returns the HTTP response object).

Returns true for success, false for failure.

(Android™) HTTP PUT JSON

(Java) HTTP PUT JSON

CkTask PutTextAsync(String url, String textData, String charset, String contentType, boolean md5, boolean gzip);

Creates an asynchronous task to call the PutText method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean QuickDeleteStr(String url, CkString outStr);
String quickDeleteStr(String url);

Same as QuickGetStr, but uses the HTTP DELETE method instead of the GET method.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

Returns true for success, false for failure.

(Android™) Debugging HTTP

(Java) Debugging HTTP

CkTask QuickDeleteStrAsync(String url);

Creates an asynchronous task to call the QuickDeleteStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean QuickGet(String url, CkByteData outData);

Sends an HTTP GET request for a URL and returns the response body as a byte array. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page may be fetched directly from cache. Because the URL can specify any type of resource (HTML page, GIF image, etc.) the return value is a byte array. If the resource is known to be a string, such as with an HTML page, you may call QuickGetStr instead. If the HTTP request fails, a zero-length byte array is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

Returns true for success, false for failure.

(Android™) Facebook Download all Photos to Local Files

(Java) Facebook Download all Photos to Local Files

(Android™) Download a Zip from a URL and OpenFromMemory. (No .zip fie is created)

(Java) Download a Zip from a URL and OpenFromMemory. (No .zip fie is created)

CkTask QuickGetAsync(String url);

Creates an asynchronous task to call the QuickGet method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean QuickGetBd(String url, CkBinData binData);

Introduced in version 9.5.0.64

The same as QuickGet, but returns the content in a Chilkat BinData object. The existing content of binData, if any, is cleared and replaced with the downloaded content.

Returns true for success, false for failure.

(Android™) Create Enveloping XML Digital Signature

(Java) Create Enveloping XML Digital Signature

CkTask QuickGetBdAsync(String url, CkBinData binData);

Introduced in version 9.5.0.64

Creates an asynchronous task to call the QuickGetBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

CkHttpResponse QuickGetObj(String url);

Sends an HTTP GET request for a URL and returns the response object. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page could be fetched directly from cache.

Returns nil on failure

(Android™) Getting the HTTP Response after an Asynchronous HTTP Request Completes

(Java) Getting the HTTP Response after an Asynchronous HTTP Request Completes

CkTask QuickGetObjAsync(String url);

Creates an asynchronous task to call the QuickGetObj method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

boolean QuickGetSb(String url, CkStringBuilder sbContent);

Introduced in version 9.5.0.64

The same as QuickGetStr, but returns the content in a Chilkat StringBuilder object. The existing content of sbContent, if any, is cleared and replaced with the downloaded content.

Returns true for success, false for failure.

CkTask QuickGetSbAsync(String url, CkStringBuilder sbContent);

Introduced in version 9.5.0.64

Creates an asynchronous task to call the QuickGetSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean QuickGetStr(String url, CkString outStr);
String quickGetStr(String url);

Sends an HTTP GET request for a URL and returns the response body as a string. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page could be fetched directly from cache. If the HTTP request fails, a nil value is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

Returns true for success, false for failure.

(Android™) HTTP GET - Download HTML or any Text Content to a String

(Java) HTTP GET - Download HTML or any Text Content to a String

(Android™) HTTPS GET using SSL/TLS

(Java) HTTPS GET using SSL/TLS

CkTask QuickGetStrAsync(String url);

Creates an asynchronous task to call the QuickGetStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean QuickPutStr(String url, CkString outStr);
String quickPutStr(String url);

Same as QuickGetStr, but uses the HTTP PUT method instead of the GET method.

Note: The HTTP response code is available in the LastStatus property. Other properties having information include LastResponseHeader, LastResponseBody, LastModDate, LastContentType, etc.

Returns true for success, false for failure.

(Android™) Debugging HTTP

(Java) Debugging HTTP

CkTask QuickPutStrAsync(String url);

Creates an asynchronous task to call the QuickPutStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean RemoveQuickHeader(String headerFieldName);

Removes a header from the internal list of custom header field name/value pairs to be automatically added when HTTP requests are sent via methods that do not use the HTTP request object. (The AddQuickHeader method is called to add custom header fields.)

* Note: This method is deprecated. It is identical to the RemoveRequestHeader method. The RemoveRequestHeader method should be called instead because this method will be removed in a future version.

Returns true for success, false for failure.

void RemoveRequestHeader(String name);

Removes a header from the internal list of custom header field name/value pairs to be automatically added when HTTP requests are sent via methods that do not use the HTTP request object. (The SetRequestHeader method is called to add custom header fields.)

boolean RenderGet(String url, CkString outStr);
String renderGet(String url);

Same as QuickGet, but does not send the HTTP GET. Instead, it builds the HTTP request that would've been sent and returns it.

Returns true for success, false for failure.

boolean ResumeDownload(String url, String targetFilename);

Same as the Download method, except a failed download may be resumed. The targetFilename is automatically checked and if it exists, the download will resume at the point where it previously failed. ResumeDownload may be called any number of times until the full download is complete.

Returns true for success, false for failure.

CkTask ResumeDownloadAsync(String url, String targetFilename);

Creates an asynchronous task to call the ResumeDownload method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_CreateBucket(String bucketPath);

Creates a new Amazon S3 bucket.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Returns true for success, false for failure.

(Android™) S3 Create Bucket Example

(Java) S3 Create Bucket Example

CkTask S3_CreateBucketAsync(String bucketPath);

Creates an asynchronous task to call the S3_CreateBucket method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_DeleteBucket(String bucketPath);

Deletes an Amazon S3 bucket.

Returns true for success, false for failure.

(Android™) S3 Delete Bucket

(Java) S3 Delete Bucket

CkTask S3_DeleteBucketAsync(String bucketPath);

Creates an asynchronous task to call the S3_DeleteBucket method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

CkHttpResponse S3_DeleteMultipleObjects(String bucketName, CkStringArray objectNames);

Introduced in version 9.5.0.47

Deletes multiple objects from a bucket using a single HTTP request. The bucketName contains the names (also known as "keys") of the objects to be deleted. To delete a specific version of an object, append a versionId attribute to the object name. For example: "SampleDocument.txt; VersionId="OYcLXagmS.WaD..oyH4KRguB95_YhLs7""

Returns nil on failure

(Android™) Delete Multiple Objects Example

(Java) Delete Multiple Objects Example

CkTask S3_DeleteMultipleObjectsAsync(String bucketName, CkStringArray objectNames);

Introduced in version 9.5.0.47

Creates an asynchronous task to call the S3_DeleteMultipleObjects method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

(Android™) How to Return an Object from an Async Task

(Java) How to Return an Object from an Async Task

boolean S3_DeleteObject(String bucketPath, String objectName);

Deletes a remote file (object) on the Amazon S3 service.

Returns true for success, false for failure.

(Android™) S3 Delete File

(Java) S3 Delete File

CkTask S3_DeleteObjectAsync(String bucketPath, String objectName);

Creates an asynchronous task to call the S3_DeleteObject method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_DownloadBytes(String bucketPath, String objectName, CkByteData outData);

The same as DownloadFile, except the file data is returned directly in-memory instead of being written to a local file.

Returns true for success, false for failure.

(Android™) Demonstrate S3_DownloadBytes

(Java) Demonstrate S3_DownloadBytes

CkTask S3_DownloadBytesAsync(String bucketPath, String objectName);

Creates an asynchronous task to call the S3_DownloadBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_DownloadFile(String bucketPath, String objectName, String localFilePath);

Downloads a file from the Amazon S3 service.

Returns true for success, false for failure.

(Android™) S3 Download File Example

(Java) S3 Download File Example

CkTask S3_DownloadFileAsync(String bucketPath, String objectName, String localFilePath);

Creates an asynchronous task to call the S3_DownloadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_DownloadString(String bucketPath, String objectName, String charset, CkString outStr);
String s3_DownloadString(String bucketPath, String objectName, String charset);

Downloads a text file (object) from the Amazon S3 service directly into a string variable. The charset specifies the character encoding, such as "utf-8", of the remote text object.

Returns true for success, false for failure.

(Android™) S3 Download String Object

(Java) S3 Download String Object

CkTask S3_DownloadStringAsync(String bucketPath, String objectName, String charset);

Creates an asynchronous task to call the S3_DownloadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

int S3_FileExists(String bucketPath, String objectName);

Determines if a remote object (file) exists. Returns 1 if the file exists, 0 if it does not exist, -1 if there was a failure in checking, or 2 if using in asynchronous mode to indicate that the background task was successfully started.

(Android™) Read S3 Object Metadata of File Already Uploaded to S3

(Java) Read S3 Object Metadata of File Already Uploaded to S3

CkTask S3_FileExistsAsync(String bucketPath, String objectName);

Creates an asynchronous task to call the S3_FileExists method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_GenerateUrl(String bucket, String path, CkDateTime expire, CkString outStr);
String s3_GenerateUrl(String bucket, String path, CkDateTime expire);

Introduced in version 9.5.0.46

Generates a temporary pre-signed URL for Amazon S3 using AWS Signature V2. (Call S3_GenerateUrlV4 to generate AWS Signature V4 pre-signed URLs.) Requires that the AwsSecretKey and AwsAccessKey be set to valid values prior to calling this method.

Note: This method can only generate URLs that are for HTTP GET requests (i.e. URLs you can paste into a browser address bar). This method does not generate URLs for POST, PUT, DELETE, etc.

Returns true for success, false for failure.

(Android™) Generate S3 Signed URL

(Java) Generate S3 Signed URL

boolean S3_GenerateUrlV4(boolean useHttps, String bucketName, String path, int numSecondsValid, String awsService, CkString outStr);
String s3_GenerateUrlV4(boolean useHttps, String bucketName, String path, int numSecondsValid, String awsService);

Introduced in version 9.5.0.66

Generates a temporary pre-signed URL for Amazon S3 using AWS Signature V4. (Call S3_GenerateUrl to generate AWS Signature V2 pre-signed URLs.) Requires that the AwsSecretKey, AwsAccessKey, and AwsRegion properties be set to valid values prior to calling this method. Also requires the AwsEndpoint property to be set if the endpoint is different than "s3.amazonaws.com".

The URL that is generated has this format:

https:////
?X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=////aws4_request
&X-Amz-Date=
&X-Amz-Expires=
&X-Amz-SignedHeaders=host
&X-Amz-Signature=  

The awsService is a string naming the AWS service, such as "s3". If useHttps is true, then the URL begins with "https://", otherwise it begins with "http://".

Note: This method can only generate URLs that are for HTTP GET requests (i.e. URLs you can paste into a browser address bar). This method does not generate URLs for POST, PUT, DELETE, etc.

Returns true for success, false for failure.

(Android™) Generate an AWS (S3) Pre-Signed URL using Signature V4

(Java) Generate an AWS (S3) Pre-Signed URL using Signature V4

boolean S3_ListBucketObjects(String bucketPath, CkString outStr);
String s3_ListBucketObjects(String bucketPath);

Retrieves the XML listing of the objects contained within an Amazon S3 bucket. (This is like a directory listing, but in XML format.)

The bucketPath name may be qualified with URL-encoded params. For example, to list the objects in a bucket named "ChilkatABC" with max-keys = 2000 and marker = "xyz", call S3_ListBucketObject passing the following string for bucketPath: "ChilkatABC?max-keys=2000&marker=xyz"

The S3_ListBucketObjects method recognized all params listed in the AWS documentation for listing objects in a bucket: delimiter, marker, max-keys, and prefix. See Amazon's AWS online documentation for more information.

Returns true for success, false for failure.

(Android™) S3 List Objects in Bucket

(Java) S3 List Objects in Bucket

CkTask S3_ListBucketObjectsAsync(String bucketPath);

Creates an asynchronous task to call the S3_ListBucketObjects method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_ListBuckets(CkString outStr);
String s3_ListBuckets();

Retrieves the XML listing of the buckets for an Amazon S3 account.

Returns true for success, false for failure.

(Android™) S3 List Buckets Example

(Java) S3 List Buckets Example

CkTask S3_ListBucketsAsync();

Creates an asynchronous task to call the S3_ListBuckets method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_UploadBytes(CkByteData contentBytes, String contentType, String bucketPath, String objectName);

The same as S3_UploadFile, except the contents of the file come from contentBytes instead of a local file.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Returns true for success, false for failure.

(Android™) Demonstrate S3_UploadBytes

(Java) Demonstrate S3_UploadBytes

CkTask S3_UploadBytesAsync(CkByteData contentBytes, String contentType, String bucketPath, String objectName);

Creates an asynchronous task to call the S3_UploadBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_UploadFile(String localFilePath, String contentType, String bucketPath, String objectName);

Uploads a file to the Amazon S3 service.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Returns true for success, false for failure.

(Android™) S3 Upload File

(Java) S3 Upload File

CkTask S3_UploadFileAsync(String localFilePath, String contentType, String bucketPath, String objectName);

Creates an asynchronous task to call the S3_UploadFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean S3_UploadString(String objectContent, String charset, String contentType, String bucketPath, String objectName);

Uploads an in-memory string to the Amazon S3 service. This is the same as UploadFile, except that the file contents are from an in-memory string instead of a local file. Internal to this method, the objectContent is converted to the character encoding specified by charset prior to uploading.

Note: x-amz-* headers, including metadata, can be added to any S3 request by adding each header with a call to SetRequestHeader. This applies to all S3 methods, even if not explicitly stated.

Returns true for success, false for failure.

(Android™) S3 Upload String

(Java) S3 Upload String

CkTask S3_UploadStringAsync(String objectContent, String charset, String contentType, String bucketPath, String objectName);

Creates an asynchronous task to call the S3_UploadString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean SaveLastError(String path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

boolean SetCookieXml(String domain, String cookieXml);

Restores cookies for a particular domain. It is assumed that the cookie XML was previously retrieved via the GetCookieXml method, and saved to some sort of persistent storage, such as within a database table. It is then possible for an application to restore the cookies by calling this method.

Returns true for success, false for failure.

boolean SetOAuthRsaKey(CkPrivateKey privKey);

Introduced in version 9.5.0.39

Sets the RSA key to be used with OAuth authentication when the RSA-SHA1 OAuth signature method is used (see the OAuthSigMethod property).

Returns true for success, false for failure.

boolean SetPassword(CkSecureString password);

Introduced in version 9.5.0.71

Equivalent to setting the Password property, but provides for a more secure way of passing the password in a secure string object.

Returns true for success, false for failure.

(Android™) HTTP Basic Auth with Secure Strings

(Java) HTTP Basic Auth with Secure Strings

void SetRequestHeader(String headerFieldName, String headerFieldValue);

Adds a custom header field to any HTTP request sent by a method that does not use the HTTP request object. These methods include Download, DownloadAppend, GetHead, PostBinary, PostMime, PostXml, PutBinary, PutText, QuickDeleteStr, QuickGet, QuickGetObj, QuickGetStr, QuickPutStr, XmlRpc, and XmlRpcPut.

Cookies may be explictly added by calling this method passing "Cookie" for the headerFieldName.

The RemoveRequestHeader method can be called to remove a custom header.

Note: Never explicitly set the Content-Length header field. Chilkat will automatically compute the correct length and add the Content-Length header to all POST, PUT, or any other request where the Content-Length needs to be specified. (GET requests always have a 0 length body, and therefore never need a Content-Length header field.)

Note: To add more than one header, call this method once per header field.

(Android™) Add Custom Header to HTTP GET

(Java) Add Custom Header to HTTP GET

boolean SetSslClientCert(CkCert cert);

Allows for a client-side certificate to be used for an SSL connection.

Returns true for success, false for failure.

(Android™) HTTP TLS Mutual Authentication (Client-Side Certificate)

(Java) HTTP TLS Mutual Authentication (Client-Side Certificate)

boolean SetSslClientCertPem(String pemDataOrPath, String pemPassword);

Allows for a client-side certificate + private key to be used for the SSL / TLS connection (often called 2-way SSL).

Returns true for success, false for failure.

How to Create a PEM that Contains Certificates and a Private Key

(Android™) HTTP TLS Mutual Authentication (Client-Side Certificate)

(Java) HTTP TLS Mutual Authentication (Client-Side Certificate)

boolean SetSslClientCertPfx(String pfxPath, String pfxPassword);

Allows for a client-side certificate + private key to be used for the SSL / TLS connection (often called 2-way SSL).

Returns true for success, false for failure.

(Android™) HTTP TLS Mutual Authentication (Client-Side Certificate)

(Java) HTTP TLS Mutual Authentication (Client-Side Certificate)

boolean SetUrlVar(String name, String value);

Introduced in version 9.5.0.67

Sets the value of a variable for substitutions in URLs passed to any method. Variables can appear in URLs in the following format: {$varName}. For example: https://graph.microsoft.com/v1.0/users/{$id}

Returns true for success, false for failure.

void SleepMs(int millisec);

Convenience method to force the calling process to sleep for a number of milliseconds.

CkHttpResponse SynchronousRequest(String domain, int port, boolean ssl, CkHttpRequest req);

Sends an explicit HttpRequest to an HTTP server and returns an HttpResponse object. The HttpResponse object provides full access to the response including all headers and the response body. This method may be used to send POST requests, as well as GET, HEAD, file uploads, and XMLHTTP. To send via HTTPS (i.e. TLS), set the ssl property = true. Otherwise set it to false.

Returns nil on failure

How URL Syntax Relates to SynchronousRequest

(Android™) WebDAV PROPFIND using SynchronousRequest

(Java) WebDAV PROPFIND using SynchronousRequest

(Android™) Simple HTTP POST

(Java) Simple HTTP POST

(Android™) Debugging HTTP

(Java) Debugging HTTP

(Android™) Send XMLHttpRequest using PUT, GET, DELETE, or any HTTP Request Method

(Java) Send XMLHttpRequest using PUT, GET, DELETE, or any HTTP Request Method

(Android™) Adding Cookies to an HTTP Request

(Java) Adding Cookies to an HTTP Request

(Android™) HTTP multipart/form-data Upload

(Java) HTTP multipart/form-data Upload

(Android™) Parse a URL into its Component Parts

(Java) Parse a URL into its Component Parts

(Android™) SOAP with MTOM XOP Attachment

(Java) SOAP with MTOM XOP Attachment

CkTask SynchronousRequestAsync(String domain, int port, boolean ssl, CkHttpRequest req);

Creates an asynchronous task to call the SynchronousRequest method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) Asynchronous HTTP SOAP 1.2 Request and Response using POST

(Java) Asynchronous HTTP SOAP 1.2 Request and Response using POST

boolean UnlockComponent(String unlockCode);

Unlocks the Http class/component. It is necessary to call Http.UnlockComponent before calling any other methods. Passing any string to UnlockComponent will automatically activate a 30-day trial period.

Returns true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information

boolean UrlDecode(String str, CkString outStr);
String urlDecode(String str);

URL decodes a string.

Returns true for success, false for failure.

boolean UrlEncode(String str, CkString outStr);
String urlEncode(String str);

URL encodes a string.

Returns true for success, false for failure.

boolean XmlRpc(String urlEndpoint, String xmlIn, CkString outStr);
String xmlRpc(String urlEndpoint, String xmlIn);

Makes an XML RPC call to a URL endpoint. The XML string is passed in an HTTP POST, and the XML response is returned.

Returns true for success, false for failure.

(Android™) HTTP XMLRPC Example

(Java) HTTP XMLRPC Example

CkTask XmlRpcAsync(String urlEndpoint, String xmlIn);

Creates an asynchronous task to call the XmlRpc method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

boolean XmlRpcPut(String urlEndpoint, String xmlIn, CkString outStr);
String xmlRpcPut(String urlEndpoint, String xmlIn);

Same as XmlRpc, but uses the HTTP PUT method instead of the POST method.

Returns true for success, false for failure.

CkTask XmlRpcPutAsync(String urlEndpoint, String xmlIn);

Creates an asynchronous task to call the XmlRpcPut method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

(Android™) How to Run an Asynchronous Task

(Java) How to Run an Asynchronous Task

Events

Chilkat supports event callbacks in Java (including Android) starting in version 9.5.0.52. To implement an event callback, your application would define and implement a class that derives from CkHttpProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkHttpProgress base class.

For example:

// Install an event callback handler to get progress events.
MyHttpProgress httpProgress = new MyHttpProgress();
http.put_EventCallbackObject(httpProgress);

MyHttpProgress example:

import com.chilkatsoft.CkHttpProgress;
import com.chilkatsoft.CkTask;

public class MyHttpProgress extends CkHttpProgress 
{	
  public boolean AbortCheck()
  {
    System.out.println("AbortCheck");
    // Return true to abort, false to allow the method to continue.
    return false;
  }
  	
  // pctDone is a value from 0 to 100
  // (it is actually value from 0 to the PercentDoneScale property setting)
  public boolean PercentDone(int pctDone)
  {
    System.out.println(pctDone);
    // Return true to abort, false to allow the method to continue.
    // Note: A PercentDone event is the equivalent of an AbortCheck.  
    // When PercentDone events are frequently firing, AbortCheck events are suppressed.
    // AbortCheck events will fire when the time between PercentDone events is longer 
    // than the HeartbeatMs property setting.
    return false;
  }
  
  public void ProgressInfo(String name, String value)
  {
    System.out.println(name + ": " + value);
  }
  
  public void TaskCompleted(CkTask task)
  {
     System.out.println("task completed!");
  }
  
  
  public boolean HttpRedirect(String originalUrl, String redirectUrl) 
  {
    // Return true to abort, false to allow the method to continue.
    return false;
  }

  public void HttpChunked() 
  {
  }

  public void HttpBeginReceive() 
  {
  }

  public void HttpEndReceive(boolean success) 
  {
  }

  public void HttpBeginSend() 
  {
  }

  public void HttpEndSend(boolean success) 
  {
  }

  public void ReceiveRate(long byteCount, long bytesPerSec) 
  {
  }

  public void SendRate(long byteCount, long bytesPerSec) 
  {
  }

}

public boolean AbortCheck();

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return true to abort; return false to continue (not abort)

public void HttpBeginReceive();

This event is fired just before beginning to read the HTTP response.

public void HttpBeginSend();

This event is fired just before the HTTP request is about to be sent.

public void HttpChunked();

Called when the received response is in chunked format.

public void HttpEndReceive(boolean success);

This event is fired after the complete HTTP response has been received.

public void HttpEndSend(boolean success);

This event is fired after the complete HTTP request has been sent.

public boolean HttpRedirect(String originalUrl, String redirectUrl);

Called for each redirect that is followed. Return true to abort; return false to follow the redirect.

public boolean PercentDone(int pctDone);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

Return true to abort; return false to continue (not abort)

public void ProgressInfo(String name, String value);

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

public void ReceiveRate(long long byteCount, int bytesPerSec);

Periodicallly called with information about the download performance (i.e. the receiving of the HTTP response). The byteCount is the cumulative number of bytes downloaded so far. The bytesPerSec is the current transfer rate in bytes per second.

public void SendRate(long long byteCount, int bytesPerSec);

Called periodically with upload progress information: The byteCount is the cumulative number of bytes uploaded so far. The bytesPerSec is the current transfer rate in bytes per second.

public void TaskCompleted(CkTask task);

Called in the background thread when an asynchronous task completes.

public void TextData(String data);

Text data provided by certain methods.