CkCgi Java Reference Documentation

CkCgi

Current Version: 9.5.0.98

Provides the ability to receive HTTP requests and all associated parameters, HTTP header fields, etc. A common use is for receiving HTTP uploads. Provides the ability to receive uploads that stream directly to disk, eliminating memory requirements for large files. Also provides the ability to receive uploaded files directly in memory.

Object Creation

CkCgi obj = new CkCgi();

Properties

AsyncBytesRead

int get_AsyncBytesRead();

To be documented soon...

AsyncInProgress

boolean get_AsyncInProgress();

To be documented soon...

AsyncPostSize

int get_AsyncPostSize();

To be documented soon...

AsyncSuccess

boolean get_AsyncSuccess();

To be documented soon...

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:

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

More Information and Examples

(Android™) Example showing how to use DebugLogFilePath.(Java) Example showing how to use DebugLogFilePath.

HeartbeatMs

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

To be documented soon...

IdleTimeoutMs

int get_IdleTimeoutMs();
void put_IdleTimeoutMs(int newVal);

To be documented soon...

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.

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

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.

LastMethodSuccess

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

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.

NumParams

int get_NumParams();

To be documented soon...

NumUploadFiles

int get_NumUploadFiles();

To be documented soon...

ReadChunkSize

int get_ReadChunkSize();
void put_ReadChunkSize(int newVal);

To be documented soon...

SizeLimitKB

int get_SizeLimitKB();
void put_SizeLimitKB(int newVal);

To be documented soon...

StreamToUploadDir

boolean get_StreamToUploadDir();
void put_StreamToUploadDir(boolean newVal);

To be documented soon...

UploadDir

void get_UploadDir(CkString str);
String uploadDir();
void put_UploadDir(String newVal);

To be documented soon...

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.

Version

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

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

More Information and Examples

(Android™) How to get the Chilkat version at runtime.(Java) How to get the Chilkat version at runtime.

Methods

AbortAsync

void AbortAsync();

To be documented soon...

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

AsyncReadRequest

boolean AsyncReadRequest();

To be documented soon...

GetEnv

boolean GetEnv(String varName, CkString outStr);
String getEnv(String varName);

To be documented soon...

Returns true for success, false for failure.

GetParam

boolean GetParam(String paramName, CkString outStr);
String getParam(String paramName);

To be documented soon...

Returns true for success, false for failure.

GetParamName

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

To be documented soon...

Returns true for success, false for failure.

GetParamValue

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

To be documented soon...

Returns true for success, false for failure.

GetRawPostData

boolean GetRawPostData(CkByteData outData);

To be documented soon...

Returns true for success, false for failure.

GetUploadData

boolean GetUploadData(int index, CkByteData outData);

To be documented soon...

Returns true for success, false for failure.

GetUploadFilename

boolean GetUploadFilename(int index, CkString outStr);
String getUploadFilename(int index);

To be documented soon...

Returns true for success, false for failure.

GetUploadSize

int GetUploadSize(int index);

To be documented soon...

IsGet

boolean IsGet();

To be documented soon...

IsHead

boolean IsHead();

To be documented soon...

IsPost

boolean IsPost();

To be documented soon...

IsUpload

boolean IsUpload();

To be documented soon...

ReadRequest

boolean ReadRequest();

To be documented soon...

SaveNthToUploadDir

boolean SaveNthToUploadDir(int index);

To be documented soon...

SleepMs

void SleepMs(int millisec);

To be documented soon...

TestConsumeAspUpload

boolean TestConsumeAspUpload(String path);

To be documented soon...