Interface UserData


  • public interface UserData
    Interface to add user data to SMF 120 subtype 11 records. To get a UserData reference when the zosRequestLogging-1.0 feature is enabled, create a InitialContext and then look up com/ibm/websphere/zos/request/logging/UserData. InitialContext ic = new InitialContext(); UserData userData = (UserData) ic.lookup("com/ibm/websphere/zos/request/logging/UserData");
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int add​(int identifier, byte[] dataBytes)
      Used to provide data to be included in the user data section of the SMF 120 Subtype 11 record.
      int add​(int identifier, java.lang.String data)
      Used to provide data to be included in the user data section of the SMF 120 Subtype 11 record.
    • Field Detail

      • ADD_DATA_OK

        static final int ADD_DATA_OK
        OK return code: New type and value was added.
        See Also:
        Constant Field Values
      • ADD_DATA_REPLACED_DATA

        static final int ADD_DATA_REPLACED_DATA
        OK return code: Data for this type was already set, previous data will be replaced by the new data.
        See Also:
        Constant Field Values
      • ADD_DATA_FAILED_TOO_BIG

        static final int ADD_DATA_FAILED_TOO_BIG
        Error return code: User Data > 2K in length.
        See Also:
        Constant Field Values
      • ADD_DATA_FAILED_TOO_MANY

        static final int ADD_DATA_FAILED_TOO_MANY
        Error return code: reached the maximum number of user data blocks per record.
        See Also:
        Constant Field Values
      • ADD_DATA_FAILED_DATA_NULL

        static final int ADD_DATA_FAILED_DATA_NULL
        Error return code: User Data parameter is null.
        See Also:
        Constant Field Values
      • ADD_DATA_FAILED_DATA_LENGTH_ZERO

        static final int ADD_DATA_FAILED_DATA_LENGTH_ZERO
        Error return code: User Data parameter length is zero.
        See Also:
        Constant Field Values
      • ADD_DATA_FAILED_CONVERSION_ERROR

        static final int ADD_DATA_FAILED_CONVERSION_ERROR
        Error return code: UnsupportedEncodingException occurred converting the String data to Cp1047.
        See Also:
        Constant Field Values
      • USER_DATA_MAX_SIZE

        static final int USER_DATA_MAX_SIZE
        Maximum size of a user data block.
        See Also:
        Constant Field Values
      • USER_DATA_MAX_COUNT

        static final int USER_DATA_MAX_COUNT
        Maximum number of user data blocks.
        See Also:
        Constant Field Values
      • CURRENT_USER_DATA_BLOCK_VERSION

        static final int CURRENT_USER_DATA_BLOCK_VERSION
        Current user data block content version.
        See Also:
        Constant Field Values
    • Method Detail

      • add

        int add​(int identifier,
                byte[] dataBytes)
        Used to provide data to be included in the user data section of the SMF 120 Subtype 11 record.
        Parameters:
        identifier - Used to identify the owner of (and thus how to format) the user data. The value 0 is unused. The value 1 is reserved for use by WebSphere Application Server. Values <65535 are reserved for use by IBM. Values >= 65535 are available for use by customers. No more than 5 unique types of user data can be added to a single request's record. Subsequent additions of an already present user data type will overwrite the previous data of that type such that each user data type in a given request record shall be unique.
        dataBytes - The block of data to be included in the SMF 120 subtype 11 user data section. Length cannot exceed 2KB.
        Returns:
        Return code.
      • add

        int add​(int identifier,
                java.lang.String data)
        Used to provide data to be included in the user data section of the SMF 120 Subtype 11 record.
        Parameters:
        identifier - Used to identify the owner of (and thus how to format) the user data. The value 0 is unused. The value 1 is reserved for use by WebSphere Application Server. Values <65535 are reserved for use by IBM. Values >= 65535 are available for use by customers. No more than 5 unique types of user data can be added to a single request's record. Subsequent additions of an already present user data type will overwrite the previous data of that type such that each user data type in a given request record shall be unique.
        data - The block of data to be included in the SMF 120 subtype 11 user data section. Length cannot exceed 2KB.
        Returns:
        Return code.