Regular Expression Socket Reader Input Adapter Sample

About This Sample

This sample demonstrates the use of the Spotfire Streaming 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.

Importing This Sample into StreamBase Studio

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

  • From the top-level menu, click File>Import Samples and Community Content.

  • Enter regexs to narrow the list of options.

  • Select Regular expression socket input adapter from the StreamBase Standard Adapters category.

  • Click Import Now.

StreamBase Studio creates a project for the sample.

Running This Sample in StreamBase Studio

  1. In the Project Explorer view, open the sample you just loaded.

    If you see red marks on a project folder, wait a moment for the project to load its features.

    If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven>Update Project from the context menu.

  2. First, run the Simple Server, which is provided as a Java source file. To do this:

    1. Navigate to the src/main/java/packageName folder.

    2. Right-click SimpleServer.java and select Run As>Java Application.

    3. Look for a message in the Console view that reports the server is running.

    (To change the name of the input text file or the port the server uses by editing values at the top of the Java file.)

  3. Open the src/main/eventflow/packageName folder.

  4. Open the RegexSocketReader.sbapp file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

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

  6. Select the Manual Input tab.

  7. Enter joe, fred, bob, or max for Username, and click Send Data after each entry.

  8. The Output Streams view shows the time and IP address for the last queried user, according to the log.

  9. When done, press F9 or click the Terminate EventFlow Fragment button to stop the StreamBase module.

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

  11. Click the red square in the Console view's toolbar to terminate the SimpleServer process.

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 default location of studio-workspace on your system.