Socket Server Adapter

Socket Server Adapter Overview

The Socket Server adapter provides a Transmission Control Protocol (TCP) endpoint. You can read and write data over this TCP endpoint. The Socket Server adapter can handle both standard connections as well as Secure Sockets Layer (SSL) connections, with authentication, and verification of the SSL protocol handled by the Sterling B2B Integrator keystore. The type of connection (Clear or SSL) is set in the adapter configuration.

You have the option of performing the read and write operations either by invoking a business process containing the Sterling B2B Integrator Socket Read service and Socket Write service or by invoking a custom Java implementation.

Configuring the Socket Server Adapter

To configure the Socket Server adapter, you must specify field settings in the user interface service configuration:

Using the Sterling B2B Integrator Socket Adapter

The Sterling B2B Integrator Socket adapter provides a means to expose a Transmission Control Protocol (TCP) endpoint and also to connect to a TCP endpoint from Sterling B2B Integrator. These capabilities allow you to specify services that perform read and write operations over a TCP Socket. You can use services in a business process to perform the read and write operations. For the server side, options are provided to either invoke a business process that contains the read and write services or invoke a custom Java implementation (that performs the read and write). On the client side, you must invoke a business process to perform these same operations.

Below is the list of adapters and services used in conjunction with the Sterling B2B Integrator Socket adapter.

Adapters

• Socket Server adapter
• Socket Client adapter

Services

• Socket Read service
• Socket Write service
• Socket Close service
• Socket Connect service

Invoking a Business Process

The Sterling B2B Integrator Socket Server adapter gives you the option to invoke a business process when a remote TCP Client connects onto the Socket Server adapter.

The business process name is configured as a part of Sterling B2B Integrator Socket Server adapter configuration.

The business process must reference the Socket Read service, the Socket Write service, and the Socket Close service to perform the read, write, and close of the socket, respectively.

The Socket Close service is needed to close the connection at the end of read and write. If you do not include the Socket Close service in the business process, it would leave the connection open and degrade the performance of the machine by utilizing the system resources.

Sample Business Process

This business process uses both the Socket Read and Socket Write services. The Socket Write service reads the data from the node testNode and writes it over the socket. The Socket Read service reads 100 bytes of data from the socket into the document with name SocketData.

<process name = "SocketServerBP"> 
  <sequence>
<assign to="testNode">Its a nice day today.. have a good day</assign>
       <operation name="Socket Write Service">
      <participant name="SWS"/>
      <output message="SocketWriteServiceTypeInputMessage">
<assign to="NodeToRead" from="/ProcessData/testNode/text()"></assign>   
 <assign to="ResponseTimeout">30</assign>  
        <assign to="DelayWaitingOnIO">20</assign>  
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>

  <operation name="Socket Read Service">
      <participant name="SRS"/>
      <output message="SocketReadServiceTypeInputMessage">
        <assign to="." from="*"></assign>
        <assign to="DelayWaitingOnIO">30</assign>  
        <assign to="ResponseTimeout">30</assign>  
        <assign to="BytesCount">100</assign>
        <assign to="DocumentName">SocketData</assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>

<operation name="SocketCloseServiceType">
      <participant name="SClose1"/>
      <output message="SocketCloseServiceTypeInputMessage">
      <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
<onFault>
      <operation name="SocketCloseServiceType">
        <participant name="SocketClose"/>
        <output message="SocketCloseServiceTypeInputMessage">
          <assign to="." from="*"></assign>
        </output>
        <input message="inmsg">
          <assign to="." from="*"></assign>
        </input>
      </operation>

    </onFault>
  </sequence>
</process>

Invoking Java Custom Code

Writing Code

Sterling B2B Integrator exposes the ISocketServer_onConnect interface to allow you to introduce custom code. Custom implementations must implement this interface and override the interface method(s).

com.servername.services.socketserver.interfaces.ISocketServer_onConnect

public void onConnect(HashMap<String, Object> map)

These parameters are used in the custom code to read and write data from the socket.