Class: ServerMaintenanceService

• Inheritance
• Description
• Class protocol
  • class access
  • defaults
  • queries-service
• Instance protocol
  • defaults
  • queries-service
  • registration
  • requests-reply
  • requests-reply-authorization
  • service-helpers

Inheritance:

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

Package:

stx:goodies/webServer

Category:

Net-Communication-HTTP-Services

Version:

rev: 1.109 date: 2024/03/11 22:16:41

user: cg

file: ServerMaintenanceService.st directory: goodies/webServer

module: stx stc-classLibrary: webServer

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

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:

 defaultReplyPresenterClass

 defaultAllowRobots

 linkName

return the default linkName path (with slash)

 noRealmBehavior

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

 settingsApplicationClass

a SettingsApplication class - or nil (used in the settings dialog if non-nil)

Instance protocol:

 defaultReplyPresenterClass

 defaultMessage

 isAllowedInMaintenanceMode

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

 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:.

 addRequiredForeignServicesTo: aServer

I need a file service for the bitmaps and icons

 addChangeService: aRequest

aRequest urlParameters keysAndValuesDo:[:key :value|

 addRemoveChangeServices: aRequest

nextPutLine:'   ';

 applyAddService: aRequest

 applyChangeService: aRequest

 applyRemoveChangeService: aRequest

 applyRemoveService: aRequest

 changeDebugging: aRequest

fields keysAndValuesDo:[:key :value|

 changeHomeURL: aRequest

 changeLogging: aRequest

 changeNotFoundURL: aRequest

 changeOtherSettings: aRequest

 collectGarbage: aRequest

 control: aRequest

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

 disableSoap: aRequest

 enableDisableSoap: aRequest yesNo: yesNo

 enableSoap: aRequest

 enterMaintenanceMode: aRequest

 exitMaintenanceMode: aRequest

 exitSmalltalk: aRequest

 fileInPatch: aRequest

 loadLibrary: aRequest

show the directory contents

 loadSettings: aRequest

 openLauncher: aRequest

ask user for Display,
open a display connection and a Laucher

 printSettings: aRequest

 removePatch: aRequest

 restartServer: aRequest

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

 saveSettings: aRequest

 snapshot: aRequest

 stopServer: aRequest

 uploadPatch: aRequest

 changeAuthorization: aRequest

 changeAuthorizationMethods: aRequest

 changeAuthorizationPageFor: aRequest

 removeChangeUsersFor: aRequest

 changeService: aService fromRequest: aRequest

 createNewServiceFromFields: fields request: aRequest

 createNewServiceFromRequest: aRequest

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

 serviceFromRequest: request

 serviceInputFieldsFor: service request: aRequest change: change