CkHttpRequest Java Reference Documentation

CkHttpRequest

Current Version: 9.5.0.75

Represents a complete HTTP request.

Object Creation

CkHttpRequest obj = new CkHttpRequest();

Properties

Boundary
void get_Boundary(CkString str);
String boundary();
void put_Boundary(String newVal);
Introduced in version 9.5.0.49

Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request.

top
Charset
void get_Charset(CkString str);
String charset();
void put_Charset(String newVal);

Controls the character encoding used for HTTP request parameters for POST requests. The default value is the ANSI charset of the computer. The charset should match the charset expected by the form target.

The "charset" attribute is only included in the Content-Type header of the request if the SendCharset property is set to true.

top
ContentType
void get_ContentType(CkString str);
String contentType();
void put_ContentType(String newVal);

The ContentType property sets the "Content-Type" header field, and identifies the content-type of the HTTP request body. Common values are:

application/x-www-form-urlencoded
multipart/form-data
application/json
application/xml
If ContentType is set equal to the empty string, then no Content-Type header is included in the HTTP request.

top
DebugLogFilePath
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.

top
EntireHeader
void get_EntireHeader(CkString str);
String entireHeader();
void put_EntireHeader(String newVal);

Composes and returns the entire MIME header of the HTTP request.

top
HttpVerb
void get_HttpVerb(CkString str);
String httpVerb();
void put_HttpVerb(String newVal);

The HttpVerb property should be set to the name of the HTTP method that appears on the "start line" of an HTTP request, such as GET, POST, PUT, DELETE, etc. It is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to anything, even custom verbs recognized by a custom server-side app.

top
HttpVersion
void get_HttpVersion(CkString str);
String httpVersion();
void put_HttpVersion(String newVal);

The HTTP version in the request header. Defaults to "1.1".

top
LastErrorHtml
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.

top
LastErrorText
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.

top
LastErrorXml
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.

top
LastMethodSuccess
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.

top
NumHeaderFields
int get_NumHeaderFields();

Returns the number of request header fields.

top
NumParams
int get_NumParams();

Returns the number of query parameters.

top
Path
void get_Path(CkString str);
String path();
void put_Path(String newVal);

The path of the resource requested. A path of "/" indicates the default document for a domain.

top
SendCharset
boolean get_SendCharset();
void put_SendCharset(boolean newVal);

Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request. The default value of this property is false.

top
VerboseLogging
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.

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

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

top

Methods

AddBytesForUpload
boolean AddBytesForUpload(String name, String remoteFileName, CkByteData byteData);

Adds a file to an upload request where the contents of the file come from an in-memory byte array. To create a file upload request, call UseUpload and then call AddBytesForUpload, AddStringForUpload, or AddFileForUpload for each file to be uploaded.

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
remoteFileName is the name of the file to be created on the HTTP server.
byteData contains the contents (bytes) to be uploaded.

Returns true for success, false for failure.

top
AddBytesForUpload2
boolean AddBytesForUpload2(String name, String remoteFileName, CkByteData byteData, String contentType);

Same as AddBytesForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the remoteFileName's file extension.)

Returns true for success, false for failure.

top
AddFileForUpload
boolean AddFileForUpload(String name, String filePath);

Adds a file to an upload request. To create a file upload request, call UseUpload and then call AddFileForUpload, AddBytesForUpload, or AddStringForUpload for each file to be uploaded. This method does not read the file into memory. When the upload occurs, the data is streamed directly from the file, thus allowing for very large files to be uploaded without consuming large amounts of memory.

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.

Returns true for success, false for failure.

top
AddFileForUpload2
boolean AddFileForUpload2(String name, String filePath, String contentType);

Same as AddFileForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the file extension.)

name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.

Returns true for success, false for failure.

top
AddHeader
void AddHeader(String name, String value);

Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it.

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.)

top
AddMwsSignature
boolean AddMwsSignature(String domain, String mwsSecretKey);
Introduced in version 9.5.0.66

Computes the Amazon MWS signature using the mwsSecretKey and adds the "Signature" parameter to the request. This method should be called for all Amazon Marketplace Web Service (Amazon MWS) HTTP requests. It should be called after all request parameters have been added.

Important: The Chilkat v9.5.0.75 release accidentally breaks Amazon MWS (not AWS) authentication. If you need MWS with 9.5.0.75, send email to support@chilkatsoft.com for a hotfix, or revert back to v9.5.0.73, or update to a version after 9.5.0.75.

The domain should be the domain of the request, such as one of the following:

  • mws.amazonservices.com
  • mws-eu.amazonservices.com
  • mws.amazonservices.in
  • mws.amazonservices.com.cn
  • mws.amazonservices.jp

Note: This method automatically adds or replaces the existing Timestamp parameter to the current system date/time.

Returns true for success, false for failure.

top
AddParam
void AddParam(String name, String value);

Adds a request query parameter (name/value pair) to the HTTP request. The name and value strings passed to this method should not be URL encoded.

