C＃：添加新属性后，嵌套的自定义配置不起作用

Question

I have my very nested custom configuration implementation working until I wanted to add a new attribute to one of the nested config element collection. Here is my working config:

<exchange name="myexchange">
  <queue name="myqueue">
    <process>
      <sources>
        <http url="[myUrl]/srcurl1" method="get" name="srcurl1" />
        <http url="[myUrl]/srcurl2" method="get" name="srcurl2" />
      </sources>
      <destinations>
        <http url="[intUrl]/someurl1" method="POST" name="someurl1" />
        <http url="[intUrl]/someurl2" method="POST" name="someurl2" />
      </destinations>
    </process>
  </queue>
</exchange>

I am trying to add isactive attribute to <destinations> config element collection but I get an exception Unrecognized attribute 'isactive'. Note that attribute names are case-sensitive. Unrecognized attribute 'isactive'. Note that attribute names are case-sensitive. . This what I am trying to do:

<destinations isactive="true">
  <http url="[intUrl]/someurl1" method="POST" name="someurl1" />
  <http url="[intUrl]/someurl2" method="POST" name="someurl2" />
</destinations>

Here is my working code before adding the new attribute.

public class ProcessConfigElement : ConfigurationElement
{
    [ConfigurationProperty("sources", IsDefaultCollection = false)]
    public HttpConfigElementCollection Sources
    {
        get { return (HttpConfigElementCollection)base["sources"]; }

    }

    [ConfigurationProperty("destinations", IsDefaultCollection = false)]
    public HttpConfigElementCollection Destinations
    {
        get { return (HttpConfigElementCollection)base["destinations"]; }

    }
}

public class HttpConfigElementCollection : ConfigurationElementCollection, IEnumerable<HttpConfigElement>
{
    public new HttpConfigElement this[string name]
    {
        get
        {
            if (IndexOf(name) < 0) return null;

            return (HttpConfigElement)BaseGet(name);
        }
    }

    public HttpConfigElement this[int index]
    {
        get { return (HttpConfigElement)BaseGet(index); }
    }

    public int IndexOf(string name)
    {
        name = name.ToLower();

        for (int idx = 0; idx < base.Count; idx++)
        {
            if (this[idx].Name.ToLower() == name)
                return idx;
        }
        return -1;
    }

    public override ConfigurationElementCollectionType CollectionType
    {
        get { return ConfigurationElementCollectionType.BasicMap; }
    }

    protected override ConfigurationElement CreateNewElement()
    {
        return new HttpConfigElement();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((HttpConfigElement)element).Name;
    }

    protected override string ElementName
    {
        get { return "http"; }
    }

    public new IEnumerator<HttpConfigElement> GetEnumerator()
    {
        return this.OfType<HttpConfigElement>().GetEnumerator();
    }
}

public class HttpConfigElement : ConfigurationElement
{
    [ConfigurationProperty("url", IsRequired = true, DefaultValue = "")]
    public string Url
    {
        get { return (string)this["url"]; }
        set { this["url"] = value; }
    }

    [ConfigurationProperty("method", IsRequired = true, DefaultValue = "")]
    public string Method
    {
        get { return (string)this["method"]; }
        set { this["method"] = value; }
    }        

    [ConfigurationProperty("name", IsRequired = true, IsKey = true, DefaultValue = "")]
    public string Name
    {
        get { return (string)this["name"]; }
        set { this["name"] = value; }
    }
}

To add 'isactive' attribute. I changed the config entry to: <destinations isactive="true"> and thought I need to change the ProcessConfigElement class to use new collection:

[ConfigurationProperty("destinations", IsDefaultCollection = false)]
public DestinationConfigElementCollection Destinations
{
    get { return (DestinationConfigElementCollection)base["destinations"]; }

}

...and my collection and element classes look like:

public class DestinationConfigElementCollection : ConfigurationElementCollection, IEnumerable<DestinationConfigElement>
{
    public DestinationConfigElementCollection()
    {
        DestinationConfigElement destinationConfigElement = (DestinationConfigElement)CreateNewElement();
        if (destinationConfigElement.IsActive != "")
        {
            Add(destinationConfigElement);
        }
    }

