State diagram summary for the IBM Storage Protect API

Once you review all the considerations for creating your own application with the IBM® Storage Protect API, review this state diagram summary of an entire application.

Figure 1 contains the state diagram for the API. It contains all previously displayed state diagrams in addition to several other calls previously not displayed.

The points in this diagram include:

  • Call dsmQueryApiVersionEx at any time. It has no state associated with it. See Figure 1 for an example.
  • Call dsmQueryCliOptions before a dsmInitEx call only.
  • Use dsmRegisterFS, dsmUpdateFS, and dsmDeleteFS to manage file spaces. These calls are made from within an idle session state. Use the dsmBeginQuery call to query file spaces. For more information about file space calls, see Managing file spaces.
  • Send the dsmBindMC call from within an idle session state or from within a send object transaction state. See the example in Figure 1.
  • Send the dsmChangePW call from within an idle session state.
    Note: If the dsmInitEx call returns with a password-expired return code, the dsmChangePW call must be made before you start a valid session. See Figure 3 for an example that uses dsmChangePW.
  • If a call returns with an error, the state remains as it was. For example, if dsmGetObj returns with an error, the state remains In Get Data, and a call to dsmEndGetObj is a call sequence error.
Figure 1. Summary state diagram for the API
Summary state diagram for the API