Graceful Adapter Shutdown

Sterling B2B Integrator supports clean adapter shutdown. That is, when stop adapter is issued, the system allows the adapter to clean up its own session before it gets removed from the system.

Only a few stateful adapters support this feature, for example, swiftAdapter.

The progress of shutting down the adapter can be viewed via UI pages. The progress information is available in the following pages:

  • In the System Troubleshooting page:
    • Soft Stop link > Stop All Adapters section
    • Adapters link
    • Clicking on the adapter name
  • In the Services Configuration page:
    • List and Search results
    • Clicking on the adapter name

Graceful Adapter Shutdown through the User Interface

The following steps can be performed in both the service configuration and adapters pages.
  • To get to the adapter page, click Operations > System > Troubleshooter > Adapters.
  • To get to the service configuration page, click Deployment > Services > Configuration, and then search for the adapter.

List the running stateful adapters by clicking the Adapter link.

  1. Shut down an adapter by de-selecting the checkbox under the Enable column.
    The following message appears in the Advanced State column:
    Stopping
  2. Click on the icon in the Advanced State column.

    A popup window appears with two sections:

    • System Audit Information

      This shows the status changes along with a timestamp of the whole shutdown process.

    • Adapter Advanced State Information

      When the adapter finishes its current session, and shutdown is completed, the following message appears:

      Adapter adapter_name is currently unavailable

Graceful Adapter Shutdown through the Command Line

  1. Navigate to the bin subdirectory of your installation directory.
  2. Shut down the adapter by running the command:

    opscmd.sh -cSTOPADAPTER -nnode1 -pid=adapter_name

  3. Check on the status of the shutdown by running the command:

    opscmd.sh -cGETADAPTERADVSTATE -nnode1 -pid=adapter_name

    Run this command until the status message changes from Adapter is preparing to shutdown to Adapter adapter_name is currently unavailable.
  4. Confirm that the adapter has been shut down by running the command:

    opscmd.sh -cGETADAPTERADVSTATE -nnode1 -pid=adapter_name

    The following message should appear:

    Adapter adapter_name is currently unavailable

    The adapter session is finished and shutdown is complete.