imqobjmgr(1m)

1imqobjmgr(1M)           System Administration Commands           imqobjmgr(1M)
2
3
4

NAME

6       imqobjmgr - manage Message Queue administered objects
7

SYNOPSIS

9       /usr/bin/imqobjmgr subcommand [[option]...]
10
11
12       /usr/bin/imqobjmgr -i fileName
13
14
15       /usr/bin/imqobjmgr -h | [-H] | -help | -Help
16
17
18       /usr/bin/imqobjmgr -v
19
20

DESCRIPTION

22       imqobjmgr manages Message Queue administered objects in an object store
23       accessible using JNDI. Administered objects allow  JMS  clients  to  be
24       provider-independent  by  insulating them from provider-specific naming
25       and configuration formats.
26
27
28       imqobjmgr supports five management subcommands. These subcommands,  and
29       their corresponding options follow the imqobjmgr command on the command
30       line. See USAGE and OPTIONS.
31
32
33       The following subcommands are supported:
34
35       add       Add a new administered object
36
37
38       delete    Delete an administered object
39
40
41       list      Display a list of administered objects
42
43
44       query     Display information about administered objects
45
46
47       update    Update administered objects
48
49
50
51       You can use the -i option to specify the name of  an  input  file  that
52       uses  java  property file syntax to represent all or part of any imqob‐
53       jmgr subcommand clause. The -f, -s, and -pre options can be  used  with
54       any imqobjmgr subcommand.
55

OPTIONS

57       The following options are supported:
58
59       -f                     Perform action without user confirmation.
60
61
62       -h | -help             Display  usage help. Execute nothing else on the
63                              command line.
64
65
66       -H | -Help              Display usage help, attribute list,  and  exam‐
67                              ples. Execute nothing else on the command line.
68
69
70       -i fileName            Specify the name of an input file containing all
71                              or part of  the  subcommand  clause,  specifying
72                              object  type,  lookup  name,  object attributes,
73                              object store attributes, or other  options.  Use
74                              this  option for repetitive information, such as
75                              object store attributes.
76
77
78       -j attribute=value     Specify attributes  necessary  to  identify  and
79                              access a JNDI object store.
80
81
82       -javahome              Specify  an  alternate Java 2 compatible runtime
83                              to use. imqobjmgr uses the runtime bundled  with
84                              the operating system by default.
85
86
87       -l lookupName          Specify  the JNDI lookup name of an administered
88                              object. This name must be unique in  the  object
89                              store's context.
90
91
92       -o attribute=value      Specify   the  attributes  of  an  administered
93                              object.
94
95
96       -pre                   Run command in preview mode. Preview mode  indi‐
97                              cates  what  will be done without performing the
98                              command.
99
100
101       -r read-only_state     Specify if an administered object is a read-only
102                              object.  A  value of true indicates the adminis‐
103                              tered object is a read-only object. JMS  clients
104                              cannot modify the attributes of read-only admin‐
105                              istered objects. The read-only state is  set  to
106                              false by default.
107
108
109       -s                     Silent mode. No output is displayed.
110
111
112       -t type                Specify the type of an administered object:
113
114                                q = queue
115                                t = topic
116                                cf = ConnectionFactory
117                                qf = queueConnectionFactory
118                                tf = topicConnectionFactory
119                                xcf = XA ConnectionFactory (distributed transactions)
120                                xqf = XA queueConnectionFactory (distributed transactions)
121                                xtf = XA topicConnectionFactory (distributed transactions)
122                                e = SOAP endpoint (used to support SOAP messaging)
123
124
125
126
127       -v                     Display  version  information.  Execute  nothing
128                              else on the command line.
129
130

USAGE

