Package com.ibm.di.api.local

Interface AssemblyLine

  • All Known Implementing Classes:
    AssemblyLineImpl
    public interface AssemblyLine
    Represents an AssemblyLine instance.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addListener​(AssemblyLineListener listener, boolean getLogs, boolean getEntryOnEachCycle)
      Register a listener for AssemblyLine events.
      void attachDebugger​(int port, java.lang.String host, boolean onerror)
      Attach a debugger to the AssemblyLine.
      void detachDebugger​(java.lang.Object msg)
      Detach the current debugger from the AssemblyLine.
      boolean getComponentDebugMode​(java.lang.String componentName)
      Query the debug mode setting of the specified component (Connector or Function Component).
      AssemblyLineConfig getConfig()
      Returns configuration information about the AssemblyLine.
      ConfigInstance getConfigInstance()
      Returns the configuration instance of the AssemblyLine.
      java.lang.String getGlobalUniqueID()
      Returns AssemblyLine GUID.
      java.lang.String getName()
      Returns the name of the AssemblyLine.
      java.lang.String getNullBehavior()
      Gets the nullBehavior attribute of the AssemblyLine object
      java.lang.String getNullBehaviorValue()
      Gets the nullBehaviorValue attribute of the AssemblyLine object.
      Entry getResult()
      This method returns the result entry object.
      TaskStatistics getStatistics()
      This method returns the TaskStatistics object for this AssemblyLine.
      java.lang.String getSystemLog()
      Retrieves the current AssemblyLine's system log.
      java.lang.String getSystemLogFileName()
      Returns the name of the log file of the AssemblyLine (not prefixed by folders path).
      java.lang.String getSystemLogFilePath()
      Returns the fully-qualified path of the log file of the AssemblyLine.
      java.lang.String getSystemLogLastChunk​(int aLastKilobytes)
      Retrieves the last chunk from the current AssemblyLine's system log.
      int getUniqueCode()
      Returns the unique code of the AssemblyLine.
      boolean isActive()
      Checks if the AssemblyLine is active.
      boolean isSimulating()
      Check whether the AssemblyLine is simulating or not
      void removeListener​(AssemblyLineListener listener)
      Unregister a listener for AssemblyLine events.
      void setComponentDebugMode​(java.lang.String componentName, boolean debug)
      Modify the debug mode setting of the specified component (Connector or Function Component).
      void setSimulating​(boolean simulate)
      Changes the way the AssemblyLine treats the target systems it is connecting/interacting to/with.
      void stop()
      Stops the execution of the AssemblyLine.
      void stop​(boolean sync)
      Stops the execution of the AssemblyLine, and waits for it to stop.

    • Method Detail

      • getConfigInstance

        ConfigInstance getConfigInstance()
                          throws DIException
        Returns the configuration instance of the AssemblyLine.

        Example 

         var mAssemblyLine = session.getAssemblyLines()[0];
 
 var mConfigInstance = mAssemblyLine.getConfigInstance();
 
 var configId = mConfigInstance.getConfigId();
 
 var aAssemblyLineName = "AssemblyLine";
 
 var assemblyLine = mConfigInstance.startAssemblyLine(aAssemblyLineName);
 
 var objectName = com.ibm.di.api.jmx.mbeans.AssemblyLine.genObjectName(assemblyLine.getName(), assemblyLine.getUniqueCode());
        Returns:
        Returns ConfigInstance object representing the configuration instance of the AssemblyLine.
        Throws:
        DIException - if an error occurs while retrieving the configuration instance information.

      • getName

        java.lang.String getName()
                  throws DIException
        Returns the name of the AssemblyLine.

        Example 

         var mAssemblyLine = session.getAssemblyLines()[0];
 
 var mConfigInstance = mAssemblyLine.getConfigInstance();
 
 var configId = mConfigInstance.getConfigId();
 
 var aAssemblyLineName = "AssemblyLine";
 
 var assemblyLine = mConfigInstance.startAssemblyLine(aAssemblyLineName);
 
 var objectName = com.ibm.di.api.jmx.mbeans.AssemblyLine.genObjectName(assemblyLine.getName(), assemblyLine.getUniqueCode());
        Returns:
        String object representing the AssemblyLine's name.
        Throws:
        DIException - if an error occurs while retrieving the name of the AssemblyLine.

      • getUniqueCode

        int getUniqueCode()
           throws DIException
        Returns the unique code of the AssemblyLine.

        Example 

         var mAssemblyLine = session.getAssemblyLines()[0];
 
 var mConfigInstance = mAssemblyLine.getConfigInstance();
 
 var configId = mConfigInstance.getConfigId();
 
 var aAssemblyLineName = "AssemblyLine";
 
 var assemblyLine = mConfigInstance.startAssemblyLine(aAssemblyLineName);
 
 var objectName = com.ibm.di.api.jmx.mbeans.AssemblyLine.genObjectName(assemblyLine.getName(), assemblyLine.getUniqueCode());
        Returns:
        int value representing the unique code of the AssemblyLine.
        Throws:
        DIException - if an error occurs while retrieving the unique code of the AssemblyLine.

      • getConfig

        AssemblyLineConfig getConfig()
                      throws DIException
        Returns configuration information about the AssemblyLine.
        Returns:
        AssemblyLineConfig representing the configuration information of the AssemblyLine.
        Throws:
        DIException - if an error occurs while retrieving the configuration information of the AssemblyLine.

      • getNullBehavior

        java.lang.String getNullBehavior()
                          throws DIException
        Gets the nullBehavior attribute of the AssemblyLine object
        Returns:
        String object representing the nullBehavior attribute value or null if no setting values are available for the AssemblyLine.
        Throws:
        DIException - if an error occurs while getting the nullBehavior attribute.

      • getNullBehaviorValue

        java.lang.String getNullBehaviorValue()
                               throws DIException
        Gets the nullBehaviorValue attribute of the AssemblyLine object.
        Returns:
        String object representing the nullBehaviorValue attribute value or null if no setting values are available for the AssemblyLine.
        Throws:
        DIException - if an error occurs while getting the nullBehaviorValue attribute.

      • getStatistics

        TaskStatistics getStatistics()
                      throws DIException
        This method returns the TaskStatistics object for this AssemblyLine.

        Example 

         var runningALs = null;
 var stats = null;
 var result = null;
 var runningConfigs = session.getConfigInstances();
 for (var i = 0; i < runningConfigs.length; i++) {
        runningALs = runningConfigs[i].getAssemblyLines();
        for (var j = 0; j < runningALs.length; j++) {
                if (runningALs[j].isActive()) {
                        stats = runningALs[j].getStatistics().toString();
                        main.logmsg("statistics[" + j + "] = " + stats);
 
                        result = runningALs[j].getResult();
 
                        var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID());
 
                        runningALs[j].stop();
                }
        }
 }
        Returns:
        The accumulated TaskStatistics object.
        Throws:
        DIException - if an error occurs while getting the AssemblyLine statistics.

      • isActive

        boolean isActive()
          throws DIException
        Checks if the AssemblyLine is active.

        Example 

         var runningALs = null;
 var stats = null;
 var result = null;
 var runningConfigs = session.getConfigInstances();
 for (var i = 0; i < runningConfigs.length; i++) {
        runningALs = runningConfigs[i].getAssemblyLines();
        for (var j = 0; j < runningALs.length; j++) {
                if (runningALs[j].isActive()) {
                        stats = runningALs[j].getStatistics().toString();
                        main.logmsg("statistics[" + j + "] = " + stats);
 
                        result = runningALs[j].getResult();
 
                        var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID());
 
                        runningALs[j].stop();
                }
        }
 }
        Returns:
        true if the AssemblyLine's thread is alive, false otherwise.
        Throws:
        DIException - if an error occurs while getting the AssemblyLine state.

      • getResult

        Entry getResult()
         throws DIException
        This method returns the result entry object. This object is a copy of the working entry as it were when the AssemblyLine finished processing the connectors.

        Example 

         var runningALs = null;
 var stats = null;
 var result = null;
 var runningConfigs = session.getConfigInstances();
 for (var i = 0; i < runningConfigs.length; i++) {
        runningALs = runningConfigs[i].getAssemblyLines();
        for (var j = 0; j < runningALs.length; j++) {
                if (runningALs[j].isActive()) {
                        stats = runningALs[j].getStatistics().toString();
                        main.logmsg("statistics[" + j + "] = " + stats);
 
                        result = runningALs[j].getResult();
 
                        var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID());
 
                        runningALs[j].stop();
                }
        }
 }
        Returns:
        The last "work" entry object.
        Throws:
        DIException - if an error occurs while getting the result Entry.

      • stop

        void stop()
   throws DIException
        Stops the execution of the AssemblyLine.

        Example 

         var runningALs = null;
 var stats = null;
 var result = null;
 var runningConfigs = session.getConfigInstances();
 for (var i = 0; i < runningConfigs.length; i++) {
        runningALs = runningConfigs[i].getAssemblyLines();
        for (var j = 0; j < runningALs.length; j++) {
                if (runningALs[j].isActive()) {
                        stats = runningALs[j].getStatistics().toString();
                        main.logmsg("statistics[" + j + "] = " + stats);
 
                        result = runningALs[j].getResult();
 
                        var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID());
 
                        runningALs[j].stop();
                }
        }
 }
        Throws:
        DIException - if an error occurs while stopping the AssemblyLine.

      • stop

        void stop​(boolean sync)
   throws DIException
        Stops the execution of the AssemblyLine, and waits for it to stop.

        Example 

         var stats = null;
 var runningConfigs = session.getConfigInstances();
 for (var i = 0; i < runningConfigs.length; i++) {
        var runningALs = runningConfigs[i].getAssemblyLines();
        for (var j = 0; j < runningALs.length; j++) {
                if (runningALs[j].isActive()) {
                        main.logmsg("Stopping [" + j + "]: " + runningALs[j].getName());
 
                        runningALs[j].stop(false);
 
                        stats = runningALs[j].getStatistics().toString();
                        main.logmsg("statistics[" + j + "] = " + stats);
                }
        }
 }
        Parameters:
        sync - If true, create a new Thread to do the waiting.
        Throws:
        DIException - if an error occurs while stopping the AssemblyLine.
        Since:
        7.1

      • getSystemLogFilePath

        java.lang.String getSystemLogFilePath()
                               throws DIException
        Returns the fully-qualified path of the log file of the AssemblyLine.
        Returns:
        the fully-qualified log file path.
        Throws:
        DIException - if an error occurs while obtaining AssemblyLine log file path.

      • getSystemLogFileName

        java.lang.String getSystemLogFileName()
                               throws DIException
        Returns the name of the log file of the AssemblyLine (not prefixed by folders path).
        Returns:
        the log file name.
        Throws:
        DIException - if an error occurs while obtaining AssemblyLine log file name.

      • getSystemLog

        java.lang.String getSystemLog()
                       throws DIException
        Retrieves the current AssemblyLine's system log.
        Returns:
        the log generated by the AssemblyLine so far.
        Throws:
        DIException - if an error occurs while obtaining AssemblyLine's log.

      • getSystemLogLastChunk

        java.lang.String getSystemLogLastChunk​(int aLastKilobytes)
                                throws DIException
        Retrieves the last chunk from the current AssemblyLine's system log.
        Parameters:
        aLastKilobytes - Specifies in kilobytes the size of the log's last chunk that will be read.
        Returns:
        the last chunk of the AssemblyLine's log, generated so far.
        Throws:
        DIException - if an error occurs while obtaining AssemblyLine's log.

      • getGlobalUniqueID

        java.lang.String getGlobalUniqueID()
                            throws DIException
        Returns AssemblyLine GUID. The GUID is a string value that is unique for each component ever created by a particular TDI Server.

        Example 

         var runningALs = null;
 var stats = null;
 var result = null;
 var runningConfigs = session.getConfigInstances();
 for (var i = 0; i < runningConfigs.length; i++) {
        runningALs = runningConfigs[i].getAssemblyLines();
        for (var j = 0; j < runningALs.length; j++) {
                if (runningALs[j].isActive()) {
                        stats = runningALs[j].getStatistics().toString();
                        main.logmsg("statistics[" + j + "] = " + stats);
 
                        result = runningALs[j].getResult();
 
                        var attr = new com.ibm.di.entry.Attribute("LogURL", "/log/" + runningALs[j].getGlobalUniqueID());
 
                        runningALs[j].stop();
                }
        }
 }
        Returns:
        The AssemblyLine GUID value.
        Throws:
        DIException - if an error occurs while obtaining the AssemblyLine GUID value.

      • isSimulating

        boolean isSimulating()
              throws DIException
        Check whether the AssemblyLine is simulating or not
        Returns:
        true if the AssemblyLine is simulating, false if it is not.
        Throws:
        DIException - if an error occurs while obtaining the simulation state

      • setSimulating

        void setSimulating​(boolean simulate)
            throws DIException
        Changes the way the AssemblyLine treats the target systems it is connecting/interacting to/with. Turning the simulation on will make the AssemblyLine use the SimulationConfig child of the AssemblyLineConfig in order to properly handle sensitive data.
        Parameters:
        simulate - true switches the simulation on, false switches it off
        Throws:
        DIException - if an error occurs while changing the simulation state

      • addListener

        void addListener​(AssemblyLineListener listener,
                 boolean getLogs,
                 boolean getEntryOnEachCycle)
          throws DIException
        Register a listener for AssemblyLine events. You must be admin to execute this method. Beware that there is no automatic removal of orphaned listeners.
        Parameters:
        listener - Listener for AssemblyLine events.
        getLogs - If true, the listener will receive logged messages.
        getEntryOnEachCycle - If true the listener will receive the current entry at each AssemblyLine cycle's end.
        Throws:
        DIException - If the listener cannot be registered.
        Since:
        7.0
        See Also:
        removeListener(AssemblyLineListener)

      • removeListener

        void removeListener​(AssemblyLineListener listener)
             throws DIException

        Unregister a listener for AssemblyLine events. You must be admin to execute this method. Listeners are associated with the API object, not with the AssemblyLine in the Server, so you can remove only listeners added with the #addListener(AssemblyLineListener, boolean) method on the same object.

        Beware that the listener may get notified one more time after it was unregistered. The only way to ensure this does not happen is to unregister the listener in one of its callback methods.

        Parameters:
        listener - The listener that needs to be removed.
        Throws:
        DIException - If the listener cannot be unregistered.
        Since:
        7.0
        See Also:
        #addListener(AssemblyLineListener, boolean)

      • attachDebugger

        void attachDebugger​(int port,
                    java.lang.String host,
                    boolean onerror)
             throws DIException
        Attach a debugger to the AssemblyLine. You must be admin to execute this method.
        Parameters:
        port - Port of the debugger.
        host - Host of the debugger.
        onerror - If true breakpoints are disabled except when there is an error.
        Throws:
        DIException - If the AssemblyLine is already being debugged or the AssemblyLine cannot connect to the debugger.
        Since:
        7.0

      • detachDebugger

        void detachDebugger​(java.lang.Object msg)
             throws DIException
        Detach the current debugger from the AssemblyLine. You must be admin to execute this method.
        Parameters:
        msg - This object will be sent to the debugger before the detaching occurs. Must be serializable. If null, nothing will be sent.
        Throws:
        DIException - If an error occurs while detaching the debugger.
        Since:
        7.0

      • getComponentDebugMode

        boolean getComponentDebugMode​(java.lang.String componentName)
                       throws DIException
        Query the debug mode setting of the specified component (Connector or Function Component). You must be admin to execute this method. A component will log debug level messages only if it is in debug mode. You can find out the names of the AssemblyLine components from the configuration - getConfig().
        Parameters:
        componentName - The name of a Connector or a Function Component from this AssemblyLine. Must be spelled exactly as it appears in the configuration.
        Returns:
        The debug mode of the component.
        Throws:
        DIException - If an error occurs while querying the debug mode.
        Since:
        7.0

      • setComponentDebugMode

        void setComponentDebugMode​(java.lang.String componentName,
                           boolean debug)
                    throws DIException
        Modify the debug mode setting of the specified component (Connector or Function Component). You must be admin to execute this method. Modifications are done on the fly and are not persisted in the configuration - getConfig(). If you run the same AssemblyLine again it will use the settings from the configuration.
        Parameters:
        componentName - The name of a Connector or a Function Component from this AssemblyLine.
        debug - The new debug mode of the component.
        Throws:
        DIException - If an error occurs while setting the debug mode.
        Since:
        7.0
        See Also:
        getComponentDebugMode(String)