CL-HTTP Reference Manual
Apropos:

HTTP
(433 external definitions)

Classes

ACCESS-CONTROL
ACCESS-STATISTICS-LOG
BAD-SYNTAX-PROVIDED
BASIC-URL-METERING
COMMON-FILE-LOG
CUSTOM-NOTIFICATION-LOG
DB-BASIC-GROUP
DB-BASIC-REALM
DB-BASIC-USER
DB-DIGEST-GROUP
DB-DIGEST-REALM
DB-DIGEST-SHA-GROUP
DB-DIGEST-SHA-REALM
DB-DIGEST-SHA-USER
DB-DIGEST-USER
DB-GROUP
DB-REALM
DB-USER
DB-USER-INFO
DOCUMENT-MOVED-PERMANENTLY
DOCUMENT-MOVED-TEMPORARILY
DOCUMENT-NOT-FOUND
EXTENDED-COMMON-FILE-LOG
FLOGGER
GROUP
HTTP-LOG
INDEXING-MAIL-ARCHIVE
INDEXING-MESSAGE
INDEXING-THREAD
INVALID-RANGE-REQUEST
NOTIFICATION-LOG
POST-LOG
PROPERTY-LIST-MIXIN
REALM

Variables

*ACCEPT-WRITE-METHODS*
*ACCEPTABLE-TRANSFER-ENCODINGS*
*ARMOR-PLATED-STRING-LINE-LENGTH*
*AUTHENTICATION-DATA-PATHNAME*
*AUTHENTICATION-DATABASE*
*AUTO-EXPORT*
*BUG-HTTP-SERVER*
*CACHE-DIRECTORY-INDEXES*
*CACHE-HYSTERISIS*
*CGI-VERSION*
*CL-HTTP-HOME-PAGE-URL-STRING*
*CL-HTTP-ICON-SMALL*
*CL-HTTP-USER-INIT-FILE*
*CLIENT-HTTP-VERSION*
*CLIENT-TIMEOUT*
*CONNECTION-BACKLOG*
*CONTENT-NEGOTIATE-DIRECTORY-VIEWS*
*DATA-CACHE-WINDOW-FREQUENCY*
*DATA-UNIVERSE-MAXIMUM-CACHE-ELEMENTS*
*DATA-UNIVERSE-MAXIMUM-CACHE-SIZE*
*DATA-UNIVERSE-REVALIDATION-INTERVAL*
*DATABASE-LOG-PROCESS-PRIORITY*
*DEBUG-CLIENT*
*DEBUG-SERVER*
*DIGEST-AUTHENTICATION-NONCE-LIFE-TIME*
*DURABLE-FORM-VALUES*
*ESCAPED-CHARACTERS*
*FILE-UPLOAD-DEFAULT-DIRECTORY*
*FILE-UPLOAD-MAXIMUM-SIZE*
*HTTP-HOST-NAME*
*HTTP-VERSION*
*IMAGE-SIZES-DEFAULT-AUTOMATICALLY*
*KEYWORD-PACKAGE*
*LAMBDAVISTA-AUTHENTICATION-REALM*
*LAMBDAVISTA-CAPABILITIES*
*LAMBDAVISTA-INDEX-ON-EXPORT*
*LAMBDAVISTA-SEARCH-URL*
*LAMBDAVISTA-SECURE-SUBNETS*
*LINE-BUFFER-SIZE*
*LOCAL-HOST-ADDRESS*
*LOCAL-HOST-DOMAIN-NAME*
*LOCAL-HOST-IP-ADDRESS*
*LOCAL-SCHEME*
*LOG-ACCESS-LOG-CLASS*
*LOG-RESOLVE-IP-ADDRESSES*
*LOG-TIMES-IN-GMT*
*LOG-WINDOW-CONNECTION-TIMEOUT*
*LOG-WINDOW-FORM-URL*
*LOG-WINDOW-HISTORY-SIZE*
*LOG-WINDOW-LOGO-URL*
*LOG-WINDOW-LOGS-URL*
*LOG-WINDOW-NOTIFICATION-URL*
*LOG-WINDOW-STATISTICS-REFRESH-RATE*
*LOG-WINDOW-STATISTICS-URL*
*LOG-WINDOW-TITLE-URL*
*LOG-WINDOW-URL*
*MAXIMUM-NUMBER-OF-CONNECTIONS*
*NUMBER-OF-CONNECTIONS*
*OVERLOAD-MESSAGE*
*PERSISTENT-CONNECTION-MAXIMUM-REQUESTS*
*PERSISTENT-CONNECTION-TIMEOUT*
*POST-FORM-BUFFER-SIZE*
*PRESERVE-HTTP-SERVER-RESOURCES*
*PROXY-CACHE*
*PROXY-CACHE-CLASS*
*PROXY-CACHE-DEFAULT-EXPIRATION-INTERVAL*
*PROXY-CACHE-FULL-GC-FREE-SPACE-RATIO*
*PROXY-CACHE-INCREMENTAL-GC*
*PROXY-CACHE-INCREMENTAL-GC-FREE-SPACE-RATIO*
*PROXY-CACHE-INCREMENTAL-GC-FREE-SPACE-TRIGGER-RATIO*
*PROXY-CACHE-INCREMENTAL-GC-PROCESS-PRIORITY*
*PROXY-CACHE-MAXIMUM-EXPIRATION-TIME*
*PROXY-CACHE-MAXIMUM-RESOURCES*
*PROXY-CACHE-MAXIMUM-SIZE*
*PROXY-CACHE-MINIMUM-EXPIRATION-TIME*
*PROXY-CACHEABLE-REQUEST-HEADERS*
*PROXY-CONNECT-ALLOWED-PORTS*
*PROXY-DATABASE-CLASS*
*PROXY-SERVER-LIFE-TIME*
*PROXY-SERVICE*
*REALM-ACCESS-CONTROL-TABLE-SIZE*
*REALM-GROUP-TABLE-SIZE*
*REALM-USER-TABLE-SIZE*
*REJECT-CONNECTION-MESSAGE*
*REJECT-CONNECTION-THRESHOLD*
*REPRESENTATION-CLASS*
*RESOLVE-IP-ADDRESSES*
*RESOURCE-CLASS*
*SEARCH-URL-INTERN-MODE*
*SERVER*
*SERVER-CLASS*
*SERVER-INITIALIZATION-LIST*
*SERVER-INTERFACE-VERSION*
*SERVER-LAUNCH-INITIALIZATION-LIST*
*SERVER-LIFE-TIME*
*SERVER-MAIL-ADDRESS*
*SERVER-TIMEOUT*
*SHUTDOWN-INITIALIZATION-LIST*
*STACK-BACKTRACE-NUMBER-OF-FRAMES*
*STACK-BACKTRACES-IN-BUG-REPORTS*
*STANDARD-CHARACTER-TYPE*
*STANDARD-CONFIGURATION-PATHNAME*
*STANDARD-CONFIGURATION-WRITE-FILE-P*
*STANDARD-EXPORT-PATHNAMES*
*STANDARD-HTTP-PORT*
*STANDARD-PROTOCOL*
*STANDARD-PROXY-PORT*
*USER-AGENT-CAPABILITIES*

