public interface UserData
Modifier and Type | Field and Description |
---|---|
static int |
ADD_DATA_FAILED_CONVERSION_ERROR
Error return code: UnsupportedEncodingException occurred converting the String data to Cp1047.
|
static int |
ADD_DATA_FAILED_DATA_LENGTH_ZERO
Error return code: User Data parameter length is zero.
|
static int |
ADD_DATA_FAILED_DATA_NULL
Error return code: User Data parameter is null.
|
static int |
ADD_DATA_FAILED_TOO_BIG
Error return code: User Data > 2K in length.
|
static int |
ADD_DATA_FAILED_TOO_MANY
Error return code: reached the maximum number of user data blocks per record.
|
static int |
ADD_DATA_OK
OK return code: New type and value was added.
|
static int |
ADD_DATA_REPLACED_DATA
OK return code: Data for this type was already set, previous data will be replaced by the new data.
|
static int |
CURRENT_USER_DATA_BLOCK_VERSION
Current user data block content version.
|
static int |
USER_DATA_MAX_COUNT
Maximum number of user data blocks.
|
static int |
USER_DATA_MAX_SIZE
Maximum size of a user data block.
|
Modifier and Type | Method and 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.
|
static final int ADD_DATA_OK
static final int ADD_DATA_REPLACED_DATA
static final int ADD_DATA_FAILED_TOO_BIG
static final int ADD_DATA_FAILED_TOO_MANY
static final int ADD_DATA_FAILED_DATA_NULL
static final int ADD_DATA_FAILED_DATA_LENGTH_ZERO
static final int ADD_DATA_FAILED_CONVERSION_ERROR
static final int USER_DATA_MAX_SIZE
static final int USER_DATA_MAX_COUNT
static final int CURRENT_USER_DATA_BLOCK_VERSION
int add(int identifier, byte[] dataBytes)
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.int add(int identifier, java.lang.String data)
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.