com.ibm.broker.config.appdev

Class FlowRendererBAR

  • java.lang.Object
    • com.ibm.broker.config.appdev.FlowRendererBAR


  • public class FlowRendererBAR
    extends java.lang.Object

    The FlowRendererBAR class provides utility methods to allow the reading and writing of MessageFlow instances in the *.bar file format.

     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     xxxxx.x  2011-07-06  dstorey         v8.0.0.0 Release
     
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String copyright 
      static int CREATE_MODE 
      static int DELETE_MODE 
      static int FAILURE
      Represents a failure return code; required for CommandLine/ImbCmdmqsilist.cpp
      static int returnCode
      The command's return code; required for CommandLine/ImbCmdmqsilist.cpp
      static int SUCCESS
      Represents the successful return code; required for CommandLine/ImbCmdmqsilist.cpp
      static int UPDATE_MODE 
    • Constructor Summary

      Constructors 
      Constructor and Description
      FlowRendererBAR() 
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method and Description
      static void main(java.lang.String[] args)
      The main method, which is called when the program is invoked from the command line.
      static void write(java.util.ArrayList<java.lang.String> rootLocations, java.util.ArrayList<java.lang.String> sourceLocations, java.lang.String directoryName, java.lang.String fileName, int writeMode, boolean includeAllArtifacts)
      Create BAR file based on the provided source locations
      static void write(java.lang.String rootLocation, java.util.ArrayList<java.lang.String> sourceLocations, java.lang.String directoryName, java.lang.String fileName, int writeMode, boolean includeAllArtifacts)
      Create BAR file based on the provided source locations
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • SUCCESS

        public static final int SUCCESS
        Represents the successful return code; required for CommandLine/ImbCmdmqsilist.cpp
        See Also:
        Constant Field Values
      • FAILURE

        public static final int FAILURE
        Represents a failure return code; required for CommandLine/ImbCmdmqsilist.cpp
        See Also:
        Constant Field Values
      • returnCode

        public static int returnCode
        The command's return code; required for CommandLine/ImbCmdmqsilist.cpp
    • Constructor Detail

      • FlowRendererBAR

        public FlowRendererBAR()
    • Method Detail

      • write

        public static void write(java.lang.String rootLocation,
                                 java.util.ArrayList<java.lang.String> sourceLocations,
                                 java.lang.String directoryName,
                                 java.lang.String fileName,
                                 int writeMode,
                                 boolean includeAllArtifacts)
                          throws java.io.IOException,
                                 com.ibm.broker.MessageBrokerAPIException
        Create BAR file based on the provided source locations
        Parameters:
        rootLocation - Root location of the sources. If null, current directory will be used.
        sourceLocations - Relative path of supported files or directories (i.e. application, library, application domain).
        directoryName - The directory location to output the BAR file. Empty string is the current working directory.
        fileName - Name of the BAR file.
        writeMode - Three different modes are supported (CREATE_MODE(0), UPDATE_MODE(1), and DELETE_MODE(2)).
        includeAllArtifacts - If true, include all artifacts in the source locations.
        Throws:
        java.io.IOException
        com.ibm.broker.MessageBrokerAPIException
      • write

        public static void write(java.util.ArrayList<java.lang.String> rootLocations,
                                 java.util.ArrayList<java.lang.String> sourceLocations,
                                 java.lang.String directoryName,
                                 java.lang.String fileName,
                                 int writeMode,
                                 boolean includeAllArtifacts)
                          throws java.io.IOException,
                                 com.ibm.broker.MessageBrokerAPIException
        Create BAR file based on the provided source locations
        Parameters:
        rootLocations - A list of root locations of the sources. If null or empty, the current directory will be used.
        sourceLocations - Relative path of supported files or directories (i.e. application, library, application domain).
        directoryName - The directory location to output the BAR file. Empty string is the current working directory.
        fileName - Name of the BAR file.
        writeMode - Three different modes are supported (CREATE_MODE(0), UPDATE_MODE(1), and DELETE_MODE(2)).
        includeAllArtifacts - If true, include all artifacts in the source locations.
        Throws:
        java.io.IOException
        com.ibm.broker.MessageBrokerAPIException
      • main

        public static void main(java.lang.String[] args)
        The main method, which is called when the program is invoked from the command line.
        Parameters:
        args - the argument list, passed in from the command line.