Generic Functions

ACCESS-CONTROL-NAME
ACCESS-CONTROL-REALM
ADD-ACCESS-CONTROL-GROUP
ADD-ACCESS-LOG
ALLOW-USER-ACCESS-P
BUG-REPORT-ERROR
CACHE-DATA
CAPTURE-RAW-URL
CLEAR-DATA-UNIVERSE
CONDITIONAL-COPY-FILE
COPY-FILE
CRLF-CANONICALIZE-FILE
CRLF-PATHNAME
DEINITIALIZE-RESOURCED-SERVER
DELETE-URL
DISPLAY-URL-AUTHENTICATION-STATUS
ENSURE-CRLF-CANONICAL-FILE
ENSURE-CURRENT-DATA
EXPORT-URL
FIND-ACCESS-LOG-IF
FLOG-SERVER
GET-URL-HEADERS
GET-URL-HEADERS-AND-BODY
GET-VALUE
GROUP-ADD-USER
GROUP-NAME
GROUP-REALM
GROUP-REMOVE-USER
GROUP-USERS
HEADER-VALUE
INDEX-URL
INITIALIZE-RESOURCED-SERVER
INTERN-ACCESS-CONTROL
INTERN-GROUP
INTERN-USER
INVOKE-HTTP-SERVICE
LOG-ACCESS
LOG-COMPRESSION-ON
LOG-DYNAMIC-LOGGING-ON
LOG-FILE-LOGGING-ON
LOG-NOTIFICATIONS-ON
MAP-INDICATORS
MAP-VALUES
PARSE-IMAGE-MAP
PARSE-SHTML-TEMPLATE
POST-DOCUMENT
POST-FORM-VALUES
POST-URL
PROPERTY-LIST
PROVIDE-SERVICE
PUT-URL
REALM-NAME
REALM-SCHEME
RECACHE-DATA-CACHE
RECACHE-DATA-UNIVERSE
REDIRECT-REQUEST
REMOVE-ACCESS-LOG
REMOVE-DATA-CACHE
REMOVE-VALUE
REPORT-STATUS-MESSAGE
RESPONSE-WRITER-TO-INFORM-USER-VIA-EMAIL-OF-SUCCESS
SAVE-AUTHENTICATION-OBJECT
SEND-MAIL-TO-GROUP
SEND-MAIL-TO-USER
SERVER-ADDRESS
SERVER-AUTHENTICATION-METHOD
SERVER-AUTHENTICATION-METHOD-STRING
SERVER-FORM-ALIST
SERVER-GET-HEADER
SERVER-HOST
SERVER-HOST-DOMAIN-NAME
SERVER-HOST-IP-ADDRESS
SERVER-HOST-LOCAL-PORT
SERVER-HTTP-VERSION
SERVER-HTTP-VERSION-STRING
SERVER-LIFE-TIME
SERVER-LIVE-CONNECTION-P
SERVER-LOCAL-HOST-DOMAIN-NAME
SERVER-METHOD
SERVER-RELATIVE-URL-STRING
SERVER-REQUEST-TIME
SERVER-SOFTWARE-VERSION
SERVER-STREAM
SERVER-TIMEOUT
SERVER-TRANSLATED-PATHNAME
SERVER-URL
SERVER-URL-SEARCH-KEYS
SERVER-USER-AGENT
SERVER-USER-OBJECT
SET-SERVER-STATUS
SHOW-RAW-URL
SHOW-URL
SHOW-URL-HEADERS
SORTED-ACCESS-CONTROLS
SORTED-GROUPS
SORTED-USERS
STREAM-COPY-UNTIL-EOF
STREAM-DECODE-CRLF-UNTIL-EOF
STREAM-ENCODE-CRLF-UNTIL-EOF
UNEXPORT-URL
UNINTERN-ACCESS-CONTROL
UNINTERN-DATA-UNIVERSE
UNINTERN-GROUP
UNINTERN-REALM
UNINTERN-USER
UPDATE-USER
USER-ADD-GROUP
USER-EMAIL-ADDRESS
USER-GROUPS
USER-ID
USER-INFO-USER
USER-NAME
USER-PASSWORD-DIGEST
USER-PERSONAL-NAME
USER-QUALIFIED-NAME
USER-REALM
VALID-CRLF-CACHE-FILE-P
VALID-SEARCH-URL-P
WRITE-COMMON-LOGFILE-ENTRY
WRITE-DOCUMENT
WRITE-DOCUMENT-HEADERS

