MessageHeaderAttribute Klas

Definitie

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

Overname

Object

Attribute

MessageContractMemberAttribute

MessageHeaderAttribute

Afgeleid

System.ServiceModel.MessageHeaderArrayAttribute

System.ServiceModel.PeerHopCountAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

Het volgende codevoorbeeld toont het gebruik van het MessageHeaderAttribute maken van een SOAP-header voor het antwoordbericht met de NameNamespaceMustUnderstand eigenschappen die zijn ingesteld op waarden die geschikt zijn voor deze header. Het codevoorbeeld wordt gevolgd door een voorbeeld van het bericht wanneer het wordt verzonden.

 [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

Opmerkingen

Met MessageHeaderAttribute het kenmerk kunt u velden en eigenschappen toewijzen van een type dat is gemarkeerd met het MessageContractAttribute kenmerk voor SOAP-berichtkoppen. Het veld of de eigenschap kan van een eenvoudig type of een samengesteld type zijn dat kan worden geserialiseerd.

Zie voor informatie over het beheren van de serialisatie van de inhoud van een SOAP-hoofdtekst zonder de standaard SOAP-envelop zelf te wijzigen, System.Runtime.Serialization.DataContractAttributegegevensoverdracht in servicecontracten en het gebruik van gegevenscontracten.

Zie Berichtcontracten gebruiken voor meer informatie over het maken van berichtcontracten.

De SOAP-standaard definieert de volgende kenmerken die op een header kunnen bestaan:

• Actor of Role (Actor in SOAP 1.1, Role in SOAP 1.2)

• MustUnderstand

• Relay

Het Actor of Role kenmerk geeft de URI op van het knooppunt waarvoor een bepaalde header is bedoeld. Het MustUnderstand kenmerk geeft aan of de header de verwerking van het knooppunt begrijpt. Het Relay kenmerk geeft aan of de header moet worden doorgestuurd naar downstreamknooppunten. Windows Communication Foundation (WCF) voert geen verwerking van deze kenmerken uit op binnenkomende berichten, met uitzondering van het kenmerk MustUnderstand.

U kunt deze kenmerken echter wel lezen en schrijven, ook al worden ze niet standaard verzonden. U kunt de kenmerkwaarden op twee manieren instellen. Eerst kunt u de Actor, MustUnderstand en Relay eigenschappen op de MessageHeaderAttribute. (Er is geen Role eigenschap: stel de Actor eigenschap in en Role wordt doorgegeven als SOAP 1.2 wordt gebruikt). Voorbeeld:

De tweede manier om deze kenmerken te beheren, is door het gewenste headertype de typeparameter van de MessageHeader<T> klasse te maken en het resulterende type samen met de MessageHeaderAttribute. Gebruik vervolgens de MessageHeader<T> eigenschappen programmatisch om de SOAP-kenmerken in te stellen. Voorbeeld:

Als zowel de dynamische als de statische besturingsmechanismen worden gebruikt, zijn de statische instellingen de standaardinstelling, maar kunnen ze worden overschreven met behulp van het dynamische mechanisme. Voorbeeld:

Het maken van herhaalde headers met dynamisch kenmerkbeheer is toegestaan. Voorbeeld:

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

Aan de ontvangstzijde kunnen deze SOAP-kenmerken alleen worden gelezen als de algemene MessageHeader<T> klasse wordt gebruikt. Bekijk de Actorof RelayMustUnderstand eigenschappen van een header van het MessageHeader<T> type om de kenmerkinstellingen voor het ontvangen bericht te detecteren.

Wanneer een bericht wordt ontvangen en vervolgens teruggestuurd, worden de SOAP-kenmerkinstellingen alleen roundtrip voor kopteksten van het MessageHeader<T> type.