Regular Expression Socket Reader Input Adapter Sample

This sample demonstrates the use of the TIBCO StreamBase® Regular Expression Socket Reader in a StreamBase application that processes a text log file, storing the information extracted from the log in a query table. The log file is typical of a server log: it contains information about user logins, as well as other, spurious information. The format of the log file means it is not particularly suited to direct use in an application. It does not, for example, consist of CSV records that are ready to be turned into tuples; it must be parsed first and useful information extracted. Because the log file is text and line oriented, it is well suited to parsing using regular expressions.

This example is based on the Regular Expression File Reader sample. The file reader in that application has been replaced by a socket reader, which is configured to connect to port 9000 on the local computer. The sample comes with a very simple server written in Java. The source code and compiled JAR of this server can be found in the sample's directory. The server simply listens on port 9000 and serves the contents of a file (by default, input.txt, though this can be specified on the command line) at one line per second to any connections.

Note

Before the sample application is started, the file server included in the sample directory must be running.

Running This Sample in StreamBase Studio

  1. A simple Java server is provided as part of this sample. Run it as follows:

    1. In the Package Explorer, open the Reference Libraries folder in this sample's project folder.

    2. Select simpleserver.jar, right-click, and select Run AsJava Application. This opens a Console view that shows a message like the following:

      Serving .\input.txt on port 9000 at one line per 1.0 seconds.
  2. In the Package Explorer, double-click to open the RegexSocketReader.sbapp application. Make sure the application is the currently active tab in the EventFlow Editor.

  3. Click the Run button. This opens the SB Test/Debug perspective and starts the application.

  4. The Application Output view shows activity as the StreamBase application reads input from the Simple Server Java application.

  5. Select the Manual Input tab.

  6. Enter joe, fred, bob, or max for Username, and press Send Data.

  7. The Application Output pane shows the time and IP address for the last queried user, according to the log.

  8. When done, press F9 or click the Stop Running Application button to stop the StreamBase application.

  9. In the Console view, use the Display Selected Console button to select the console showing SimpleServer.

  10. Click the red square above the Console view to terminate the SimpleServer process.

Running This Sample in Terminal Windows

This section describes how to run the sample in UNIX terminal windows or Windows command prompt windows. On Windows, be sure to use the StreamBase Command Prompt from the Start menu as described in the Test/Debug Guide, not the default command prompt.

  1. Open several terminal windows on UNIX, or several StreamBase Command Prompts on Windows. In each window, navigate to the directory where the sample is installed, or to your workspace copy of the sample, as described above.

  2. Launch simpleserver.jar. To do from a terminal, run java -jar simpleserver.jar.

  3. In another window, run sbd RegexSocketReader.sbapp

  4. In another window, run sbc dequeue Output.

  5. In another window, run sbc enqueue Queries.

  6. In the enqueue window, type joe, fred, bob, or max, and press Enter. The result of your query appears in the dequeue window.

  7. Run sbadmin shutdown.

  8. In the window running simpleserver.jar, press Ctrl+C to stop the server.

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top menu, click FileLoad StreamBase Sample.

  • Select this sample from the Embedded Adapters list.

  • Click OK.

StreamBase Studio creates a single project containing the sample files.

Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

studio-workspace/sample_adapter_embedded_regexsocketreader

See Default Installation Directories for the location of studio-workspace on your system.

In the default TIBCO StreamBase installation, this sample's files are initially installed in:

streambase-install-dir/sample/adapter/embedded/regexsocketreader

See Default Installation Directories for the default location of studio-workspace on your system.