Functions

%MIME-CONTENT-TYPE-MAJOR-TYPE
%MIME-CONTENT-TYPE-SPEC
ADD-GROUP
ADD-GROUPS
ADD-HOST-TO-LOAD-BALANCING-CLUSTER
ADD-MODULE-FOR-FIND-DOCUMENTATION
ADD-PERIODIC-TASK
ADD-REALM
ADD-REALM-SCHEME
ADD-USER
ADD-VIRTUAL-HOST
ADD-VIRTUAL-HOST-NICK-NAME
ALL-SERVERS
ALLOCATE-FLOGGER
CL-HTTP-SIGNATURE
CLEAR-VIRTUAL-HOSTS
CLOSE-ALL-LOGS
COMPUTE-TRANSMITTED-BYTES
CONNECT-TO-AUTHENTICATION-DATABASE
CRLF-FILE-LENGTH-IN-BYTES
CRLF-FILE-PARAMETERS
CURRENT-ACCESS-LOGS
CURRENT-USER-AGENT
CURRENT-USER-OBJECT
DEBUG-CLIENT
DEBUG-PROXY
DEBUG-SERVER
DELETE-PERIODIC-TASK
DELETE-USER
DESCRIBE-STATUS-CODES
DIGEST-AUTHENTICATION-RANDOM-SEED
DISABLE-HTTP-SERVICE
DISABLE-POST-LOGGING
DISABLE-PROXY-SERVICE
DISABLE-URL-METERING
DISCONNECT-FROM-AUTHENTICATION-DATABASE
EMAIL-ADDRESS-FOR-BUG-REPORTS
ENABLE-DATABASED-REALMS
ENABLE-HTTP-SERVICE
ENABLE-POST-LOGGING
ENABLE-PROXY-SERVICE
ENABLE-URL-METERING
ENSURE-CURRENT-LOG
ENSURE-EXTENDED-PROXY-LOG
ENSURE-LIST
ENSURE-MULTIPORT-STATISTICS-LOG
ESCAPED-CHARACTER-P
EXPORT-LAMBDAVISTA-SEARCH-PAGE
EXPORT-LOG-WINDOW
EXPORT-PROXY-INTERFACES
EXPORT-TYPE-FOR-PATHNAME-TYPE
EXPORT-WEB-CONFIGURATION-INTERFACE
FINGER
GENERATE-USER-PASSWORD
GET-HEADER
GET-RAW-HEADER
HOST-DEFAULT-PATHNAME
HTTP-SERVICE-ENABLED-P
INITIALIZE-AUTHENTICATION-DATABASE-TABLES
INITIALIZE-PROXY-CACHE
INTERN-ACCESS-LOG
INTERN-DATA-UNIVERSE
INTERN-DATABASED-REALM
INTERN-KEYWORD
INTERN-REALM
INTERN-SSL-CONTROL
IP-ADDRESS-STRING-P
LAUNCH-DEMO
LISTENING-ON-HTTP-PORTS
LOAD-FILES-SAFELY
LOCAL-CONTEXT
LOG-FILE-STREAM-STAYS-OPEN
MAKE-HTTP-SEARCH-SUFFIX
MAKE-SERVER
MAKE-SET-COOKIE-HEADER-VALUE
MAP-HEADERS
MERGE-URL
MIME-CONTENT-TYPE-COPY-MODE
MIME-CONTENT-TYPE-KEYWORDS
MIME-MULTIPART-BOUNDARY-STRING
MOVE-SERVER-TO-NEW-HOST
NFILL-ARRAY
NOTE-PATHNAME-EXTENSION-EXPORT-TYPE
NULL-STRING-P
PARSE-INTERNET-ADDRESSES
PATHNAME-CREATE-DIRECTORY-IF-NEEDED
PRIMARY-PATHNAME-EXTENSION
PRIMARY-PATHNAME-EXTENSION-FOR-EXPORT-TYPE
PRINT-DATE
QUALIFY-DOMAIN-NAME
READ-FROM-ARMOR-PLATED-STRING
REMOTE-USER-AGENT
REMOVE-HOST-FROM-LOAD-BALANCING-CLUSTER
REMOVE-LOAD-BALANCING-CLUSTER
REMOVE-VIRTUAL-HOST
REPORT-BUG
RESET-AUTHENTICATION-DATABASE-CONNECTION
RESTORE-AUTHENTICATION-DATA
RETURN-FORM-VALUES
RUN-SERVER-INITIALIZATIONS
SAVE-AUTHENTICATION-DATA
SEND-MAIL-FROM
SET-DEFAULT-SSL-CONTROL
SET-HTTP-LOGICAL-DIRECTORY-LOCATION
SET-MAXIMUM-NUMBER-OF-CONNECTIONS
SET-STANDARD-HTTP-PORT
SET-STANDARD-HTTP-PROXY-PORT
SHOW-PERIODIC-TASKS
SORTED-REALMS
STANDARD-DATA-UNIVERSE
STRING-ESCAPE-SPECIAL-CHARS
STRING-SEARCH
STRING-UNESCAPE-SPECIAL-CHARS
SUBMIT-AND-RESET-BUTTONS
SYMBOLIZE
TRACE-PROXY
UID-SERIES-ALLOCATE
UID-SERIES-INITIALIZED-P
UID-SERIES-INTERVAL
UID-SERIES-STRING
UID-SERIES-WIDTH
UNDEFINE-SERVICE-ON-PORT
UNINTERN-SSL-CONTROL
USER-AGENT-CAPABILITY-P
VALID-DOMAIN-NAME-STRING-P
WHITE-SPACE-CHAR-P
WRITE-DIRECTORY-LISTING
WRITE-INDEXED-DIRECTORY-LISTING
WRITE-TO-ARMOR-PLATED-STRING

