ServiceDebugElement Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет элемент конфигурации, в котором указываются сведения о функциях отладки и справки для службы Windows Communication Foundation (WCF). Этот класс не наследуется.
public ref class ServiceDebugElement sealed : System::ServiceModel::Configuration::BehaviorExtensionElement
public sealed class ServiceDebugElement : System.ServiceModel.Configuration.BehaviorExtensionElement
type ServiceDebugElement = class
inherit BehaviorExtensionElement
Public NotInheritable Class ServiceDebugElement
Inherits BehaviorExtensionElement
- Наследование
-
ServiceDebugElement
- Наследование
Примеры
В следующем примере кода показано использование файла конфигурации для включения функций справочной HTML-страницы и возврата информации об исключении в ошибке SOAP клиенту в целях отладки (помимо включения функции поддержки метаданных).
<configuration>
<system.serviceModel>
<services>
<!--
Step 1. Add a behaviorConfiguration attribute
in the <service> element.
-->
<service
name="Microsoft.WCF.Documentation.SampleService"
behaviorConfiguration="metadataAndDebug">
<host>
<baseAddresses>
<add baseAddress="http://localhost:8080/SampleService" />
</baseAddresses>
</host>
<endpoint
address=""
binding="wsHttpBinding"
contract="Microsoft.WCF.Documentation.ISampleService"
/>
<endpoint
address="mex"
binding="mexHttpBinding"
contract="IMetadataExchange"
/>
</service>
</services>
<behaviors>
<serviceBehaviors>
<!--
Step 2. Inside a <serviceBehaviors> section, add
a name attribute in the <behaviors> element that
matches the behaviorConfiguration attribute in the
<service> element above.
-->
<behavior name="metadataAndDebug">
<serviceMetadata
httpGetEnabled="true"
httpGetUrl=""
/>
<!--
Step 3. Add a <serviceDebug> element and
modify the various attributes that suit your
scenario.
-->
<serviceDebug
httpHelpPageEnabled="true"
includeExceptionDetailInFaults="true"
/>
</behavior>
</serviceBehaviors>
</behaviors>
</system.serviceModel>
</configuration>
Комментарии
Если свойству IncludeExceptionDetailInFaults программно присвоить значение true
, это позволит передавать клиенту сведения о потоке управляемого исключения с целью отладки, а также публиковать HTML-файлы со сведениями для пользователей, работающих со службой в веб-браузерах.
Внимание!
Возврат службам сведений об управляемых исключениях может представлять риск с точки зрения безопасности. Это связано с тем, что подробные сведения от исключениях включают сведения о внутренней реализации службы, которые могут использоваться несанкционированными службами.
Свойства HttpHelpPageEnabled и HttpsHelpPageEnabled отправляют службе инструкции по публикации HTML-файлов справки, если просмотр службы осуществляется с помощью HTML-браузера.
Свойства HttpHelpPageUrl и HttpsHelpPageUrl задают расположение просматриваемой справочной HTML-страницы.
Включение и отключение возможностей ServiceDebugElement с помощью файла конфигурации:
behaviorConfiguration
Добавьте атрибут в <элемент службы> WCF. (Поведение конечной точки настраивается для<endpoint>
элементов; поведение службы для <элементов службы> .)Добавьте или создайте <раздел serviceBehaviors> и добавьте <в нее элемент поведения> с именем, соответствующим значению
behaviorConfiguration
атрибута из шага 1. (Поведение конечной <точки настраивается с помощью элемента endpointBehaviors> ; поведение службы настраивается с помощью <элемента serviceBehaviors> .Добавьте элемент serviceDebug> в элемент behavior из шага 2 и включите или отключите различные свойства, соответствующие вашему сценарию.<><
Конкретный пример см. в разделе «Пример».
Конструкторы
ServiceDebugElement() |
Инициализирует новый экземпляр класса ServiceDebugElement. |
Свойства
BehaviorType |
Возвращает тип этого элемента поведения. |
ConfigurationElementName |
Возвращает имя этого элемента конфигурации. (Унаследовано от ServiceModelExtensionElement) |
CurrentConfiguration |
Возвращает ссылку на экземпляр Configuration верхнего уровня, представляющий иерархию конфигурации, к которой относится текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement) |
ElementInformation |
Возвращает объект ElementInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
ElementProperty |
Возвращает объект ConfigurationElementProperty, представляющий сам объект ConfigurationElement. (Унаследовано от ConfigurationElement) |
EvaluationContext |
Возвращает объект ContextInformation для объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
HasContext |
Возвращает значение, указывающее, имеет ли свойство CurrentConfiguration значение |
HttpHelpPageBinding |
Возвращает или задает строковое значение, определяющее привязку, которая будет использоваться в тех случаях, когда для обращения к странице справки службы будет использоваться протокол HTTP. |
HttpHelpPageBindingConfiguration |
Возвращает или задает строку, указывающую на раздел XML с дополнительными сведениями о конфигурации привязки, заданными в свойстве HttpHelpPageBinding. |
HttpHelpPageEnabled |
Возвращает или задает значение, указывающее, публикует ли служба Windows Communication Foundation (WCF) справочную HTML-страницу по адресу, указанному в свойстве HttpHelpPageUrl. |
HttpHelpPageUrl |
Возвращает или задает путь для публикации файлов справочной HTML-страницы. |
HttpsHelpPageBinding |
Возвращает или задает строковое значение, определяющее привязку, которая будет использоваться в тех случаях, когда для обращения к странице справки службы будет использоваться протокол HTTPS. |
HttpsHelpPageBindingConfiguration |
Возвращает или задает строку, указывающую на раздел XML с дополнительными сведениями о конфигурации привязки, заданными в свойстве HttpsHelpPageBinding. |
HttpsHelpPageEnabled |
Возвращает или задает значение, указывающее, возвращает ли служба Windows Communication Foundation (WCF) HTML-файл справки по протоколу HTTPS по адресу, указанному в свойстве HttpsHelpPageUrl. |
HttpsHelpPageUrl |
Получает или задает путь публикации файлов справки HTML для получения с помощью HTTPS. |
IncludeExceptionDetailInFaults |
Получает или задает значение, которое определяет, включать ли информацию по управляемым исключениям в подробную информацию об ошибках SOAP, которая возвращается клиенту для отладки. |
Item[ConfigurationProperty] |
Возвращает или задает свойство или атрибут данного элемента конфигурации. (Унаследовано от ConfigurationElement) |
Item[String] |
Получает или задает свойство, атрибут или дочерний элемент данного элемента конфигурации. (Унаследовано от ConfigurationElement) |
LockAllAttributesExcept |
Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement) |
LockAllElementsExcept |
Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement) |
LockAttributes |
Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement) |
LockElements |
Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement) |
LockItem |
Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement) |
Properties |
Возвращает коллекцию свойств. (Унаследовано от ConfigurationElement) |
Методы
CopyFrom(ServiceModelExtensionElement) |
Копирует содержимое указанного элемента конфигурации в данный элемент конфигурации. |
CreateBehavior() |
Создает расширение поведения на основе текущих параметров конфигурации. (Унаследовано от BehaviorExtensionElement) |
DeserializeElement(XmlReader, Boolean) |
Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement) |
Equals(Object) |
Сравнивает текущий экземпляр ConfigurationElement с указанным объектом. (Унаследовано от ConfigurationElement) |
GetHashCode() |
Получает уникальное значение, представляющее текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement) |
GetTransformedAssemblyString(String) |
Возвращает преобразованную версию указанного имени сборки. (Унаследовано от ConfigurationElement) |
GetTransformedTypeString(String) |
Возвращает преобразованную версию указанного имени типа. (Унаследовано от ConfigurationElement) |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
Init() |
Задает объект ConfigurationElement в исходное состояние. (Унаследовано от ConfigurationElement) |
InitializeDefault() |
Используется для инициализации набора значений по умолчанию для объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
IsModified() |
Возвращает значение, определяющее, был ли изменен данный элемент конфигурации. (Унаследовано от ServiceModelExtensionElement) |
IsReadOnly() |
Получает значение, показывающее, является ли объект ConfigurationElement доступным только для чтения. (Унаследовано от ConfigurationElement) |
ListErrors(IList) |
Добавляет ошибку "недействительное свойство" в данном объекте ConfigurationElement и всех его дочерних элементах к переданному списку. (Унаследовано от ConfigurationElement) |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
OnDeserializeUnrecognizedAttribute(String, String) |
Возвращает значение, указывающее, встретился ли неизвестный атрибут при десериализации. (Унаследовано от ConfigurationElement) |
OnDeserializeUnrecognizedElement(String, XmlReader) |
Возвращает значение, указывающее, встретился ли неизвестный элемент при десериализации. (Унаследовано от ConfigurationElement) |
OnRequiredPropertyNotFound(String) |
Выдает исключение, если требуемое свойство не найдено. (Унаследовано от ConfigurationElement) |
PostDeserialize() |
Вызывается после десериализации. (Унаследовано от ConfigurationElement) |
PreSerialize(XmlWriter) |
Вызывается до сериализации. (Унаследовано от ConfigurationElement) |
Reset(ConfigurationElement) |
Восстанавливает внутреннее состояние данного объекта элемента конфигурации, включая блокировки и коллекции свойств. (Унаследовано от ServiceModelExtensionElement) |
ResetModified() |
Переустанавливает значение метода IsModified() в |
SerializeElement(XmlWriter, Boolean) |
Записывает содержимое данного элемента конфигурации в файл конфигурации. (Унаследовано от ServiceModelExtensionElement) |
SerializeToXmlElement(XmlWriter, String) |
Записывает внешние теги данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement) |
SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Задает для свойства указанное значение. (Унаследовано от ConfigurationElement) |
SetPropertyValueIfNotDefaultValue<T>(String, T) |
Задает значение свойства для элемента конфигурации, если значение не является значением по умолчанию. (Унаследовано от ServiceModelConfigurationElement) |
SetReadOnly() |
Задает свойство IsReadOnly() для объекта ConfigurationElement и всех подчиненных элементов. (Унаследовано от ConfigurationElement) |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Изменяет объект ConfigurationElement для удаления всех значений, которые не должны сохраняться. (Унаследовано от ConfigurationElement) |