132       This  section  provides  information  on  subcommands,   options,   and
133       attribute value pairs.
134
135   Subcommands and Options
136       The following subcommands and corresponding options are supported:
137
138       add -t type -l lookupName [-o attribute=value]... - j
139       attribute=value...
140
141           Add a new administered object of the specified type, lookup name  ,
142           and object attributes to an object store.
143
144
145       delete -t type -l lookupName -j attribute=value...
146
147           Delete  an  administered  object,  of the specified type and lookup
148           name from an object store.
149
150
151       list [-t type] -j attribute=value...
152
153           Display a list of administered objects of a specified type, or  all
154           administered objects, in an object store.
155
156
157        query -l lookupName -j attribute=value...
158
159           Display  information  about  an  administered object of a specified
160           lookup name in an object store.
161
162
163       update -l lookupName [-o attribute=value]... -j attribute=value...
164
165           Update the specified attribute values of an administered object  of
166           the specified lookup name in an object store.
167
168
169   Attribute Value Pairs
170       The  following  attribute  value  pairs are supported for the specified
171       administered object types:
172
173
174       Type = ConnectionFactories: ConnectionFactory,  TopicConnectionFactory,
175       QueueConnectionFactory,  XAConnectionFactory, XATopicConnectionFactory,
176       and XAQueueConnectionFactory
177
178       imqAckOnAcknowledge
179
180           Value: String (true, false, not specified)
181
182           Default: not specified
183
184
185       imqAckOnProduce
186
187           Value: String (true, false, not specified)
188
189           Default: not specified
190
191
192       imqAckTimeout
193
194           Value: String (time in milliseconds)
195
196           Default: 0 (no timeout)
197
198
199       imqAddressList
200
201           Value: String
202
203           Default: not specified
204
205
206       imqAddressListBehavior
207
208           Value: String
209
210           Default: Priority
211
212
213       imqAddressListIterations
214
215           Value: Integer
216
217           Default: 1
218
219
220       imqBrokerHostName
221
222           Used if imqConnectionType is TCP or TLS.  This  attribute  type  is
223           only supported in Message Queue 3.0.
224
225           Value: String
226
227           Default:localhost
228
229
230       imqBrokerHostPort
231
232           Used  if  imqConnectionType  is  TCP or TLS. This attribute type is
233           only supported in Message Queue 3.0.
234
235           Value: Integer
236
237           Default: 7676
238
239
240       imqBrokerServicePort
241
242           Used if imqConnectionType is TCP or TLS.  This  attribute  type  is
243           only supported in Message Queue 3.0.
244
245           Value: Integer
246
247           Default: 0
248
249
250       imqConfiguredClientID
251
252           Value: String (ID number)
253
254           Default: no ID specified
255
256
257       imqConnectionFlowCount
258
259           Value: Integer
260
261           Default: 100
262
263
264       imqConnectionFlowLimit
265
266           Value: Integer
267
268           Default: 1000
269
270
271       imqConnectionFlowLimitEnabled
272
273           Value: Boolean
274
275           Default: false
276
277
278       imqConnectionType
279
280           This attribute type is only supported in Message Queue 3.0.
281
282           Value: String (TCP, TLS, HTTP).
283
284           Default: TCP
285
286
287       imqConnectionURL
288
289           Used if imqConnectionType is HTTP. This attribute type is only sup‐
290           ported in Message Queue 3.0.
291
292           Value: String
293
294           Default: http://localhost/imq/tunnel
295
296
297       imqConsumerFlowLimit
298
299           Value: Integer
300
301           Default: 1000
302
303
304       imqConsumerFlowThreshold
305
306           Value: Integer
307
308           Default: 50
309
310
311       imqDefaultPassword
312
313           Value: String
314
315           Default: guest
316
317
318       imqDefaultUsername
319
320           Value: String
321
322           Default: guest
323
324
325       imqDisableSetClientID
326
327           Value: Boolean
328
329           Default: false
330
331
332       imqJMSDeliveryMode
333
334           Value: Integer (1=non-persistent, 2=persistent)
335
336           Default: 2
337
338
339       imqJMSExpiration
340
341           Value: Long (time in milliseconds)
342
343           Default: 0 (does not expire)
344
345
346       imqJMSPriority
347
348           Value: Integer (0 to 9)
349
350           Default: 4
351
352
353       imqLoadMaxToServerSession
354
355           Value: Boolean
356
357           Default: true
358
359
360       imqOverrideJMSDeliveryMode
361
362           Value: Boolean
363
364           Default: false
365
366
367       imqOverrideJMSExpiration
368
369           Value: Boolean
370
371           Default: false
372
373
374       imqOverrideJMSHeadersToTemporaryDestinations
375
376           Value: Boolean
377
378           Default: false
379
380
381       imqOverrideJMSPriority
382
383            Value: Boolean
384
385           Default: false
386
387
388       imqQueueBrowserMaxMessagesPerRetrieve
389
390           Value: Integer
391
392           Default: 1000
393
394
395       imqBrowserRetrieveTimeout
396
397           Value: Long (time in milliseconds)
398
399           Default: 60,000
400
401
402       imqReconnectAttempts
403
404           Value: Integer
405
406           Default: 0
407
408
409       imqReconnectEnabled
410
411           Value: Boolean
412
413           Default: false
414
415
416       imqReconnectInterval
417
418            Value: Long (time in milliseconds)
419
420           Default: 3000
421
422
423       imqSetJMSXAppID
424
425           Value: Boolean
426
427           Default: false
428
429
430       imqSetJMSXConsumerTXID
431
432           Value: Boolean
433
434           Default: false
435
436
437       imqSetJMSXProducerTXID
438
439           Value: Boolean
440
441           Default: false
442
443
444        imqSetJMSXRcvTimestamp
445
446           Value: Boolean
447
448           Default: false
449
450
451        imqSetJMSXUserID
452
453           Value: Boolean
454
455           Default: false
456
457
458        imqSSLIsHostTrusted
459
460           Used if imqConnectionType is TLS. This attribute type is only  sup‐
461           ported in Message Queue 3.0.
462
463           Value: Boolean
464
465           Default: true
466
467
468
469       Type = Destinations: Topic and Queue
470
471       imqDestinationDescription    Value: String
472
473                                    Default: no description
474
475
476       imqDestinationName            Value: String
477
478                                    Default: Untitled_Destination_Object
479
480
481
482       Type = Endpoint (SOAP Endpoint)
483
484       imqEndpointDescription    Value: String
485
486                                 Default:   A  description  for  the  endpoint
487                                 object
488
489
490       imqEndpointName           Value: String
491
492                                 Default: Untitled_Endpoint_Object
493
494
495       imqSOAPEndpointList       Value: String (one  or  more  space-separated
496                                 URLs)
497
498                                 Default: no url
499
500

