Module ibm.zosrrs
Package com.ibm.zosrrs

Class RRS

java.lang.Object
com.ibm.zosrrs.RRS
public final class RRS extends Object
Class defines wrappers to selected RRS callable services. The underlying apis are documented in the publication: "Mvs Programming: Resource Recovery" - SA22-7616-05.

Since:
2.1.0

  • Field Details

  • Constructor Details

    • RRS

      public RRS()

  • Method Details

    • begin

      public static final BeginReturnType begin(int mode)
      Begins a transaction by calling the atrbeg API.
      Parameters:
      mode - The transaction mode (global/local)
      Returns:
      A structure containing the return code, UR token, etc.

    • end

      public static final EndReturnType end(int action, byte[] urToken)
      Ends a transaction by calling the atrend API.
      Parameters:
      action - commit/rollback
      urToken - The UR token to end, or null to end the current UR
      Returns:
      A structure containing the return code, diag area

    • retrieveSideInformationFast

      public static final RetrieveSideInformationFastReturnType retrieveSideInformationFast(byte[] ctxToken)
      Retrieves portions of the interest data from unauthorized address spaces. Calls the atrrusf1 api.
      Parameters:
      ctxToken - The context token containing the UR in question.
      Returns:
      The returned info values.

    • retrieveURData

      public static final RetrieveURDataReturnType retrieveURData(byte[] uriToken)
      Retrieves UR data by calling the atrrurd api.
      Parameters:
      uriToken - The UR interest token.
      Returns:
      The URID and state of the UR.

    • setEnvironment

      public static final EnvironmentReturnType setEnvironment(int envId, int envValue)
      Calls the Set_Environment RRS function (atrsenv).

      Convenience method for setting an environment value in the ATR_ADDRESS_SPACE_SCOPE, as an unauthorized caller (ATR_UNPROTECTED_SETTING).

      Parameters:
      envId -
      envValue -
      Returns:
      the return value and optional diagnosis area from the call
      Since:
      2.4.0

    • setEnvironment

      public static final EnvironmentReturnType setEnvironment(int scope, byte[] ctxToken, byte[] sToken, int elementCount, int[] envId, int[] envValue, int[] envProtection)
      Calls the Set_Environment RRS function (atrsenv). See the Resource Recovery manual cited in the class comment (RRS) for the acceptable parameter values.
      Parameters:
      scope - one of the ATR_XXX_SCOPE values
      ctxToken -
      sToken -
      elementCount -
      envId -
      envValue -
      envProtection -
      Returns:
      the return value and optional diagnosis area from the call
      Since:
      2.4.0