The sample transport is designed to send and receive streamed data to and from a configured TCP socket in Service Bus. The sample transport illustrates the following Transport SDK concepts:

• Implementing the set of Transport SDK APIs that are required to build a custom transport.

• Performing transport endpoint validations, such as checking that no socket endpoint is listening on the configured address.

• Implementing several UI configuration options, including socket properties and message patterns.

• Implementing a one-way or synchronous request-response message pattern.

• Using POJOs (Plain Old Java Objects) for metadata and headers of endpoint requests and responses.

• Using streaming in Service Bus pipelines.

Figure 43-1 shows the basic architecture of the sample socket transport provider. Any client can connect to the server socket. Data is received at the server socket and passes through the pipeline. The response comes back through the outbound transport. The response is finally sent back to the inbound transport and back to the client.

Figure 43-2 illustrates the configuration properties for the transport endpoint. These properties are configured in the schema file, SocketTransport.xsd. For the location of this file, see Sample Location and Directory Structure .. This file allows you to extend the basic set of properties defined in the common schema provided with the SDK. Refer to the SocketTransport.xsd file for information on each of the properties.

Also in the SocketTransport.xsd file are the request and response header and metadata properties, as illustrated in Figure 43-3. Refer to the SocketTransport.xsd file for more information about these properties.

1. Create a new domain or use one of the preconfigured domains installed with Service Bus.
2. Set the domain environment by running the following script:

   DOMAIN_HOME/bin/setDomainEnv.cmd (or setDomainEnv.sh on a UNIX system)

1. In a command window, navigate to OSB_ORACLE_HOME/samples/servicebus/sample-transport.
2. Run the following command:

   ant build
   

   This command compiles the source files in OSB_ORACLE_HOME/samples/servicebus/sample-transport/build.

3. After the transport builds successfully, run the following command:

   ant stage
   

   This copies sock_transport.ear and sock_transport.jar to OSB_ORACLE_HOME/lib/transports and copies transport-socket.xml to OSB_ORACLE_HOME/config/plugins.

1. Set the following variables in sample-transport/build.properties:

   wls.hostname
   
   wls.port
   
   wls.username
   
   wls.password
   
   wls.server.name
   

2. Deploy the transport provider on the server by running the following command:

   ant deploy

1. Navigate to /MW_HOME/osb/config/plugins.
2. Open transport-socket.xml in an XML or text editor.
3. In the transport element, add the following attributes:

   id='socket'
   helpId="contexts_socketTransport"
   

   The final file should look like this:

   <plugin xmlns="http://www.bea.com/alsb/offline/extensions">
    
       <transport
          class="com.bea.alsb.transports.sock.SocketTransportProviderFactory"
          id="socket"
          helpId="contexts_socketTransport"/>
    
       <libraries>
           <library name='lib/transports/sock_transport.jar'/>
       </libraries>
    
   </plugin>

4. Save and close the file.
5. Restart JDeveloper if it is running.

1. Start the Oracle Service Bus Console and either create a new session or edit an existing one.
2. In the Project Navigator, right-click All Projects, point to Create, and select Project.
3. On the Create a New Project dialog, enter SocketTest in the Resource Name field.
4. Click Create.

   The new project appears in the Project Definition Editor.

1. In the Project Navigator, right-click the SocketTest project, point to Create, and select Resource. Click Business Service, click Technology, and then click socket.

   The Create Business Service wizard appears.

   Figure 43-4 Create Business Service Wizard

   
   Description of "Figure 43-4 Create Business Service Wizard"
2. In the Resource Name field, enter SocketBS.
3. In the Transport field, select socket. Click Next.
4. For the Service Type, select Any XML Service, and click Next.
5. In the Endpoint URI field, change the default URI to tcp://localhost:7031.
6. Click Create.

   The business service appears in the Business Service Definition Editor. You can click the different subtabs to view the configuration.

