eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'ServerMaintenanceService':

Home

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

Class: ServerMaintenanceService


Inheritance:

   Object
   |
   +--HTTPService
      |
      +--HTTPSelectorService
         |
         +--ServerMaintenanceService

Package:
stx:goodies/webServer
Category:
Net-Communication-HTTP-Services
Version:
rev: 1.103 date: 2018/01/25 11:04:54
user: mawalch
file: ServerMaintenanceService.st directory: goodies/webServer
module: stx stc-classLibrary: webServer
Author:
Claus Gittinger
Christian Penk

Description:


a service which provides maintenance access to configure
the server and services.
Provides roughly the same functionality as the Launcher-Settings-WebServerSettings,
but via the HTTP interface.
Must be protected by a realm - if not, only access from the local host is allowed.


[access with:]
    http:<host>:<port>/Maintenance


Class protocol:

class access
o  defaultReplyPresenterClass

defaults
o  defaultAllowRobots

o  linkName
return the default linkName path (with slash)

o  noRealmBehavior
allow access ONLY from localHost, if no realm was specified for this service

queries-service
o  settingsApplicationClass
a SettingsApplication class - or nil (used in the settings dialog if non-nil)


Instance protocol:

defaults
o  defaultReplyPresenterClass

queries-service
o  defaultMessage

o  isAllowedInMaintenanceMode
return true, if this service is also allowed while the server is in maintenance mode

o  isMessageAllowed: aSelector
the message is only allowed if this class implements aSelector and
the method belongs to one of the categories 'requuests-reply'.

usage example(s):

        self new isMessageAllowed:#foo.
        self new isMessageAllowed:#defaultMessage.
        self new isMessageAllowed:#control:.

registration
o  addRequiredForeignServicesTo: aServer
I need a file service for the bitmaps and icons

requests-reply
o  addChangeService: aRequest
aRequest urlParameters keysAndValuesDo:[:key :value|

o  addRemoveChangeServices: aRequest
nextPutLine:'&nbsp;&nbsp;&nbsp;';

o  applyAddService: aRequest

o  applyChangeService: aRequest

o  applyRemoveChangeService: aRequest

o  applyRemoveService: aRequest

o  changeDebugging: aRequest
fields keysAndValuesDo:[:key :value|

o  changeHomeURL: aRequest

o  changeLogging: aRequest

o  changeNotFoundURL: aRequest

o  changeOtherSettings: aRequest

o  collectGarbage: aRequest

o  control: aRequest
Perform 'Maintenance:control:xxx' functions - this method provides all
functionality required for remote server administration (via the web).

o  disableSoap: aRequest

o  enableDisableSoap: aRequest yesNo: yesNo

o  enableSoap: aRequest

o  enterMaintenanceMode: aRequest

o  exitMaintenanceMode: aRequest

o  exitSmalltalk: aRequest

o  fileInPatch: aRequest

o  loadLibrary: aRequest
show the directory contents

o  loadSettings: aRequest

o  openLauncher: aRequest
ask user for Display,
open a display connection and a Laucher

o  printSettings: aRequest

o  removePatch: aRequest

o  restartServer: aRequest
this is special (and different to HTTPServer>>#restartServer):
The serverProcess will not terminate

o  saveSettings: aRequest

o  snapshot: aRequest

o  stopServer: aRequest

o  uploadPatch: aRequest

requests-reply-authorization
o  changeAuthorization: aRequest

o  changeAuthorizationMethods: aRequest

o  changeAuthorizationPageFor: aRequest

o  removeChangeUsersFor: aRequest

service-helpers
o  changeService: aService fromRequest: aRequest

o  createNewServiceFromFields: fields request: aRequest

o  createNewServiceFromRequest: aRequest

o  responseError: aErrorString title: aTitle request: aRequest backSelector: backSel

o  serviceFromRequest: request

o  serviceInputFieldsFor: service request: aRequest change: change



ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Fri, 16 Apr 2021 10:08:22 GMT