Can I change the default '/soap11' route for the SOAP endpoint on a ServiceStack implementation

Question

I know I can manage the routes for the REST-ful interface operations by attributing the DTOs

[Route("/widgets", "GET, POST")]
[DataContract()]
public class GetWidgetsRequest
{
    [DataMember]
    public string OutletCode { get; set; }
    [DataMember]
    public IList<Specification> WidgetsCaptured { get; set; }
}

but I have searched and experimented unsuccessfully at trying to affect the default /soap11 appendage to the endpoint for a given SOAP operation.

**POST /soap11 HTTP/1.1**
Host: localhost    
Content-Type: text/xml; charset=utf-8
Content-Length: nnn
SOAPAction: GetItemsRequest

A broader question within the question is, what are my options and how to configure the different endpoint settings?

Thanks!

Answer 1

For a different SOAP path, eg ~/services, you can add your own servicestack plugin , that returns your own servicestack soap handler.

public class MySoapFeature : IPlugin 
{
    private static IHttpHandler GetHandlerForPathParts(string[] pathParts)
    {
        string str2 = string.Intern(pathParts[0].ToLower());
        if (pathParts.Length != 1) return null;
        if (str2 == "services")
        {
            return new MySoapHttpHandler();
        }

        return null;
    }

    public IHttpHandler ProcessRequest(string httpMethod, string pathInfo, string filePath)
    {
        char[] chrArray = new char[] { '/' };
        string[] strArrays = pathInfo.TrimStart(chrArray).Split(new char[] { '/' });
        if ((int)strArrays.Length == 0)
        {
            return null;
        }

        return MySoapFeature.GetHandlerForPathParts(strArrays);
    }

    public void Register(IAppHost appHost)
    {
        appHost.CatchAllHandlers.Add(this.ProcessRequest);
    }
}

Then implement this handler based on Soap11Handler or Soap12Handler

    public class MySoapHttpHandler : Soap11Handler, IHttpHandler
{
    public MySoapHttpHandler()
        : base((EndpointAttributes)((long)32768))
    {
    }

    public new void ProcessRequest(HttpContext context)
    {
        if (context.Request.HttpMethod == "GET")
        {
            (new Soap11WsdlMetadataHandler()).Execute(context);
            return;
        }

        Message message = base.Send(null);
        context.Response.ContentType = base.GetSoapContentType(context.Request.ContentType);
        using (XmlWriter xmlWriter = XmlWriter.Create(context.Response.OutputStream))
        {
            message.WriteMessage(xmlWriter);
        }
    }


    public override void ProcessRequest(IHttpRequest httpReq, IHttpResponse httpRes, string operationName)
    {
        if (httpReq.HttpMethod == "GET")
        {
            (new Soap11WsdlMetadataHandler()).Execute(httpReq, httpRes);
            return;
        }

        Message message = base.Send(null, httpReq, httpRes);
        httpRes.ContentType = base.GetSoapContentType(httpReq.ContentType);
        using (XmlWriter xmlWriter = XmlWriter.Create(httpRes.OutputStream))
        {
            message.WriteMessage(xmlWriter);
        }
    }

Then register your plugin in the servicestack apphost Configure()

Plugins.Add(new MySoapFeature());

Then create your Dto classes for the request and response. Have "Response" added to the response dto class name. Do NOT put a Route attribute on the request Dto, as it gets routed by the Soap method name in the Xml.

[DataContract(Namespace = "http://mynamespace/schemas/blah/1.0")]
public class MySoapMethod
{}


DataContract(Namespace = "http://mynamespace/schemas/blah/1.0")]
public class MySoapMethodResponse
{
     [DataMember]
    public string SomeProperty { get; set; }
}

Then have a Service to implement the Soap Dto's

public class SOAPService : Service
{
    public MySoapMethodResponse Post(MySoapMethod request)
    {
        var response = new MySoapMethodResponse();
        response.SomeProperty = "blah";
        return response;
    }
}

Answer 2

Please read the SOAP Support docs for guidelines and limitations of using SOAP in ServiceStack.