How StreamBase Studio Uses Server Configuration Files

Naming Convention

When StreamBase Studio typechecks files in a project and runs applications, it recognizes and uses a server configuration file which must be named sbd.sbconf and be at the project root.

How Studio Uses Configuration Information

When StreamBase Server is run from the command prompt using sbd, the server configuration is completely determined by the –f argument. For example, if the top-level application has a reference to a module, there must be a <module-search> directive in the configuration file pointing to the directory that contains the module file.

Within a project, StreamBase Studio exposes certain configurations via its user interface: the current project's module search path, resource search path, Java Build Path, and any project references. If you want StreamBase Studio to keep a server configuration file up to date as you make changes to a project, you can specify the Automatically update/maintain server configuration files option in the Project Configuration view of the Project Properties dialog. This option is the default for new projects. When it is selected, launching StreamBase Server on your local machine, sbd is invoked with the -f argument pointing to your project's sbd.sbconf file.

When you have not selected the automatic update option, launching StreamBase Server on your local machine, the -f argument points to a temporary configuration file that Studio constructs based on your project's sbd.sbconf file plus all applicable project settings.

When you launch StreamBase Server on a remote machine, the -f argument points to a temporary configuration file on that machine which is derived from your project's sbd.sbconf file.

The server configuration file synchronization feature is particularly useful for sharing project files, for example via a source code control system. Other users can be confident that they can run your project without needing to edit configuration files or run scripts that do so. Bundling applications is another way to achieve this level of interoperability, but in many instances automatic configuration file synchronization can take the place of bundling.

For related information, see StreamBase Project Properties and Overview of Running Applications.

Configuration Elements Ignored in Studio Launches

When Studio runs StreamBase Server with a generated configuration file, it must reconcile settings in an sbd.sbconf file with the settings of its own typecheck environment. The sbd.sbconf file itself is not altered in any way. All reconciliation of elements occurs in the generated temporary configuration file. Note that, when launched from StreamBase Studio, StreamBase Server ignores the following settings, should they be present:

  • In the <runtime> element, any <application> child elements.

  • All <security> settings.

  • All <security-tagging> settings.

  • All <authentication> settings.

  • All <high-availability> settings.

That is, when launching from StreamBase Studio, authentication is turned off and high availability processing cannot be used.

Remember that running applications in Studio is a convenience for testing and debugging applications under development, and is not designed to emulate the full performance of StreamBase Server run on its own. See Studio Performance Note.

Back to Top