top
AddStringForUpload
boolean AddStringForUpload(String name, String filename, String strData, String charset);

Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.

Returns true for success, false for failure.

top
AddStringForUpload2
boolean AddStringForUpload2(String name, String filename, String strData, String charset, String contentType);

Same as AddStringForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the filename's file extension.)

Returns true for success, false for failure.

top
AddSubHeader
boolean AddSubHeader(int index, String name, String value);
Introduced in version 9.5.0.55

Adds a request header to the Nth sub-header of the HTTP request. If a header having the same field name is already present, this method replaces it.

Returns true for success, false for failure.

top
GenerateRequestFile
boolean GenerateRequestFile(String path);
Introduced in version 9.5.0.64

The same as GenerateRequestText, except the generated request is written to the file specified by path.

Returns true for success, false for failure.

top
GenerateRequestText
boolean GenerateRequestText(CkString outStr);
String generateRequestText();

Returns the request text that would be sent if Http.SynchronousRequest was called.

Returns true for success, false for failure.

top
GetHeaderField
boolean GetHeaderField(String name, CkString outStr);
String getHeaderField(String name);

Returns the value of a request header field.

Returns true for success, false for failure.

top
GetHeaderName
boolean GetHeaderName(int index, CkString outStr);
String getHeaderName(int index);

Returns the Nth request header field name. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns true for success, false for failure.

top
GetHeaderValue
boolean GetHeaderValue(int index, CkString outStr);
String getHeaderValue(int index);

Returns the Nth request header field value. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.

Returns true for success, false for failure.

top
GetParam
boolean GetParam(String name, CkString outStr);
String getParam(String name);

Returns a request query parameter value by name.

Returns true for success, false for failure.

top
GetParamName
boolean GetParamName(int index, CkString outStr);
String getParamName(int index);

Returns the Nth request query parameter field name. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns true for success, false for failure.

top
GetParamValue
boolean GetParamValue(int index, CkString outStr);
String getParamValue(int index);

Returns the Nth request query parameter field value. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.

Returns true for success, false for failure.

top
GetUrlEncodedParams
boolean GetUrlEncodedParams(CkString outStr);
String getUrlEncodedParams();

Returns the request parameters in URL encoded form (i.e. in the exact form that would be sent if the ContentType property was application/x-www-form-urlencoded). For example, if a request has two params: param1="abc 123" and param2="abc-123", then GetUrlEncodedParams would return "abc+123

Returns true for success, false for failure.

top
LoadBodyFromBd
boolean LoadBodyFromBd(CkBinData requestBody);
Introduced in version 9.5.0.67

Uses the contents of the requestBody as the HTTP request body.

Returns true for success, false for failure.

top
LoadBodyFromBytes
boolean LoadBodyFromBytes(CkByteData byteData);

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of the byteData.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns true for success, false for failure.

top
LoadBodyFromFile
boolean LoadBodyFromFile(String filePath);

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of filePath.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

Returns true for success, false for failure.

top
LoadBodyFromSb
boolean LoadBodyFromSb(CkStringBuilder requestBody, String charset);
Introduced in version 9.5.0.67

Uses the contents of the requestBody as the HTTP request body. The charset indicates the binary representation of the string, such as "utf-8", "utf-16", "iso-8859-*", "windows-125*", etc. Any of the character encodings supported at the link below are valid.

Returns true for success, false for failure.

More Information and Examples
top
LoadBodyFromString
boolean LoadBodyFromString(String bodyStr, String charset);

The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of bodyStr.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.

charset indicates the charset, such as "utf-8" or "iso-8859-1", to be used. The HTTP body will contain the bodyStr converted to this character encoding.

Returns true for success, false for failure.

top
RemoveAllParams
void RemoveAllParams();

Removes all request parameters.

top
RemoveHeader
boolean RemoveHeader(String name);

Removes all occurrences of a HTTP request header field. Always returns true.

Returns true for success, false for failure.

top
RemoveParam
void RemoveParam(String name);

Removes a single HTTP request parameter by name.

top
SaveLastError
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.

top
SetFromUrl
void SetFromUrl(String url);

Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).

top
StreamBodyFromFile
boolean StreamBodyFromFile(String filePath);

Useful for sending HTTP requests where the body is a very large file. For example, to send an XML HttpRequest containing a very large XML document, one would set the HttpVerb = "POST", the ContentType = "text/xml", and then call StreamBodyFromFile to indicate that the XML body of the request is to be streamed directly from a file. When the HTTP request is actually sent, the body is streamed directly from the file, and thus the file never needs to be loaded in its entirety in memory.

Returns true for success, false for failure.

top
StreamChunkFromFile
boolean StreamChunkFromFile(String path, String offset, String numBytes);
Introduced in version 9.5.0.55

This method is the same as StreamBodyFromFile, but allows for an offset and number of bytes to be specified. The offset and numBytes are integers passed as strings.

Returns true for success, false for failure.

top