Package com.apama.engine.beans.interfaces

Interface InjectOperationsInterface

  • All Known Subinterfaces:
    EngineClientInterface
    All Known Implementing Classes:
    EngineClientBean
    public interface InjectOperationsInterface
    InjectOperationsInterface is an interface that specifies the standard operations to enable an engine client to inject new code into a remote correlator.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String[] injectCDP​(byte[] cdpBytes, java.lang.String filename)
      Send the bytes of a CDP (Correlator Deployment Package) to the engine.
      java.lang.String[] injectCDPsFromFile​(java.util.List<java.lang.String> filenames)
      Inject a number of CDP (Correlator Deployment Package)(s) from a file or stdin.
      java.lang.String[] injectJavaApplication​(byte[] jarBytes)
      Send the bytes of a Java (JMon) Application jar to the engine.
      java.lang.String[] injectJavaApplicationsFromFile​(java.util.List<java.lang.String> filenames)
      Inject a number of Java (JMon) Application(s) from a file or stdin.
      java.lang.String[] injectMonitorScript​(MonitorScript script)
      Send a MonitorScript object to the engine.
      java.lang.String[] injectMonitorScript​(MonitorScript script, java.lang.String filename)
      Send a MonitorScript object to the engine.
      java.lang.String[] injectMonitorScriptFromFile​(java.lang.String... filenames)
      Inject a number of monitors from a file or stdin.
      java.lang.String[] injectMonitorScriptFromFile​(java.util.List<java.lang.String> filenames)
      Inject a number of monitors from a file or stdin.
      java.lang.String[] injectMonitorScriptFromFile​(java.util.List<java.lang.String> filenames, boolean utf8)
      Inject a number of monitors from a file or stdin.
      void setCancelInjectFileRead​(boolean newCancelFileReadValue)
      Setter for the cancelFileRead property for the Inject operations.

    • Method Detail

      • injectMonitorScriptFromFile

        java.lang.String[] injectMonitorScriptFromFile​(java.lang.String... filenames)
                                        throws EngineException
        Inject a number of monitors from a file or stdin. If a connection is not yet established, this method will request a connection.
        Parameters:
        filenames - Names of files to read MonitorScript text from. A file name "-" is taken to be stdin.
        Returns:
        An array of strings which are the set of warnings generated by the MonitorScript compiler. May be zero length.
        Throws:
        EngineException - Thrown if any exceptions occur in the Client SDK. This exception may contain warnings.

      • injectMonitorScriptFromFile

        java.lang.String[] injectMonitorScriptFromFile​(java.util.List<java.lang.String> filenames)
                                        throws EngineException
        Inject a number of monitors from a file or stdin. If a connection is not yet established, this method will request a connection.
        Parameters:
        filenames - Names of files to read MonitorScript text from. A file name "-" is taken to be stdin.
        Returns:
        An array of strings which are the set of warnings generated by the MonitorScript compiler. May be zero length.
        Throws:
        EngineException - Thrown if any exceptions occur in the Client SDK. This exception may contain warnings.

      • injectMonitorScriptFromFile

        java.lang.String[] injectMonitorScriptFromFile​(java.util.List<java.lang.String> filenames,
                                               boolean utf8)
                                        throws EngineException
        Inject a number of monitors from a file or stdin. If a connection is not yet established, this method will request a connection.
        Parameters:
        filenames - Names of files to read MonitorScript text from. A file name "-" is taken to be stdin.
        utf8 - If true, the specified files will be read as UTF-8; otherwise they will be read using the system default encoding unless they begin with a unicode Byte Order Mark (BOM) character.
        Returns:
        An array of strings which are the set of warnings generated by the MonitorScript compiler. May be zero length.
        Throws:
        EngineException - Thrown if any exceptions occur in the Client SDK. This exception may contain warnings.

      • injectMonitorScript

        java.lang.String[] injectMonitorScript​(MonitorScript script)
                                throws EngineException
        Send a MonitorScript object to the engine. If a connection is not yet established, this method will request a connection.
        Parameters:
        script - The MonitorScript object to be sent.
        Returns:
        An array of strings which are the set of warnings generated by the MonitorScript compiler. May be zero length.
        Throws:
        EngineException - When failures happen. This exception may contain warnings.

      • injectMonitorScript

        java.lang.String[] injectMonitorScript​(MonitorScript script,
                                       java.lang.String filename)
                                throws EngineException
        Send a MonitorScript object to the engine. If a connection is not yet established, this method will request a connection.
        Parameters:
        script - The MonitorScript object to be sent.
        filename - The file the monitorscript came from (may be null)
        Returns:
        An array of strings which are the set of warnings generated by the MonitorScript compiler. May be zero length.
        Throws:
        EngineException - When failures happen. This exception may contain warnings.

      • injectJavaApplicationsFromFile

        java.lang.String[] injectJavaApplicationsFromFile​(java.util.List<java.lang.String> filenames)
                                           throws EngineException
        Inject a number of Java (JMon) Application(s) from a file or stdin. If a connection is not yet established, this method will request a connection.
        Parameters:
        filenames - Names of jar files to read Java (JMon) Applications from. A file name "-" is taken to be stdin.
        Returns:
        An array of strings which are the set of warnings about the JMon applications. May be zero length.
        Throws:
        EngineException - Thrown if any exceptions occur in the Client SDK. This exception may contain warnings.

      • injectJavaApplication

        java.lang.String[] injectJavaApplication​(byte[] jarBytes)
                                  throws EngineException
        Send the bytes of a Java (JMon) Application jar to the engine. If a connection is not yet established, this method will request a connection.
        Parameters:
        jarBytes - The byte array of the Jar to be sent.
        Returns:
        An array of strings which are the set of warnings about the JMon application. May be zero length.
        Throws:
        EngineException - When failures happen. This exception may contain warnings.

      • injectCDPsFromFile

        java.lang.String[] injectCDPsFromFile​(java.util.List<java.lang.String> filenames)
                               throws EngineException
        Inject a number of CDP (Correlator Deployment Package)(s) from a file or stdin. If a connection is not yet established, this method will request a connection.
        Parameters:
        filenames - Names of v files to read from. A file name "-" is taken to be stdin.
        Returns:
        An array of strings which are the set of warnings about the CDP. May be zero length.
        Throws:
        EngineException - Thrown if any exceptions occur in the Client SDK. This exception may contain warnings.

      • injectCDP

        java.lang.String[] injectCDP​(byte[] cdpBytes,
                             java.lang.String filename)
                      throws EngineException
        Send the bytes of a CDP (Correlator Deployment Package) to the engine. If a connection is not yet established, this method will request a connection.
        Parameters:
        cdpBytes - The byte array of the Jar to be sent.
        filename - the name of the file we are injecting from.
        Returns:
        An array of strings which are the set of warnings about the CDP. May be zero length.
        Throws:
        EngineException - When failures happen. This exception may contain warnings.

      • setCancelInjectFileRead

        void setCancelInjectFileRead​(boolean newCancelFileReadValue)
        Setter for the cancelFileRead property for the Inject operations. The purpose of the cancelFileRead property is to provide a mechanism to cleanly terminate the processing of MonitorScripts from file, when the injectMonitorScriptFromFile() method is in progress. When cancelFileRead is set to true, the MonitorScript injecting loop will terminate at the next iteration.
        Parameters:
        newCancelFileReadValue - New value for the cancelFileRead property.