EXAMPLES

502       Example 1 Adding a Topic Administered Object to an Object Store
503
504
505       Where  JNDI lookup name=myTopic and imqDestinationName=MyTestTopic, the
506       following command adds to an LDAP server object store:
507
508
509         imqobjmgr add -t t -l "cn=myTopic"\
510         -o "imqDestinationName=MyTestTopic"\
511         -j "java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory"\
512         -j "java.naming.provider.url=ldap://mydomain.com:389/o=imq"
513
514
515
516
517       Where JNDI lookup name=myTopic and imqDestinationName=MyTestTopic,  the
518       following command adds to a file system object store:
519
520
521         imqobjmgr add -t -l "cn=myTopic"\
522         -o "imqDestinationName=MyTestTopic"\
523         -j \
524           "java.naming.factory.initial=com.sun.jndi.fscontext.RefFSContextFactory"\
525         -j "java.naming.provider.url=file:/home/foo/imq_admin_objects"
526
527
528
529
530       Where  JNDI lookup name=myTopic and imqDestinationName=MyTestTopic, the
531       following command adds to a file system object store,  using  an  input
532       file:
533
534
535         imqobjmgr -i inputfile
536
537
538
539
540       The associated input file consists of the following:
541
542
543         cmdtype=add
544         obj.type=t
545         obj.lookupName=cn=myTopic
546         obj.attrs.imqDestinationName=MyTestTopic
547         objstore.attrs.java.naming.factory.initial=com.sun.jndi.fscontext.\
548           RefFSContextFactory
549         objstore.attrs.java.naming.provider.url=file:/home/foo/imq_admin_objects
550
551
552       Example  2  Adding  a  QueueConnectionFactory Administered Object to an
553       Object Store
554
555
556       Where   JNDI   lookup   name=myQCF,   read-only   state=true,    imqAd‐
557       dressList=mq://foohost:777/jms,  the  following command adds to an LDAP
558       server object store:
559
560
561         imqobjmgr add -t qf -l "cn=myQCF" -r true\
562
563         -o "imqAddressList=mq://foohost:777/jms"\
564         -j "java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory"\
565         -j "java.naming.provider.url=ldap://mydomain.com:389/o=imq"\
566
567
568
569
570       Where   JNDI   lookup   name=myQCF,   read-only   state=true,    imqAd‐
571       dressList=mq://foohost:777/jms,  the  following command adds to an LDAP
572       server object store using an input file:
573
574
575         imqobjmgr -i inputfile
576
577
578
579
580       The associated input file consists of the following:
581
582
583         cmdtype=add
584         obj.type=qf
585         obj.lookupName=cn=myQCF
586         obj.readOnly=true
587         obj.attrs.imqAddressList=mq://foohost:777/jms
588         objstore.attrs.java.naming.factory.initial=com.sun.jndi.\
589           ldap.LdapCtxFactory
590         objstore.attrs.java.naming.provider.url=ldap://mydomain.com:389/o=imq
591
592
593
594       Where   JNDI   lookup   name=myQCF,   read-only   state=true,    imqAd‐
595       dressList=mq://foohost:777/jms,  the  following command adds to an LDAP
596       server object store, using both an input file and command options:
597
598
599         imqobjmgr add -t qf -l "cn=myQCF"\
600         -o "imqAddressList=mq://foohost:777/jms"\
601         -i inputfile
602
603
604
605
606       The associated input file consists of the following:
607
608
609         objstore.attrs.java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory
610         objstore.attrs.java.naming.provider.url=ldap://mydomain.com:389/o=imq
611
612
613       Example 3 Deleting a Topic Administered Object from an Object Store
614
615
616       Where JNDI lookup name=myTopic and no confirmation  is  requested,  the
617       following command deletes from an LDAP server object store:
618
619
620         imqobjmgr delete -f -l "cn=myTopic"\
621         -j "java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory"\
622         -j "java.naming.provider.url=ldap://mydomain.com:389/o=imq"
623
624
625
626       Example 4 Querying Information About a Topic Administered Object
627
628
629       Where  JNDI  lookup name=myTopic, the following command queries from an
630       LDAP server object store using simple authentication scheme:
631
632
633         imqobjmgr query -l "cn=myTopic"\
634         -j "java.naming.factory.initial=com.sun.jndi.ldap.LdapCtxFactory"\
635         -j "java.naming.provider.url=ldap://mydomain.com:389/o=imq"\
636         -j "java.naming.security.authentication=simple"\
637         -j "java.naming.security.principal=uid=foo,ou=imqobjmgr,o=imq"\
638         -j "java.naming.security.credentials=foo"
639
640
641

EXIT STATUS

643       The following exit values are returned:
644
645       0     Successful completion.
646
647
648       >0    An error occurred.
649
650

ATTRIBUTES

652       See attributes(5) for descriptions of the following attributes:
653
654
655
656
657       ┌─────────────────────────────┬─────────────────────────────┐
658       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
659       ├─────────────────────────────┼─────────────────────────────┤
660       │Availability                 │SUNWiqu                      │
661       └─────────────────────────────┴─────────────────────────────┘
662