Macros

BIND-QUERY-VALUES
DEFINE-CACHED-DATA
DEFINE-CLIENT-CERTIFICATES
DEFINE-CLIENT-PROXY-MAPPING
DEFINE-CLIENT-SSL-CONTROL
DEFINE-DISALLOWED-SUBNETS
DEFINE-HTTP-SERVICE
DEFINE-HTTPS-SERVICE
DEFINE-LOAD-BALANCING-CLUSTER
DEFINE-LOG-WINDOW-ACTIVITIES
DEFINE-PROXY-CONNECT-DISALLOWED-DESTINATION-SUBNETS
DEFINE-PROXY-SUBNETS
DEFINE-READ-SUBNETS
DEFINE-SECURE-SUBNETS
DEFINE-SHTML-ACTION
DEFINE-SUBNET
DEFINE-UID-SERIES
DEFINE-URL-CONTEXT-REMAPPINGS
DEFINE-URL-EXPORT-TYPE
DEFINE-URL-EXPORTS
DEFINE-WRITE-SUBNETS
SET-COOKIE-HTTP-HEADERS
WITH-CGI-ENVIRONMENT
WITH-CONDITIONAL-GET-RESPONSE
WITH-COOKIE-VALUES
WITH-DATA-UNIVERSE
WITH-DATABASED-REALMS
WITH-HTTP-REQUEST
WITH-IMAGE-COORDINATES
WITH-LOCAL-CONTEXT
WITH-LOCAL-SCHEME
WITH-METERED-RESPONSE
WITH-MIME-MULTIPART-BLOCK
WITH-RESPONSE-ENSURED
WITH-SERVER-INTERFACE-ENVIRONMENT
WITH-SSL-CONTROL
WITH-STRING-FOR-NULL-STREAM
WITH-SUBNET-ACCESS-CONTROL
WITH-SUCCESSFUL-RESPONSE
WITH-USER-EMAIL-ADDRESS
WITH-VALUE-CACHED
HTTP:DEFINE-HTTPS-SERVICE [Macro] : (&KEY PORT (ADDRESS ALL) CERTIFICATE PRIVATE-KEY (PASSWORD PROMPT) PARAMETERS (CIPHERS ALL) (SSL-VERSION SSL-DEFAULT) CERTIFICATE-AUTHORITIES CLIENT-CERTIFICATES (VERIFY NEVER) (VERIFY-DEPTH 9) (TIMEOUT (QUOTE *SERVER-TIMEOUT*)) (PROCESS-PRIORITY (QUOTE *LISTENER-PROCESS-PRIORITY*)) (BACKLOG (QUOTE *CONNECTION-BACKLOG*)) ENABLE-SERVICE-P)
Specifies the parameters for HTTPS service on the port, PORT, and enables service when ENABLE-SERVICE-P is non-null. 
The required parameters are:

