WCF: is there an attribute to make parameters in the OperationContract required?

Question

I use [DataMember(IsRequired=true)] to make the DataContract properties required. There doesn't seem to be some IsRequired for the OperationContract parameters. How do I make them required and not allow null?

The parameter in of OperationContract appears to be optional in SoapUI tool. Though this must never be optional or null.

WCF Interface:

[OperationContract]
IsClientUpdateRequiredResult IsClientUpdateRequired(IsClientUpdateRequiredInput versie);

...

[DataContract]
public class IsClientUpdateRequiredInput
{
    [DataMember(IsRequired=true)]
    public string clientName { get; set; }
    [DataMember(IsRequired = true, Order = 0)]
    public int major { get; set; }
    [DataMember(IsRequired = true, Order = 1)]
    public int minor { get; set; }
    [DataMember(IsRequired = true, Order = 2)]
    public int build { get; set; }
    [DataMember(IsRequired = true, Order = 3)]
    public int revision { get; set; }
}

soapUI request template:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:tem="http://tempuri.org/" xmlns:pir="http://schemas.datacontract.org/2004/07/PirIS.Web.WCF.InputClasses">
   <soap:Header/>
   <soap:Body>
      <tem:IsClientUpdateRequired>
         <!--Optional:-->
         <tem:versie>
            <pir:clientName>?</pir:clientName>
            <pir:major>?</pir:major>
            <pir:minor>?</pir:minor>
            <pir:build>?</pir:build>
            <pir:revision>?</pir:revision>
         </tem:versie>
      </tem:IsClientUpdateRequired>
   </soap:Body>
</soap:Envelope>

score 4 · Accepted Answer · edited May 23 '17 at 12:09

4

Unfortunately it can't be done using default WCF. There exist a few workarounds:

A custom RequiredParametersBehavior attribute
Using the Validation Application Block from the Enterprise Library and associate a ruleset to your method

You can however implement a FaultContract and throw a fault when the input parameter is null.

edited May 23 '17 at 12:09

Community

1
1

answered Oct 11 '12 at 11:28

CodeCaster

147,647
23
218
272

1

Thanks. Just wish MS had taken care of this in WCF. – Dieko Oct 11 '12 at 12:59

score 1 · Answer 2 · answered Oct 11 '12 at 11:27

1

No. Just like any regular method, you'll need to check whether reference type parameters have a value or are null.

Just apply your normal defensive programming patterns, checking reference types before accessing their properties.

answered Oct 11 '12 at 11:27

Kirk Broadhurst

27,836
16
104
169

True. Always expect the unexpected. – Dieko Oct 11 '12 at 13:00

WCF: is there an attribute to make parameters in the OperationContract required?

2 Answers2

Linked

Related