SonicConnect Questions/Clarifications - Forum - Technology Partner - Progress Community

SonicConnect Questions/Clarifications


SonicConnect Questions/Clarifications

  • I'm new to Sonic V8.0 and appreciate the thoughtfulness that has gone into including SonicConnect for both top-down and bottom-up web service development.  There are a few items I'm not finding in documentation and am not seeing realized in practice yet in my development and testing.  Any insights or posts in response are greatly appreciated:

    1. What is the acceptor-like component which listens for requests or is created when a SonicConnect service is deployed?  I've created a new Sonic Development Project and created a SonicConnect service for top-down web service development.  I already had ESB processes to implement web service operations in the WSDL used for top-down development.  I tied the SonicConnect operations to the existing processes for my web service operations.  When I upload the SonicConnect service, it is created in the DS and deployed in the dev_ESBTest container.  The container starts fine, the new SonicConnect service is created along with the instances for the implemented processes.  I see this entry in the dev_ESBTest container log:

      INFO: jetty-6.1.21
      Nov 8, 2010 11:50:28 AM org.mortbay.log.Slf4jLog info
      INFO: Started SelectChannelConnector@
      [10/11/08 11:50:29] ID=dev_ESBTest (info) [] Apache Camel (CamelContext:camel) started
      [10/11/08 11:50:29] ID=dev_ESBTest (info) [C2CWebServiceSonicConnectService] Initialized.
      [10/11/08 11:50:29] ID=dev_ESBTest (info) Actional instrumentation is disabled for this container
      [10/11/08 11:50:29] ID=dev_ESBTest (info) Initializing Mitigation context factory class: com.sonicsw.xqimpl.actional.lg.visitor.StabilizerHelper
      [10/11/08 11:50:29] (info) Loaded ID=dev_ESBTest
      [10/11/08 11:50:29] ID=dev_ESBTest (info) [C2CWebServiceSonicConnectService] Started.
      [10/11/08 11:50:29] ID=dev_ESBTest (info) Container's ESB (JMS) Connection: jms_defaultConnection
      [10/11/08 11:50:29] ID=dev_ESBTest (info) Container's HTTP Routing Connection: http_defaultConnection
      [10/11/08 11:50:29] (info) ...reload ID=dev_ESBTest complete
      [10/11/08 11:50:29] ID=dev_ESBTest (info) ...request resumed after reload

      Can anyone explain the "INFO: Started SelectChannelConnector@" line entry?  The IP address is my local machine in my internal network and port 88 was the port specified in the WSDL.  How is the listener created for the SonicConnect service and where is it created?  I don't see any listeners in netstat on port 88 and I cannot browse the service or access it with a SOAP request.  Something seems missing that is not generating or realizing the HTTP listener piece for the SonicConnect service.  My experience is with the standard HTTP acceptors in the brokers and I'm not making the connection as to how the 'listener' gets build or created for a SonicConnect service front end.

    2. In another thread response, it was noted that SonicConnect takes care of stripping the SOAP tags on incoming request and wrapping SOAP tags on the response.  Is the resulting message part XML that is passed to the ESB process/service the raw XML that came as the soap:body in the request or is it a JAX-WS reconstructed XML of the original?  My applications require I have access to the original XML payload for auditing purposes - both tags/attributes and element data.  I could answer this myself in real practice if I could understand the first question concerning the listeners.

    Thanks in advance.

  • I'm still puzzled about the acceptor-like listener piece that ties all of this together.  My WSDL port that the SonicConnect top-down is based on specifies an address of the flavor:  http://localhost:88/extensionURLforService

    There is nothing established to listen on port 88 per netstat on my local machine.  If I try and put an acceptor in place on the broker after deploying the SonicConnect service, the broker startup throws a bind exception stating that port 88 is already in use.  By what?

    Also, with the deployed SonicConnect service having a defined entry endpoint, I tried using the JMS client and publishing an XML message (my SOAP request) to the entry endpoint of the SonicConnect service with a known JMSReplyTo populated in the message properties.  I get this exception in my logging:

    [10/11/08 15:07:21] ID=dev_ESBTest (severe) [Dispatch] Exception calling service C2CWebServiceSonicConnectService: message rejected
    [10/11/08 15:07:21] ID=dev_ESBTest (severe) Trace follows...
    com.sonicsw.xq.XQServiceException: Missing runtime parameter: esbcamelBeanId
        at com.progress.sonic.esb.service.connect.ConnectService.service(
        at com.sonicsw.xqimpl.service.ServiceMessageHandler.callService(
        at com.sonicsw.xqimpl.service.ServiceMessageHandler.handleMessage(
        at com.sonicsw.xqimpl.service.XQDispatcher.onMessage(
        at com.sonicsw.xqimpl.endpoint.container.EndpointContextContainer.onMessage(
        at com.sonicsw.xq.connector.jms.JMSEndpoint$JMSEndpointListener.onMessage(
        at progress.message.jimpl.Session.deliver(
        at progress.message.jimpl.Session$

    [10/11/08 15:07:21] ID=dev_ESBTest (severe) [Dispatch] ServiceMessageHandler for service C2CWebServiceSonicConnectService - XQ_SERVICE_EXCEPTION error processing message: Missing runtime parameter: esbcamelBeanId

    What component ties the client request to the SonicConnect service and the underlying processes that implement the web service operations?

  • Chris,

    SonicConnect is implemented differently from the previous version of Web Services integration that Sonic provided.

    Most importantly, to expose and consume SOAP/HTTP Web Services, SonicConnect does not send traffic though the broker.

    HTTP is directly from the ESB Container.

    Sonic Connect leverages a combination of CXF and CAMEL technology to both consume and expose.

    In answer to your question,  the HTTP "acceptor" equivalent is a Jetty server activated by a Spring.xml file with CAMEL and CXF definitions, and supporting property files.

    These files are created by Workbench, in the runtime, the Spring fragments appear inside a Sonic Connect archive(.csar) that tooling deploys . The .csar is an initialization parameter for each Sonic Connect service.

    The fact that you see port information in the ESB Container log that houses Sonic Connect reflects that it is the ESB Container that is activating the port.

    Sonic Connect can both expose and consume SOAP/HTTP or REST/HTTP Web Services. In the expose use cases, CAMEL routes defined in the Spring.xml dispatch from a cxfjetty component to ESB itinerary endpoints. In the consume use-case the Sonic Connect service is included as an itinerary step and an invocation(esbcamel) is setup using itinerary input, output and mapping. Sonic Connect service steps only appear in an itinerary .esbp file when an invoke is being performed. The invocation is described  in an esbcamel file( This explains the error you reported in your second message).

    As for exposing SOAP Web Services, ESB message parts relate to the WSDL interface parts. Your example (where you want to pass a single XML document inside a SOAP Body into ESB) suggests that you should be using a DOC LIT WSDL .

    I'm not sure why you are having trouble calling the exposed process. There are several Sonic Connect samples that are worth going over to get an understanding of all the flows. If you still have trouble you can always attach the project artifacts (.csar,.properties)


  • Peter,

    Thanks for that explanation.  I had begun to do a little investigation with the FUSE ESB before we turned back to Sonic and the Camel/CXF implementation for SonicConnect services in the ESB Container should prove out well  We should realize improved performance without having to leave the ESB Container MF Container to get back to the broker in order to receive or send web service requests.

    Mahesh responded earlier that using the SonicConnect service, we could do away with the SOAP tag extractors and wrapper which were typically required to implement a common SOAP web service by older means, i.e. HTTP acceptors.  I'm passing in a SOAP message payload to my SonicConnect service but I am having difficulty verifying exactly what my operation, implemented by a custom ESB process/service is getting in the message part that is delivered to its entry endpoint.  I disabled intra-container messaging anticipating that I could tap the process/service implementation entry-endpoint at the broker.

    I'm submitting requests two ways:

    1. Using the Workbench Scenario tab, consuming a specific operation, and specifying the input parameter as a file, the contents of the file are identical to the SOAP request our web service expects - full soap tags and body payload XML.  When I submit this way, the container log appears to show my custom service in the implemented operation process getting hit, but it takes unmarshalling exceptions.  Our service layer expects to be working on only the XML payload.

      Caused by: javax.xml.bind.UnmarshalException: unexpected element (uri:"", local:"Envelope")

      I would get this exception if we were still attempting to process the XML with the SOAP envelope and tags around the message part.  Is there a good place to confirm that the process that is implementing the tested web service operation gets only the XML which is delivered in the SOAP body tags or do I need to specify I only want the body content and not the full wrapper?

    2. Using SOAP UI to submit the same SOAP request to the web service URL externally.  The WSDL document is returned nicely in my browser when I browse to it, as expected.  When I use SOAP UI, the exception received looks much farther upstream than even making the custom process/service which implements the web service operation.  I get this exception:

      Nov 9, 2010 11:38:26 AM org.apache.camel.component.cxf.interceptors.AbstractMessageInInterceptor createDOMMessage
      INFO: AbstractMessageInInterceptor Converting Stax Stream to DOM
      [10/11/09 11:38:28] ID=dev_ESBTest (info) [] USU: Processing Response for jurisdiction "Arlington County" with agency "ARLRMS".
      [10/11/09 11:38:28] ID=dev_ESBTest (severe) [] com.sonicsw.xq.XQMessageException: Failed to get part.  No part with content id resultcom.sonicsw.xq.XQMessageException: Failed to get part.  No part with content id result
          at com.sonicsw.xq.connector.jms.XQJMSMessage.getPartIndexForContentId(
          at com.sonicsw.xq.connector.jms.XQJMSMessage.getPart(

      Using the external call, something is not correlating properly

    Thanks in advance.  I'm obviously trying to get beyond the framework configuration issues here so I can simply work on the web service operation implementations in the ESB layers.

  • More information:

    Using the workbench to test the SonicConnect Service interface for one of the web service operations, if I use an input XML message without the SOAP envelope (simply what should be the XML payload part), I get the expected processed response from the custom service in the ESB process which implements the web service operation.  Additionally, if I put back in place the SOAP tags removal XML transformation service in front of the custom service step in the custom process which implements the web service operation, I can process the payload by using an external request as well.  Why isn't the SonicConnect service removing the SOAP?  Is there something specific that needs to be configured for this aspect?

    There seems to be a warning message about the broker and temp queues it is using for this processing also:

    [10/11/09 12:22:11] ID=dev_ESBTest (warning) com.sonicsw.xq.XQEndpointCreationException:  (Failed to find MgmtBroker::$ISYS.USERS.TemporaryQueues.Administrator.$TMPAPPID$9$$SESSION$118.*.*.-142702917221-873658342MgmtBroker in context endpoint - There is no element /xqEndpoints/MgmtBroker::$ISYS.USERS.TemporaryQueues.Administrator.$TMPAPPID$9$$SESSION$118.*.*.-142702917221-873658342MgmtBroker in the Directory Service) (Failed to find MgmtBroker::$ISYS.USERS.TemporaryQueues.Administrator.$TMPAPPID$9$$SESSION$118.*.*.-142702917221-873658342MgmtBroker in context endpoint - There is no element /xqEndpoints/MgmtBroker::$ISYS.USERS.TemporaryQueues.Administrator.$TMPAPPID$9$$SESSION$118.*.*.-142702917221-873658342MgmtBroker in the Directory Service)

    Is this a remnant from a previous temp queue possibly used for responses for the Sonic Connect service?  I seem to be having basic issues just getting the SonicConnect dots connected so I can get back to the web service operation implementations.

  • Chris,

    For scenarios that directly test your ESB Process, you create your scenario in terms of ESB test messages, not SOAP. Although the itinerary happens to be exposed by Sonic Connect, when you test your process using itinerary scenarios, the test messages are not going through Sonic Connect - they are going directly into the ESB process.

    This is different from our previous Web Service support where in order for an ESB process to implement a Web-Service the process needed explicit SOAP Unwrap and SOAP Response steps, or needed to be surrounder by a wrapper process that did these steps.

    Sonic Connect does the unwrap and response steps for you. This big advantage here is that your ESB process can be SOAP agnostic and focus on the application data.

    In your DOC-LIT use case, the ESB itinerary should expect and produce single-part ESB messages whose part name co-incides with the abstract WSDL operation messages.


  • Peter,

    Once again, thanks for the response.  I believe I empiracally stumbled on the fact that the Workbench scenario was testing the operations and just the processes on the message payload and not the complete soap message.

    What you've indicated about the response and looking for the part named or identified by the output name specified in the WSDL operation jives with the error messages.  The output part name on the operation was simply "result."  The error message is stating there is no part with content id "result."

    Many thanks.

  • Is there documentation on the SonicConnect web services beyond the rudimentary web_services.pdf document and the demonstrations?

    I would like to use a SonicConnect service as a step in an ESB Process to call an external web service and have the next step in the ESB Process process the response (either expected or a fault).  The endpoint I need to call could be one of several possible external web service endpoints.  Is there a way to dynamically configure, either through the use of message properties or other means, to override and set the endpoint the SonicConnect service will use to call the external web service?


  • Chris

    The online documentation has some Multimedia tutorials,

    Alas, dynamic URL override for calling SOAP Web Services using Sonic Connect is not currently implemented, but this is a feature that will be implemented in the next release.

    (You can change URLs at configuration easily as these are externalized through the Sonic Connect properties file.)


  • Peter, thanks for the reply.

    By next release, do you anticipate that being a major release such as 8.1 or 8.2 or would this feature to override the endpoint for a SonicConnect web service client be perhaps in 8.0 SP2?

    I guess our alternative to do this dynamically is to use the Dynamic HTTP Outbound Routing Definition and override the URL endpoint in the message header properties before calling the endpoint referencing the routing definition?

  • Is there documentation which shows all of the message headers populated by the SonicConnect service when it receives an incoming SOAP request and passes it on as a JMS message internally to the mapped process?

    I'm partciularly interested in the property which would contain the equivalent of the X-HTTP-ReceiveURL which is populated by an HTTP Acceptor when it receives a request and passes it on to the mapped endpoint as an ESB/JMS Message.

  • I'm not sure what your use case for X-HTTP-ReceiveURL would be.

    Generally you'll receive inbound arbitrary HTTP headers like SOAPAction, Host etc. This is configurable by the header filter definitions in the spring.xml/

    Now, say your application needs a custom header as you describe, an option is to edit the spring.xml file and add the header using camel:setHeader e.g.



    ${in.header.operationName} == 'P'


  • Peter, thanks.