eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'HTTPClassDocService':

Home

Documentation
www.exept.de
Everywhere
for:
[back]

Class: HTTPClassDocService


Inheritance:

   Object
   |
   +--HTTPService
      |
      +--HTTPSelectorService
         |
         +--HTTPClassDocService

Package:
stx:goodies/webServer
Category:
Net-Communication-HTTP-Services
Version:
rev: 1.65 date: 2019/06/28 07:02:33
user: cg
file: HTTPClassDocService.st directory: goodies/webServer
module: stx stc-classLibrary: webServer
Author:
Claus Gittinger

Description:


Generates class documentation


Class protocol:

defaults
o  defaultClassDocExpirationTime

o  defaultClassListExpirationTime

o  defaultReplyPresenterClass

o  defaultRootDirectory

o  isThreadSafe

o  linkName
return the default linkName path (with slash)

queries-service
o  settingsApplicationClass
my application in the settings dialog


Instance protocol:

accessing
o  classDocExpirationTime

o  classDocExpirationTime: something

o  classListExpirationTime

o  classListExpirationTime: something

o  rootDirectory

o  rootDirectory: something

maintenance html presentation
o  specificChangeFromRequest: aRequest
extracts parameter from an html-maintenance post-request

o  specificInputFieldsForRequest: aRequest
generates the html-fragment for the maintenance form

queries-access
o  exportedModules
list the modules we make accessible.
Everything else is not shown (i.e. classes from other modules are invisible).
If never set, only the public classes from stx are shown.

o  exportedModules: aCollection
set the list of modules we make accessible.
Everything else is not shown (i.e. classes from other modules are invisible).
If never set, only the public classes from stx are shown.

queries-service
o  allowedMessages

o  defaultMessage

o  packageIsShown: aPackage

registration
o  addRequiredForeignServicesTo: aServer
I need a few file services for the bitmaps, icons and doc files

o  removeRequiredForeignServicesFrom: aServer

requests
o  classDocIndex: aRequest
'server:classDocIndex' generates the class documentation index page.

o  classDocOf: aRequest
The class-by prefix character list page.
generate an HTML document string which contains HREFS for a list
of classes which start with some prefix (typically, the first
character is given)

o  classListForPackage: aRequest
The class-by package list page.
generate an HTML document string which contains HREFS for a list
of classes which are part of a package.

o  classListForPrefix: aRequest
The class-by prefix character list page.
generate an HTML document string which contains HREFS for a list
of classes which start with some prefix (typically, the first
character is given)

o  packageIndex: aRequest
generates the package index page.

settings persistency
o  settingSelectors
answer the selectors that are used to configure a service - i.e. those which are
saved in the webServer-settings file.

usage example(s):

     HTTPService new settingSelectors
     self new settingSelectors


Examples:


HTTPClassDocService registerServiceIn:(HTTPServer runningServers first) as:'XX'

ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Fri, 16 Apr 2021 11:33:36 GMT