CERTIFICATE             - A pathname containing the pem-encoded certificate for the SSL server on PORT. 

PRIVATE-KEY             - A pathname containing the pem-encoded private key for the SSL server on PORT. 

PASSWORD                - A string which is the password for PRIVATE-KEY, or any of the following keywords:

                            :NONE   - No password required for PRIVATE-KEY.
                            :PROMPT - Ask the user for the password when SSL is launched.

PARAMETERS              - A pathname containing the pem-encoded Diffie-Hellman parameters for the SSL server on PORT.
                          Open SSL dhparam shell command generates the parameters. See: http://www.openssl.org/docs/apps/dhparam.html
                          For discussion, see: http://www.openssl.org/docs/ssl/SSL_CTX_set_tmp_dh_callback.html

The optional parameters are:

CIPHERS                 - A keyword or string denoting OpenSSL cipher suites to use with SSL on PORT.
                          The following values are available:

                            :ALL           - all ciphers suites offering at least some encryption.
                            :HIGH          - ciphers with key lengths greater than 128 bits.
                            :MEDIUM        - ciphers using 128 bit encryption.
                            :LOW           - ciphers using 64 or 56 bit encryption algorithms but excluding export cipher suites.
                            :56-BIT-EXPORT - ciphers using 56 bit export encryption algorithms.
                            :EXPORT        - ciphers using export encryption algorithms, including both 40 and 56 bits algorithms.
                            :40-BIT-EXPORT - ciphers using 40 bit export encryption algorithms.

                          Users desiring fine-grained control may provide an OpenSSL cipher string. 
                          These are described here: http://www.openssl.org/docs/apps/ciphers.html

