Home > Articles > Web Services > XML

  • Print
  • + Share This
Like this article? We recommend

Implementing a Custom IConfigurationSectionHandler

IConfigurationSectionHandler is an interface defined in the System.Configuration namespace. As when using any interface, all you have to do is implement the contract—the features—defined by the interface. Because at some point you may want to reuse the custom configuration block, and the handler is loaded dynamically and invoked using Reflection, you'll place the section handler in its own class library. That said, we can define our objectives in broad strokes and then complete each task:

  • To implement an IConfigurationSectionHandler for the custom XML block in Listing 1, we'll create a separate class library project. (The language doesn't matter, but we'll use C# for this example.)
  • In that project, we'll add a using statement for the System.Configuration namespace.
  • In that project, we'll also define a public class that implements IConfigurationSectionHandler, and implement the required Create method defined by the interface.

The Create method will be called—we'll see how that works in a minute—with the block of XML defined in Listing 1. The goal is to read those elements using XML helper classes and convert the text into an object. How we initialize the object dictates how we reconstruct the object from XML. Listing 2 shows one possible implementation of the PlayerDefaultOptions, which is the class we will reconstruct from the XML block in Listing 1.

Listing 2 An implementation of the PlayerDefaultOptions class.

public class PlayerDefaultOptions
{
 private string playerName = "no name";
 private bool hints = false;
 private bool noSurrender = false;
 private bool playHintsOnly = false;

 public PlayerDefaultOptions(){}

 public string PlayerName
 {
  get { return playerName; }
  set { playerName = value; }
 }

 public bool Hints
 {
  get{ return hints; }
  set{ hints = value; }
 }

 public bool NoSurrender
 {
  get{ return noSurrender; }
  set{ noSurrender = value; }
 }

 public bool PlayHintsOnly
 {
  get{ return playHintsOnly; }
  set{ playHintsOnly = value; }
 }
}

From the listing we can determine that we need to construct an instance of PlayerDefaultOptions and initialize four properties: Hints, NoSurrender, PlayHintsOnly, and the PlayerName. Relative to the XML block we have two child nodes, player and options, and nested in options we have hints, noSurrender, and playHintsOnly. Consequently, we need to implement Create to read the custom section based on its layout. Since we've defined the section, the layout, and the IConfigurationSectionHandler, we can easily put these elements together. Listing 3 show some pretty straightforward, brute-force code that gets the jobs done.

Listing 3 The custom IConfigurationSectionHandler for the playerDefaultOptions block.

#region Using directives

using System;
using System.Collections;
using System.Configuration;
using System.Diagnostics;
using System.Globalization;
using System.Text;
using System.Xml;

#endregion

namespace ConfigSectionHandler
{
 public class MySectionHandler : IConfigurationSectionHandler
 {
  public MySectionHandler(){}


  #region IConfigurationSectionHandler Members

  object IConfigurationSectionHandler.Create(object parent,
   object configContext, XmlNode section)
  {
   try
   {
    // construct the target object
    PlayerDefaultOptions options = new PlayerDefaultOptions();
    // if the section is null return the empty object
    if (section == null) return options;
    //Walk the sections' child nodes, reading the elements
    foreach (XmlNode node in section.ChildNodes)
    {
     if (node.Name == "player")
      ReadPlayer(node, options);
     else if (node.Name == "options")
      ReadOptions(node, options);
    }
    return options;
   }
   catch(Exception ex)
   {
    throw new ConfigurationException(
     "Error loading startup default options", ex, section);
   }
  }

  #endregion

  private void ReadPlayer(XmlNode node, PlayerDefaultOptions options)
  {
   // load the player attributes
   XmlNode currentAttribute =
    node.Attributes.RemoveNamedItem("name");
   if(currentAttribute != null )
    options.PlayerName = currentAttribute.Value;
  }

  private void ReadOptions(XmlNode node, PlayerDefaultOptions options)
  {
   XmlNode currentAttribute = null;
   // walk the options' child nodes
   foreach( XmlNode child in node.ChildNodes )
   {
    currentAttribute = child.Attributes.RemoveNamedItem("value");
    // read the child attributes
    if (currentAttribute == null) continue;
    if (child.Name == "hints")
     options.Hints = (currentAttribute.Value == "On");
    else if (child.Name == "noSurrender")
     options.NoSurrender = (currentAttribute.Value == "On");
    else if (child.Name == "playHintsOnly")
     options.PlayHintsOnly = (currentAttribute.Value == "On");
   }
  }
 }
}

The basic idea is that the section argument to Create contains the XML. The tags are composed of names and attributes; child nodes can be nested in tags. Simply read the XML incrementally and convert the attributes by name to state-data for the object you're constructing. Finally, it must be mentioned that you have to have a reference to the object you're constructing, in this instance PlayerDefaultOptions.

I didn't use the parent and configContext arguments in the example; if you're interested, parent refers to the enclosing parent section and configContext is reserved for future use.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020