MessageHeaderAttribute Класс

Определение

public ref class MessageHeaderAttribute : System::ServiceModel::MessageContractMemberAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public class MessageHeaderAttribute : System.ServiceModel.MessageContractMemberAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type MessageHeaderAttribute = class
    inherit MessageContractMemberAttribute

Public Class MessageHeaderAttribute
Inherits MessageContractMemberAttribute

Наследование

Object

Attribute

MessageContractMemberAttribute

MessageHeaderAttribute

Производный

System.ServiceModel.MessageHeaderArrayAttribute

System.ServiceModel.PeerHopCountAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода показано использование заголовка MessageHeaderAttribute SOAP для сообщения ответа, NameNamespace а MustUnderstand свойства, заданные для значений этого заголовка. За примером кода следует пример сообщения при отправке.

 [MessageContract]
 public class HelloResponseMessage
 {
   private string localResponse = String.Empty;
   private string extra = String.Empty;

   [MessageBodyMember(
     Name = "ResponseToGreeting",
     Namespace = "http://www.examples.com")]
   public string Response
   {
     get { return localResponse; }
     set { localResponse = value; }
   }

   [MessageHeader(
     Name = "OutOfBandData",
     Namespace = "http://www.examples.com",
     MustUnderstand=true
   )]
   public string ExtraValues
   {
     get { return extra; }
     set { this.extra = value; }
  }

  /*
   The following is the response message, edited for clarity.

   <s:Envelope>
     <s:Header>
       <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
       <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
     </s:Header>
     <s:Body>
       <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
         <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
       </HelloResponseMessage>
     </s:Body>
   </s:Envelope>
   */
}

  <MessageContract> _
  Public Class HelloResponseMessage
    Private localResponse As String = String.Empty
    Private extra As String = String.Empty

    <MessageBodyMember(Name := "ResponseToGreeting", Namespace := "http://www.examples.com")> _
    Public Property Response() As String
      Get
          Return localResponse
      End Get
      Set(ByVal value As String)
          localResponse = value
      End Set
    End Property

    <MessageHeader(Name := "OutOfBandData", Namespace := "http://www.examples.com", MustUnderstand:=True)> _
    Public Property ExtraValues() As String
      Get
          Return extra
      End Get
      Set(ByVal value As String)
          Me.extra = value
      End Set
    End Property

'   
'    The following is the response message, edited for clarity.
'    
'    <s:Envelope>
'      <s:Header>
'        <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
'        <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
'      </s:Header>
'      <s:Body>
'        <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
'          <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
'      </s:Body>    
'    </s:Envelope>
'    
  End Class

Комментарии

Атрибут MessageHeaderAttribute позволяет сопоставлять поля и свойства типа, помеченного атрибутом с MessageContractAttribute заголовками сообщений SOAP. Поле или свойство может быть простым типом или составным типом, который можно сериализовать.

Сведения о том, как управлять сериализацией содержимого тела SOAP без изменения самого конверта SOAP по умолчанию, см. в разделе System.Runtime.Serialization.DataContractAttribute" Указание передачи данных в контрактах служб" и "Использование контрактов данных".

Дополнительные сведения о создании контрактов сообщений см. в разделе "Использование контрактов сообщений".

Стандарт SOAP определяет следующие атрибуты, которые могут существовать в заголовке:

• Actor или Role (Actor в SOAP 1.1 в Role SOAP 1.2)

• MustUnderstand

• Relay

Role Или Actor атрибут задает универсальный код ресурса (URI) узла, для которого предназначен заданный заголовок. Атрибут MustUnderstand указывает, понимает ли заголовок обработку узла. Атрибут Relay указывает, надо ли передавать заголовок на нижележащие узлы. Windows Communication Foundation (WCF) не выполняет обработку этих атрибутов в входящих сообщениях, за исключением атрибута MustUnderstand .

Однако эти атрибуты можно читать и записывать, даже если они не отправляются по умолчанию. Значения атрибутов можно задать двумя способами. Во-первых, вы можете изменить ActorMustUnderstand свойства и Relay свойства в элементе MessageHeaderAttribute. (Нет Role свойства— задать Actor свойство и Role передается, если используется SOAP 1.2). Рассмотрим пример.

Второй способ управления этими атрибутами — сделать нужный тип заголовка параметром MessageHeader<T> типа класса и использовать результирующий тип вместе с MessageHeaderAttributeним. Затем используйте MessageHeader<T> свойства программным способом, чтобы задать атрибуты SOAP. Рассмотрим пример.

Если используются динамические и статические механизмы управления, статические параметры являются значениями по умолчанию, но их можно переопределить с помощью динамического механизма. Рассмотрим пример.

Допускается создание повторяющихся заголовков с помощью динамического элемента управления атрибутами. Рассмотрим пример.

[MessageHeaderArray] public MessageHeader<Person> documentApprovers[];

На принимающей стороне чтение этих атрибутов SOAP может выполняться только в том случае, если используется универсальный MessageHeader<T> класс. Actor Relay Проверьте или MustUnderstand свойства заголовка MessageHeader<T> типа, чтобы обнаружить параметры атрибута в полученном сообщении.

Когда сообщение получено, а затем отправляется обратно, атрибут SOAP задает только круглые запросы для заголовков MessageHeader<T> типа.