SSL-VERSION             - A keyword that controls the version of SSL/TLS used on PORT. The options are:

                            :TLS-1       - Use only TLS version 1
                            :SSL-2-OR-3  - Use only SSL version 2 or 3 
                            :SSL-3       - Use only SSL version 3
                            :SSL-2       - Use only SSL version 2
                            :SSL-DEFAULT - Use the current default SSL versions (2 or 3)

Client certificates are not checked unless either CERTIFICATE-AUTHORITIES or CLIENT-CERTIFICATES is
supplied, which case the values of VERIFY and VERIFY-DEPTH

CERTIFICATE-AUTHORITIES - A pathname containing the PEM-encoded (base64 encoded) trusted certificate authorities or certificate 
                          revocation lists accepted from clients by the SSL server on PORT.

CLIENT-CERTIFICATES     - A directory containing PEM-encoded (base64 encoded) trusted certificate authorities or certificate 
                          revocation lists accepted from clients by the SSL server on PORT.

VERIFY                  - A keyword that controls client certificate verification by the SSL server on PORT.

                            :NEVER  - The server does not send a client certificate request to the client, so the client will 
                                      not send a certificate.
                            :ALWAYS - The server sends a client certificate request to the client, and any returned certificate 
                                      returned is checked. If the verification process fails, the TLS/SSL handshake is immediately
                                      terminated with an alert message containing the reason for the verification failure.
                            :ONCE   - Same as :ALWAYS except the a client certificate is checked only on the initial TLS/SSL handshake,
                                      and not again in case of renegotiation.

VERIFY-DEPTH            - An integer between 1 and 32 specifiying maximum certificate chain length for authentication of client 
                          or peer certificates.

Standard parameters controlling HTTP service.

ADDRESS                 - An IP address string for the network interface on which to accept connections.
                          The value can also be a keyword:
                              :ALL      - Listen on all interfaces
                              :PRIMARY  - Listen only on the primary interface (see also http:*primary-network-host*)
                              :LOOPBACK - Listen on the loopback address 127.0.0.1

TIMEOUT                 - Time in 60ths of a second before the server drops an idle HTTP connection.

PROCESS-PRIORITY        - An integer specifying process priority for the process listening on PORT.

BACKLOG                 - The number of pending connections on PORT that will be queued for accept.