OIL2 Class Standard.HTTP_SSIprocessor

class Standard . HTTP_SSIprocessor {
        string  defaultErrMess;
        set     dependsOn;
        array   ifCond;
        set     includedFileNames;
        string  myDir;
        int32   nestedIfLevel;
        any     resultData;
        string  sizeFmt;
        assoc   sourceEnv;
        string  timeFmt;
        int32   timeout;
        oid     urlDirectory;
} inherits from Object;

DESCRIPTION

HTTP Server-Side-Include processing is performed by objects of the class HTTP_SSIprocessor. These objects are created as needed when a server-side-include directive is detected in a file being read by the HTTPdaemon.

METHODS

Standard.HTTP_SSIprocessor:create

HTTP_SSIprocessor:create(oid urlDir, string srcData, assoc env, any urlQuery, any sourcePath)

Method Description

The create method takes four arguments.

the object Id of the URLdirectory of the associated web site
a string containing the contents of the template to be processed
an associative array of environment variables
url-encoded attribute/value pairs (e.g., characters after the "?" in a URI)

Standard.HTTP_SSIprocessor:getProcessedData

HTTP_SSIprocessor:getProcessedData()

Method Description

Returns a string containing the dynamically generated data.

Standard.HTTP_SSIprocessor:getSuggestedTimeout

HTTP_SSIprocessor:getSuggestedTimeout()

Method Description

Returns an integer value indicating the suggested number of seconds that the dynamically generated document should be cached.

Standard.HTTP_SSIprocessor:getIncludedFileNames

HTTP_SSIprocessor:getIncludedFileNames()

Method Description

Returns a set listing all of the local files that were included during the processing of include directives. This information can be used to help determine if the contents of this dynamically generated document are no longer valid due to subsequent modifications of an included file.

Standard.HTTP_SSIprocessor:getDependentObjects

HTTP_SSIprocessor:getDependentObjects()

Method Description

Returns a set of object Ids corresponding to other included cached documents that are maintained by objects of class HTTPcachedObject or the equivalent. This information can be used to help determine if the contents of this dynamically generated document are no longer valid due to subsequent modifications of an included document, which in turn might have been dynamically generated.