ModuleService Class

Definition

public ref class ModuleService abstract

public abstract class ModuleService

type ModuleService = class

Public MustInherit Class ModuleService

Inheritance

Object

ModuleService

Derived

Microsoft.Web.Management.Server.ConfigurationAuthenticationModuleService

Examples

The following example shows how to create a simple class that derives from the ModuleService class and retrieves the application's settings.

using System;
using System.Diagnostics;               // for Trace.WriteLine
using System.Collections;
using System.Security.Principal;        // for WindowsBuiltInRole
using Microsoft.Web.Administration;
using Microsoft.Web.Management.Server;

namespace rxDemo {
    public class DemoModuleService : ModuleService {

        ArrayList _infoLst = new ArrayList();

        [ModuleServiceMethod]
        public ArrayList GetSettings() {                    // expose GetSettings
            ConfigurationSection appSettingsSection = ManagementUnit.Configuration.GetSection("appSettings");

            ConfigurationElementCollection settings = appSettingsSection.GetCollection();

            ArrayList settingsList = new ArrayList();
            foreach (ConfigurationElement setting in settings) {
                PropertyBag settingBag = new PropertyBag();

                settingBag[0] = setting.GetAttribute("key").Value;
                settingBag[1] = setting.GetAttribute("value").Value;
                settingBag[2] = setting.IsLocallyStored ? "Local" : "Inherited";
                settingsList.Add(settingBag);
            }
            if (settingsList.Count < 1) {            // If there are no setting
                AddEmptyData();                     // Add info so we know our code
                return _infoLst;                   // is working.
            }
            TraceInternal();

            return settingsList;
        }

Remarks

The ModuleService members are exposed through the ModuleServiceProxy class. A derived ModuleService class should contain all the program logic for the management module.

A module service is a Web service that executes code to implement the features that access and modify management information.

Constructors

Properties

Methods

Applies to