Tools/ManagedExtensions/ManagementExtensions/MRegistry.cs

   1 // Copyright 2003-2004 DigitalCraftsmen - http://www.digitalcraftsmen.com.br/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.ManagementExtensions
  16 {
  17         using System;
  18
  19         /// <summary>
  20         /// Summary description for MRegistry.
  21         /// </summary>
  22         public interface MRegistry
  23         {
  24                 /// <summary>
  25                 /// Registers the specified managed object instance.
  26                 /// </summary>
  27                 /// <param name="instance"></param>
  28                 /// <param name="name"></param>
  29                 /// <returns></returns>
  30                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  31                 ManagedInstance RegisterManagedObject(Object instance, ManagedObjectName name);
  32
  33                 /// <summary>
  34                 /// Returns a <see cref="ManagedInstance"/> representing
  35                 /// a managed object instance.
  36                 /// </summary>
  37                 /// <param name="name"></param>
  38                 /// <returns></returns>
  39                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  40                 ManagedInstance GetManagedInstance(ManagedObjectName name);
  41
  42                 /// <summary>
  43                 /// Unregister a managed object from the domain.
  44                 /// </summary>
  45                 /// <param name="name"></param>
  46                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  47                 void UnregisterManagedObject(ManagedObjectName name);
  48
  49                 bool Contains(ManagedObjectName name);
  50
  51                 int Count
  52                 {
  53                         get;
  54                 }
  55
  56                 Object this [ManagedObjectName name]
  57                 {
  58                         get;
  59                 }
  60
  61                 /// <summary>
  62                 /// Invokes an action in managed object
  63                 /// </summary>
  64                 /// <param name="name"></param>
  65                 /// <param name="action"></param>
  66                 /// <param name="args"></param>
  67                 /// <param name="signature"></param>
  68                 /// <returns></returns>
  69                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  70                 Object Invoke(ManagedObjectName name, String action, Object[] args, Type[] signature);
  71
  72                 /// <summary>
  73                 /// Returns the info (attributes and operations) about the specified object.
  74                 /// </summary>
  75                 /// <param name="name"></param>
  76                 /// <returns></returns>
  77                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  78                 ManagementInfo GetManagementInfo(ManagedObjectName name);
  79
  80                 /// <summary>
  81                 /// Gets an attribute value of the specified managed object.
  82                 /// </summary>
  83                 /// <param name="name"></param>
  84                 /// <param name="attributeName"></param>
  85                 /// <returns></returns>
  86                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  87                 Object GetAttributeValue(ManagedObjectName name, String attributeName);
  88
  89                 /// <summary>
  90                 /// Sets an attribute value of the specified managed object.
  91                 /// </summary>
  92                 /// <param name="name"></param>
  93                 /// <param name="attributeName"></param>
  94                 /// <param name="attributeValue"></param>
  95                 /// <exception cref="InvalidDomainException">If domain name is not found.</exception>
  96                 void SetAttributeValue(ManagedObjectName name, String attributeName, Object attributeValue);
  97
  98                 /// <summary>
  99                 /// Returns an array of registered domains.
 100                 /// </summary>
 101                 /// <returns>a list of domains</returns>
 102                 String[] GetDomains();
 103
 104                 /// <summary>
 105                 /// Queries the registerd components.
 106                 /// </summary>
 107                 /// <returns></returns>
 108                 ManagedObjectName[] Query(ManagedObjectName query);
 109         }
 110 }