7. Click Save.

1. In the Project Navigator, right-click the SocketTest project, point to Create, and select Resource. Click Proxy Service, click Technology, and then click socket.

   The Create Proxy Service wizard appears.

   Figure 43-5 Create Proxy Service Wizard

   
   Description of "Figure 43-5 Create Proxy Service Wizard"
2. In the Resource Name field, enter SocketProxy.
3. In the Transport field, select socket. Click Next.
4. For the Service Type, select Any XML Service, and click Next.
5. In the Endpoint URI field, change the default URI to 7032.
6. Click Create.

   The proxy service appears in the Proxy Service Definition Editor. You can click the different subtabs to view the configuration.

7. Click Save.

1. In the Project Navigator, right-click the SocketTest project, point to Create, and select Resource. Click Pipeline, and then click OK.

   The Create Pipeline dialog appears.

2. In the Pipeline Name field, enter SocketPipeline.
3. For the Service Type, select Any XML Service.
4. Deselect Expose as Proxy Service.

   Figure 43-6 Create Pipeline Dialog

   
   Description of "Figure 43-6 Create Pipeline Dialog"
5. Click Create.

   The pipeline appears in the Pipeline Definition Editor. You can click the different subtabs to view the configuration.

6. Click the Open Message Flow icon in upper right section of the editor.

   Figure 43-7

   
   Description of "Figure 43-7 "

   The Edit Message Flow window appears.

7. Click the SocketPipeline icon and select Add Route from the menu..

   Figure 43-8 Editing the Message Flow

   
   Description of "Figure 43-8 Editing the Message Flow"
8. Click the RouteNode1 icon and select Edit Route.
9. In the Edit Stage Configuration window, click Add an Action and select Communication > Routing.

   Figure 43-9 Adding an Action

   
   Description of "Figure 43-9 Adding an Action"
10. Next to Route to, select <Service>.
11. In the Select Service window, select SocketBS from the list, and click Submit.
12. In the Edit Stage Configuration window, click Save.
13. Optionally, click the RouteNode1 icon, change the name to SocketBS, and then click Save.
14. Click Save again.

    You are returned to the Pipeline Definition Editor.

1. In the Project Navigator, click the SocketProxy proxy service.

   The Proxy Service Definition Editor appears.

2. On the General subtab of the Configuration tab, click Choose a Service Resource by the Target Name field.
3. On the Search and Select dialog, enter SocketPipeline in the Name field and click Search.
4. Select the pipeline in the results list, and then click OK.
5. Click Save.
6. Click Activate to deploy the new resources to the WebLogic Server.

java -classpath .\test\build\test-client.jar -Dfile-encoding=utf-8
-Drequest-encoding=utf-8 com.bea.alsb.transports.sample.test.TestServer 7031
<message-file-location>

java -classpath .\test\build\test-client.jar -Dfile-encoding=utf-8
-Dresponse-encoding=utf-8 com.bea.alsb.transports.sample.test.TestClient
<host-name> <port> <thread-ct> <message-file-location>

1. Start the test server, as explained previously in Starting the Sample External Service .
2. In the Project Navigator, click SocketPipeline to open it in the Pipeline Definition Editor.
3. In the upper right portion of the editor, click the Launch Test Console icon.

   The Test Console appears in a new browser window.

4. In the Test Console, enter any valid XML stanza in the text area, or use the Browse button to select a valid XML file on the local system.

   Figure 43-10 Testing the Sample Transport Provider in the Test Console

   
   Description of "Figure 43-10 Testing the Sample Transport Provider in the Test Console"
5. Click Execute. If the test is successful, information similar that shown in Figure 43-11 appears in the Test Console. In addition, the XML text input into the Test Console is echoed in the server console.

   Figure 43-11 Successful Sample Transport Provider Test

   
   Description of "Figure 43-11 Successful Sample Transport Provider Test"
6. Close the Test Console.