Home
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
Developing custom operators
Create custom operators if shipped toolkits do not provide the necessary logic or behavior needed for your stream applications.
Developing primitive operators
You develop new primitive operators by implementing them in the C++ or Java™ language. You must define an operator model that describes the syntax and semantics of the operator and implement the operator logic by creating the header and implementation code generator templates.
Developing Java™ primitive operators
To create a Java™ primitive operator inside an SPL toolkit, you must provide an operator model. The process is similar to how you provide operator models for C++ primitive operators.
Using the Javaop operator
The operator spl.utility.JavaOp invokes an operator that is implemented in Java™ by using the Java Operator API. It is a general-purpose callout to Java from SPL.

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Learn about different Teracloud Streams tools and features to write, compile, run, and test streams applications.
- Development concepts
  Development of stream applications consists of several components such as operators, streams, tuples, Streams Processing Language, toolkits, and more.
- Developing stream applications
  Try out tutorials and explore details about stream application development, SPL features, and best practices.
- Developing native functions
  Extend SPL's computational capabilities by creating native functions written in C++ or Java.
- Developing custom operators
  Create custom operators if shipped toolkits do not provide the necessary logic or behavior needed for your stream applications.
  - Types of operators
    When developing new operators, developers need to choose the kind of operator to implement based on the task they want to accomplish, the programming language they want to use and the trade-offs they are willing to make between generality and ease of implementation.
  - Primitive operator artifacts
    Each primitive operator is stored in a directory whose name follows the format ([:alnum:]+\.)*[:alnum:]+ where the last part ([:alnum:]+) is the operator name.
  - Developing primitive operators
    You develop new primitive operators by implementing them in the C++ or Java™ language. You must define an operator model that describes the syntax and semantics of the operator and implement the operator logic by creating the header and implementation code generator templates.
    - Developing C++ primitive operators
      The SPL language supports writing two styles of primitive operators, namely: generic operators and non-generic operators.
    - Developing Java™ primitive operators
      To create a Java™ primitive operator inside an SPL toolkit, you must provide an operator model. The process is similar to how you provide operator models for C++ primitive operators.
      - Java™ Operator API overview
        You use the Teracloud® Streams Java™ Operator API to implement user-defined operators in Java.
      - Java™ operator lifecycle
        Java™ operators have a runtime lifecycle that starts when an instance of the operator is initialized and ends when the processing element (PE) that hosts the operator is shut down.
      - Understanding threading in a Java™ operator
        A Java™ operator must always be written to be threadsafe as its methods might be called by different threads and might be called concurrently. Standard Java threading concepts apply including synchronization, locking, and visibility.
      - Working with SPL types
        Each SPL type maps to a Java™ counterpart.
      - Implementing an operator using the Java™ Operator API
        An operator processes incoming tuples and submits outgoing tuples. The relationship between an input tuple and the submitted tuples varies according to the function of the operator.
      - Implementing a sink operator using the Java™ Operator API
        A sink operator transmits information or events to an external system, such as a dashboard, web-server, mail-server, or a database. When such a system provides a Java™ API, a sink operator to that system can be implemented in Java.
      - Implementing a source operator with the Java™ Operator API
        A source operator fetches information or events from an external system, such as a sensor, messaging system, or a database, and presents them as a stream. If such a system provides a Java™ API, then you can implement a source operator for that system in Java.
      - Changing an exported port's properties
        The Export operator is used in the SPL language to export a stream using a set of export properties, which can be modified at run time.
      - Implementing a tumbling window operator with the Java™ Operator API
        When an operator implemented with the Java™ Operator API is invoked, any window configurations for its input ports are made available through the instance of the StreamWindow interface that is accessed by StreamingInput.getStreamWindow(). Every input port has its own instance of StreamWindow, even when the input port is not windowed.
      - Implementing a sliding window operator with the Java™ Operator API
        A sliding window differs from a tumbling window by having a trigger policy in addition to an eviction policy.
      - Using operator metrics
        The Java™ Operator API provides runtime access to metrics similar to the access C++ APIs provide. Operator metrics are accessed through the com.ibm.streams.operator.metrics.OperatorMetrics interface by obtaining a reference using OperatorContext.getMetrics().
      - Using the Javaop operator
        The operator spl.utility.JavaOp invokes an operator that is implemented in Java™ by using the Java Operator API. It is a general-purpose callout to Java from SPL.
      - Generated Java™ operator
        The operator spl.utility.JavaOp can generate Java™ source templates for the specific invocation of the operator.
    - Developing Python primitive operators
      To create a Python primitive operator inside an SPL toolkit, you must provide an operator model. The process is similar to how you provide operator models for C++ primitive operators.
  - Creating C++ libraries for operators and native functions
    To enable operators and native functions, you must compile with the appropriate include file paths and options and link any shared libraries against the correct runtime libraries.
  - Best practices
    Use these tips to write operators that perform effectively in their application, and in other applications.
  - Performance recommendations
    These tips help you to improve performance of your primitive operators in C++.
- Developing custom toolkits
  Bundle and reuse custom functions and operators across several stream applications by creating custom toolkits.
- Working with files
  Applications and operators can read and write to files in several ways. If relative paths are used, the data directory is used as the root of relative paths. To enable logic to access the runtime application or toolkit directory hierarchies, language-specific functions can be used.
- Enabling Streams data exchange
  Teracloud® Streams provides data exchange REST and WebSocket APIs, for inserting tuples into and retrieving tuples from Streams jobs, to easily integrate with external applications. Streams applications can enable the data exchange feature by using one or more Endpoint operators.
- Debugging stream applications
  Debug stream applications using the interactive, command line-based Streams Debugger (sdb).
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Using the Javaop operator

The operator spl.utility.JavaOp invokes an operator that is implemented in Java™ by using the Java™ Operator API. It is a general-purpose callout to Java™ from SPL.The mechanism to use Java™ in an SPL application is instead by a Java™ primitive operator.

A Java™ primitive operator has many benefits over the JavaOp operator, namely:

The ability to specify syntactic and semantic checks for instances of the Java™ code when used in a stream application. For example, a missing parameter can be detected only at run time when you use JavaOp. Whereas, a Java™ primitive can find the missing parameter at SPL compile time.
The Java™ primitive operator's name implies its function. For example, invocation of a Java™ primitive named HttpPost makes for more readable SPL code than invocation of JavaOp with a className parameter set to com.ibm.streams.operator.samples.sinks.HttpPOST, even though they both use the same Java™ code.
The Java™ primitive operator might have an icon specific to its function for viewing graphical representations of the application.

However, spl.utility.JavaOp can be used as a development or prototyping aid to help quickly develop operators with the Java™ Operator API. You can understand the required parameters and libraries before you create a Java™ primitive operator.