9.8.1 Input adaptor definition

You specify an input adaptor definition as a child element of the adaptor group definition (InprocessGroupDefinition or RMIGroupDefinition tag) described in 9.7 Adaptor group definition in the adaptor configuration definition file.

You can specify a maximum of 64 input adaptor definitions. This definition is optional.

Organization of this subsection
(1) Format
(2) Details of definition

(1) Format

<InputAdaptorDefinition name="adaptor-name"
 interval="adaptor-execution-interval"
 charCode="{SJIS|MS932|EUC-JP|UTF-8|UTF-8-BOM|UTF-16BE|UTF-16BE-BOM|UTF-16LE|UTF-16LE-BOM}"
 lineFeed="{CR_LF|LF}">
 CB-definition
</InputAdaptorDefinition>

(2) Details of definition

InputAdaptorDefinition tag (all definition information)
Defines all input adaptor definition information.
name="adaptor-name"
Specifies a name for identifying the input adaptor, as 1 to 100 single-byte alphanumeric characters and the underscore (_). This name must begin with a single-byte alphabetic character. This attribute cannot be omitted. This adaptor name must be unique within the adaptor group definition.
interval="adaptor-execution-interval"
Specifies the interval (in milliseconds) during which the input adaptor is not executed, as an integer from 0 to 60000.
The input adaptor's processing is stopped for the specified interval following the time the final callback defined in the input adaptor is finished until the time the first callback is started. If 0 is specified, the input adaptor's processing is not stopped. If this attribute is omitted, 0 is assumed.
charCode="{SJIS|MS932|EUC-JP|UTF-8|UTF-8-BOM|UTF-16BE|UTF-16BE-BOM|UTF-16LE|UTF-16LE-BOM}"
Specifies the character encoding to be used at the input source. If this attribute is omitted, MS932 is assumed.
The table below shows the correspondences between the character encodings and the charCode attribute value.
Character encodingcharCode attribute value
Shift JISSJIS
MS932MS932
EUCEUC-JP
UTF-8 (without BOM)UTF-8
UTF-8 (with BOM)UTF-8-BOM
UTF-16 (without big endian BOM)UTF-16BE
UTF-16 (with big endian BOM)UTF-16BE-BOM
UTF-16 (without little endian BOM)UTF-16LE
UTF-16 (with little endian BOM)UTF-16LE-BOM
lineFeed="{CR_LF|LF}"
Specifies the linefeed code to be used at the input source. If this attribute is omitted, CR_LF is assumed.
The permitted values are as follows:
  • CR_LF
    Treats the combination of a CR (carriage return) and an LF (linefeed) as the linefeed code.
  • LF
    Treats an LF (linefeed) as the linefeed code.
CB-definition
You can specify the following CB definitions:
  • CB definition for input
  • CB definition for editing
  • CB definition for sending
For details about the CB definitions, see 9.9 CB definition in the adaptor configuration definition file.