Class: HTTPClassDocService

• Inheritance
• Description
• Class protocol
  • defaults
  • queries-service
• Instance protocol
  • accessing
  • maintenance html presentation
  • queries-access
  • queries-service
  • registration
  • requests
  • settings persistency
• Examples

Inheritance:

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

Package:

stx:goodies/webServer

Category:

Net-Communication-HTTP-Services

Version:

rev: 1.72 date: 2024/04/29 07:50:49

user: stefan

file: HTTPClassDocService.st directory: goodies/webServer

module: stx stc-classLibrary: webServer

Description:

Generates class documentation

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:

 defaultClassDocExpirationTime

 defaultClassListExpirationTime

 defaultReplyPresenterClass

 defaultRootDirectory

 isThreadSafe

 linkName

return the default linkName path (with slash)

 settingsApplicationClass

my application in the settings dialog

Instance protocol:

 classDocExpirationTime

 classDocExpirationTime: something

 classListExpirationTime

 classListExpirationTime: something

 rootDirectory

 rootDirectory: something

 specificChangeFromRequest: aRequest

extracts parameter from an html-maintenance post-request

 specificInputFieldsForRequest: aRequest

generates the html-fragment for the maintenance form

 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.

 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.

 allowedMessages

 defaultMessage

 packageIsShown: aPackage

 addRequiredForeignServicesTo: aServer

I need a few file services for the bitmaps, icons and doc files

 removeRequiredForeignServicesFrom: aServer

 classDocIndex: aRequest

'server:classDocIndex' generates the class documentation index page.

 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)

 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.

 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)

 packageIndex: aRequest

generates the package index page.

 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 registerServiceOn:(HTTPServer runningServers first) as:'XX'