IBM BJ0NJML Integration Guide - Page 169

CMDLINE Handler, setup command

Page 169 highlights

Handlers For example, the file name MX_MXASSETInterface_10971102668641398.xml indicates that the file was generated from a system to send data to the external system EXTSYS1. The file name also indicates that the file contains the MXASSETInterface publish channel. CMDLINE Handler The CMDLINE handler is a handler that takes a command and an endpoint as input. The CMDLINE handler uses the SSH protocol to run the command on the target system and return the results. The metadata parameter that is passed during a system invocation when the handler is called is a map that contains the name of the endpoint that represents the target system. The caller can target any system at run time when the system passes the endpoint to the command handler. The caller uses whatever configuration the endpoint has at the time of the system invocation. The CMDLINE handler has the following properties: T CMDTIMEOUT - The timeout value for command execution T CONNTIMEOUT - The timeout value for the connection T USERNAME - The user name for the connection T PASSWORD - The password for corresponding user name T HOST - The host name of target where command is run T PORTNO - The port number of target where the command is run T IGNORESETUPERR - The boolean value to ignore an error running the setup command T RETRYINTERVAL - The time to wait between retrying a command T MAXRETRY - The number of attempts to run a command before returning an exception T SSHEXIT - The Java exit class that can be implemented to customize processing of the handler The data parameter is a byte array representation of an XML document. The data parameter contains the following information: T The tags that correspond to the setup command T The working directory T The command to run T Any substitution parameters Endpoints and Handlers 155

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330

Handlers
Endpoints and Handlers
155
For example, the file name MX_MXASSETInterface_10971102668641398.xml
indicates that the file was generated from a system to send data to the external
system EXTSYS1. The file name also indicates that the file contains the
MXASSETInterface publish channel.
CMDLINE Handler
The CMDLINE handler is a handler that takes a command and an endpoint as
input. The CMDLINE handler uses the SSH protocol to run the command on the
target system and return the results.
The metadata parameter that is passed during a system invocation when the
handler is called is a map that contains the name of the endpoint that represents
the target system.
The caller can target any system at run time when the system
passes the endpoint to the command handler. The caller uses whatever
configuration the endpoint has at the time of the system invocation.
The CMDLINE handler has the following properties:
CMDTIMEOUT – The timeout value for command execution
CONNTIMEOUT – The timeout value for the connection
USERNAME – The user name for the connection
PASSWORD – The password for corresponding user name
HOST – The host name of target where command is run
PORTNO – The port number of target where the command is run
IGNORESETUPERR – The boolean value to ignore an error running the
setup command
RETRYINTERVAL – The time to wait between retrying a command
MAXRETRY – The number of attempts to run a command before
returning an exception
SSHEXIT – The Java exit class that can be implemented to customize
processing of the handler
The data parameter is a byte array representation of an XML document. The data
parameter contains the following information:
The tags that correspond to the setup command
The working directory
The command to run
Any substitution parameters