Class: HTTPResponseHeader

• Inheritance
• Description
• Class protocol
  • constants
  • instance creation
• Instance protocol
  • accessing
  • actions
  • queries
  • sending
• Private classes

Inheritance:

   Object
   |
   +--HTTPResponseHeader
      |
      +--FCGIResponse::ResponseHeader

Package:

stx:goodies/webServer

Category:

Net-Communication-HTTP-Server

Version:

rev: 1.39 date: 2024/03/05 11:23:45

user: cg

file: HTTPResponseHeader.st directory: goodies/webServer

module: stx stc-classLibrary: webServer

Description:

collects the fields of an HTTP response header

copyright
COPYRIGHT (c) 2003 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 reasonPhraseForStatus: statusCode

self reasonPhraseForStatus:401

 reasonPhrasesDictionary

returns a dictionary which maps HTTP-codes to a descriptive message text

Usage example(s):

self reasonPhrasesDictionary

 httpOKHeaderForResponse: aResponse

 response: aResponse

 responseCode: aCode response: aResponse

 statusCode: aCode response: aResponse

** This is an obsolete interface - do not use it (it may vanish in future versions) **

Instance protocol:

 additionalHeaderLines

return the collection containing additionalHeaderLines.
Lazily initialized here as an empty collection

 cacheControl

 contentDisposition: aContentDispositionString filename: aFileNameString

 contentLength

contentLength from header as a number, if the header is set by a service as a string
the contentLength field value will be parsed from the header

 contentLength: something

set the contentLength field

 contentLocation

 contentLocation: something

 contentType

answer the request's content-type.
No LONGER:
Since we currently use 1-byte strings, our default character set is ISO8859-1.
This has changed to default (which is UTF-8 nowadays)

Usage example(s):

contentType := 'text/html; charset=ISO-8859-1'.

Usage example(s):

contentType := 'text/html; charset=UTF-8'.

 contentType: aString

set the contentType field

 contentType: aContentTypeArg contentLength: contentLengthArg expirationTime: expirationTimestampArg

 expectedAuthRealm: something

 expirationTime

 expirationTime: expirationTimestamp

the responses expirationTimestamp.
Obsolete, only for old HHTP/1.0 caches, which are long gone.
Use #maxAge:

 externalHeaderString: aCompleteHeaderString

ATTENTION: we really want a cr-lf here

 httpVersion

 httpVersion: something

 isWebSocketResponseHeader: aBoolean

 lastModified

the last modified time of a page - typically a file

 lastModified: lastModifiedTimestamp

the last modified time of a page - typically a file

 location

 location: something

Used with a 3xx moved response.

 maxAge: aSecondsIntegerOrTimeDuration

how many seconds may this response be cached

 parseFirstLine

parse the first line of a HTML response string

 response

 response: something

 responseCode

 responseCode: something

 setNoCache

Tell the client and possible caches to not cache the response

 addLineToHeader: aString

 redirectTo: targetUrl

setup for a redirect response

 hasErrorStatusCode

answer true, if this is an error response

 hasFilename

 isBinaryContent

 isWebSocketResponseHeader

 generateResponseOn: headerStream

must add content-length because external header string does not have one added
(com swiki in some cases)

 generateResponseStatusOn: headerStream

ATTENTION: we really want a cr-lf here

Private classes:

    CacheControl