MessageProtectionRequirements.Protect Method

Enforces the protection requirements on a SOAP message.

Namespace: Microsoft.Web.Services3.Design
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim envelope As SoapEnvelope
Dim security As Security
Dim signingToken As SecurityToken
Dim encryptingToken As SecurityToken
Dim requireDerivedKey As Boolean
Dim messageProtectionOrder As MessageProtectionOrder
Dim requireSignatureConfirmation As Boolean
Dim endorsedTokens As IEnumerable
Dim attachedTokens As IEnumerable
Dim basicAttachedToken As SecurityToken
Dim messageProtectionRequirements1 As MessageProtectionRequirements
messageProtectionRequirements1.Protect(envelope, security, signingToken, encryptingToken, requireDerivedKey, messageProtectionOrder, requireSignatureConfirmation, endorsedTokens, attachedTokens, basicAttachedToken)

Syntax

'Declaration
Public Sub Protect( _
    ByVal envelope As SoapEnvelope, _
    ByVal security As Security, _
    ByVal signingToken As SecurityToken, _
    ByVal encryptingToken As SecurityToken, _
    ByVal requireDerivedKey As Boolean, _
    ByVal messageProtectionOrder As MessageProtectionOrder, _
    ByVal requireSignatureConfirmation As Boolean, _
    ByVal endorsedTokens As IEnumerable(Of SecurityToken), _
    ByVal attachedTokens As IEnumerable(Of SecurityToken), _
    ByVal basicAttachedToken As SecurityToken _
)

public void Protect(
    SoapEnvelope envelope, 
    Security security, 
    SecurityToken signingToken, 
    SecurityToken encryptingToken, 
    bool requireDerivedKey, 
    MessageProtectionOrder messageProtectionOrder, 
    bool requireSignatureConfirmation, 
    IEnumerable<SecurityToken> endorsedTokens, 
    IEnumerable<SecurityToken> attachedTokens, 
    SecurityToken basicAttachedToken
);

public:
void Protect(
    SoapEnvelope^ envelope,
    Security^ security,
    SecurityToken^ signingToken,
    SecurityToken^ encryptingToken,
    bool requireDerivedKey,
    MessageProtectionOrder messageProtectionOrder,
    bool requireSignatureConfirmation,
    IEnumerable<SecurityToken^>^ endorsedTokens,
    IEnumerable<SecurityToken^>^ attachedTokens,
    SecurityToken^ basicAttachedToken
);

public void Protect(
    SoapEnvelope envelope, 
    Security security, 
    SecurityToken signingToken, 
    SecurityToken encryptingToken, 
    boolean requireDerivedKey, 
    MessageProtectionOrder messageProtectionOrder, 
    boolean requireSignatureConfirmation, 
    IEnumerable<SecurityToken> endorsedTokens, 
    IEnumerable<SecurityToken> attachedTokens, 
    SecurityToken basicAttachedToken
);

In JScript, you cannot declare this method.

Parameters

• envelope
  A SoapEnvelope that represents the SOAP message.

• security
  A Security that represents the Security SOAP header.

• signingToken
  A SecurityToken security token to digitally sign the SOAP message and any security tokens in attachedTokens. This process creates the SOAP message signature.

• encryptingToken
  A SecurityToken security token to encrypt the SOAP message.

• requireDerivedKey
  true to use DerivedKeyToken security tokens; otherwise, false.

• messageProtectionOrder
  A MessageProtectionOrder that specifies the order of operation for digital signatures and message encryption.

• requireSignatureConfirmation
  true to have a Web service send a confirmation that verifies the client's digital signature and to have the client reject SOAP responses without a signature confirmation; otherwise, false.

• endorsedTokens
  A System.Collections.Generic.IEnumerable of type SecurityToken that contains the security tokens that digitally sign the SOAP message signature.

• attachedTokens
  A System.Collections.Generic.IEnumerable of type SecurityToken that contains the security tokens that are digitally signed by signingToken in the process of creating the SOAP message signature.

• basicAttachedToken
  A SecurityToken security token that is digitally signed by the signingToken security token and encrypted by the encryptingToken security token.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

See Also

Reference

MessageProtectionRequirements Class
MessageProtectionRequirements Members
Microsoft.Web.Services3.Design Namespace