Running the IBM Integration API Deploy BAR file sample

Run the IBM® Integration API Deploy BAR file sample to deploy a BAR file to an integration server.

Before you begin

  • You must have an integration node and an integration server that are started.
  • You must have a BAR file.
    Windows platformNote: On Windows, the BAR file must be in the same directory as the IBM Integration API .bat sample files.

About this task

Use the Deploy BAR file sample to deploy a BAR file to an integration server, and display the outcome. The Deploy BAR file sample consists of two files:
  • A Java™ class: iapi.DeployBAR. This class is compiled into the IntegrationAPISamples.jar file that is used by the StartDeployBAR script. If you want to edit and recompile the class, you can find the Java source at the following location:
    • Windows platformOn Windows: install_dir\server\sample\IntegrationAPI\iapi\DeployBAR.java
    • Linux platformUNIX platformz/OS platformOn other platforms: install_dir/server/sample/IntegrationAPI/iapi/DeployBAR.java
    .
  • A script file that you use to call the Java code and pass the parameters that match your environment:
    • Windows platformOn Windows: install_dir\server\sample\IntegrationAPI\StartDeployBAR.bat
    • Linux platformUNIX platformz/OS platformOn other platforms: install_dir/server/sample/IntegrationAPI/StartDeployBAR

Procedure

  1. Run the Deploy BAR file sample by running the command for your platform:
    • Windows platformOn Windows, open the IBM Integration Console and run the following command:
      install_dir\server\sample\IntegrationAPI\StartDeployBAR.bat host_name port_number int_server_name bar_file_name
    • Linux platformUNIX platformz/OS platformOn other platforms:
      1. Start an integration node command environment by running mqsiprofile, or follow the guidance that is provided in the StartDeployBar shell script to configure the correct CLASSPATH for your environment.
      2. Run the shell script:
        install_dir/server/sample/IntegrationAPI/StartDeployBAR host_name port_number int_server_name bar_file_name
    where
    host_name
    Specifies the host name of the integration node; for example localhost.
    port_number
    Specifies the port number of the integration node; for example 4414.
    int_server_name
    Specifies the name of the integration server; for example default.
    bar_file_name
    Specifies the name of the BAR file; for example mybar.bar.
    The IBM Integration API connects to the integration node by using the host name and port that are specified. Next, the IBM Integration API deploys the specified BAR file to the specified integration server. The following message is displayed to confirm the actions.
    Connecting to the integration node running at host_name:port_number...
    Discovering integration server 'int_server_name'...
    Deploying bar_file_name...
    Result = success
  2. Check the results of the sample by viewing the integration node in the IBM Integration Toolkit, or by using the IBM Integration API Exerciser.

What to do next

Run another sample, or work with the IBM Integration API Exerciser.