    public override ConfigurationElementCollectionType CollectionType
    {
        get
        {
            return ConfigurationElementCollectionType.BasicMap;
        }
    }

    protected override ConfigurationElement CreateNewElement()
    {
        return new DestinationConfigElement();
    }

    protected override object GetElementKey(ConfigurationElement element)
    {
        return ((DestinationConfigElement)element).IsActive;
    }

    public DestinationConfigElement this[int index]
    {
        get
        {
            return (DestinationConfigElement)BaseGet(index);
        }
        set
        {
            if (BaseGet(index) != null)
            {
                BaseRemoveAt(index);
            }
            BaseAdd(index, value);
        }
    }

    new public DestinationConfigElement this[string name]
    {
        get
        {
            return (DestinationConfigElement)BaseGet(name);
        }
    }

    public int IndexOf(DestinationConfigElement destinationConfigElement)
    {
        return BaseIndexOf(destinationConfigElement);
    }

    public void Add(DestinationConfigElement destinationConfigElement)
    {
        BaseAdd(destinationConfigElement);
    }

    protected override void BaseAdd(ConfigurationElement element)
    {
        BaseAdd(element, false);
    }

    public void Remove(DestinationConfigElement destinationConfigElement)
    {
        if (BaseIndexOf(destinationConfigElement) >= 0)
            BaseRemove(destinationConfigElement.IsActive);
    }

    public void RemoveAt(int index)
    {
        BaseRemoveAt(index);
    }

    public void Remove(string name)
    {
        BaseRemove(name);
    }

    public void Clear()
    {
        BaseClear();
    }

    protected override string ElementName
    {
        get { return "destination"; }
    }

    public new IEnumerator<DestinationConfigElement> GetEnumerator()
    {
        return this.OfType<DestinationConfigElement>().GetEnumerator();
    }
}

public class DestinationConfigElement : ConfigurationElement
{
    [ConfigurationProperty("isactive", IsRequired = false, IsKey = false, DefaultValue = "")]
    public string IsActive
    {
        get { return (string)this["isactive"]; }
        set { this["isactive"] = value; }
    }

    [ConfigurationProperty("https", IsDefaultCollection = false)]
    public HttpConfigElementCollection Https
    {
        get { return (HttpConfigElementCollection)base["https"]; }

    }
}

This didn't work. I also tried to change the config to:

<destinations isactive="true">
    <https>
      <http url="[intUrl]/someurl1" method="POST" name="someurl1" />
      <http url="[intUrl]/someurl2" method="POST" name="someurl2" />
    </https>
</destinations>

Answer 1

I was able to solve this issue now. I thought it would be a good idea to share it here so that if I or anyone want to come back to this in future.

The issue was in my ProcessConfigElement class where I was using a collection for destinations . Changed it to use the element made it work.

public class ProcessConfigElement : ConfigurationElement
{
    [ConfigurationProperty("sources", IsDefaultCollection = false)]
    public HttpConfigElementCollection Sources
    {
        get { return (HttpConfigElementCollection)base["sources"]; }

    }

    [ConfigurationProperty("destinations", IsDefaultCollection = false)]
    public DestinationConfigElement Destinations
    {
        get { return (DestinationConfigElement)base["destinations"]; }

    }
}

... also I read it's a good idea to structure your config where you have a collection and then elements with in. So I added another level of nesting with Endpoint with in destinations .

public class DestinationConfigElement : ConfigurationElement
{
    [ConfigurationProperty("isactive", IsRequired = false, IsKey = false, DefaultValue = "")]
    public string IsActive
    {
        get { return (string)this["isactive"]; }
        set { this["isactive"] = value; }
    }

    [ConfigurationProperty("endpoints", IsDefaultCollection = false)]
    public HttpConfigElementCollection Endpoints
    {
        get { return (HttpConfigElementCollection)base["endpoints"]; }

    }
}