Cgi Java Reference Documentation

CkCgi

Deprecated To be removed in a future version, and should no longer be used.
Current Version: 10.1.3

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

top
AsyncInProgress
boolean get_AsyncInProgress();

To be documented soon...

top
AsyncPostSize
int get_AsyncPostSize();

To be documented soon...

top
AsyncSuccess
boolean get_AsyncSuccess();

To be documented soon...

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

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

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

To be documented soon...

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

To be documented soon...

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

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

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

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

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

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

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

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
NumParams
int get_NumParams();

To be documented soon...

top
NumUploadFiles
int get_NumUploadFiles();

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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

To be documented soon...

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 "10.1.0"

top

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.

top
AsyncReadRequest
boolean AsyncReadRequest();

To be documented soon...

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

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

top
GetRawPostData
boolean GetRawPostData(CkByteData outData);

To be documented soon...

Returns true for success, false for failure.

top
GetUploadData
boolean GetUploadData(int index, CkByteData outData);

To be documented soon...

Returns true for success, false for failure.

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

To be documented soon...

Returns true for success, false for failure.

top
GetUploadSize
int GetUploadSize(int index);

To be documented soon...

top
IsGet
boolean IsGet();

To be documented soon...

top
IsHead
boolean IsHead();

To be documented soon...

top
IsPost
boolean IsPost();

To be documented soon...

top
IsUpload
boolean IsUpload();

To be documented soon...

top
ReadRequest
boolean ReadRequest();

To be documented soon...

top
SaveNthToUploadDir
boolean SaveNthToUploadDir(int index);

To be documented soon...

top
SleepMs
void SleepMs(int millisec);

To be documented soon...

top
TestConsumeAspUpload
boolean TestConsumeAspUpload(String path);

To be documented soon...

top