listWSNTopicDocuments command

A topic namespace can optionally have topic namespace documents applied to it that define the structure of the topics that are permitted within the namespace. Use the listWSNTopicDocuments command to list the topic namespace documents in the configuration of the target WS-Notification topic namespace that match the specified input parameters.

To run the command, use the AdminTask object of the wsadmin scripting client.

[IBM i][IBM i]The wsadmin scripting client is run from Qshell.

Command-line help is provided for service integration bus commands:
  • For a list of the available WS-Notification commands, plus a brief description of each command, enter the following command at the wsadmin prompt:

    print AdminTask.help('WSNotificationCommands')

  • For overview help on a given command, enter the following command at the wsadmin prompt:

    print AdminTask.help('command_name')

Purpose

This command lists all the topic namespace documents in the configuration of the target WS-Notification topic namespace that match the specified input parameters. This command can be used to obtain a reference to one or more topic namespace documents that have already been created in the configuration in order to work with the topic namespace document further, for example to delete the definition.

Target object

WSNTopicNamespace documents that match the requested pattern.

Required parameters

None.

Conditional parameters

None.

Optional parameters

-url
The web address that was used to load the XML document.

Examples

Obtain a reference to the first topic namespace document defined against the newTopicNamespace object.
  • Using Jython:
    wsnDocList = AdminTask.listWSNTopicDocuments(newTopicNamespace)
wsnTopicDoc = wsnDocList.split("\n")[0].rstrip()
  • Using Jacl:
    set wsnDocList [$AdminTask listWSNTopicDocuments $newTopicNamespace]
set wsnTopicDoc [ lindex $wsnDocList 0 ]
Obtain a reference to the first topic namespace document defined against the newTopicNamespace object with a given URL.
  • Using Jython:
    wsnDocList = AdminTask.listWSNTopicDocuments(newTopicNamespace,
 ["-url", "http://www.example.org/instance_doc1.xml"])
wsnTopicDoc = wsnDocList.split("\n")[0].rstrip()
  • Using Jacl:
    set wsnDocList [$AdminTask listWSNTopicDocuments $newTopicNamespace 
{-url http://www.example.org/instance_doc1.xml}]
set wsnDoc [ lindex $wsnDocList 0 ]