showWSNTopicDocument 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 showWSNTopicDocument command to show the contents of a WS-Notification topic namespace document.

We can show the contents of a WS-Notification topic namespace document by as described in this topic, or using the administrative console as described in Showing the contents of a WS-Notification topic namespace document.

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

The wsadmin scripting client is run from Qshell. For more information, see Configure Qshell to run WebSphere scripts .

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 shows the XML contents of a WS-Notification topic namespace document. There are two patterns for use of this command:

• The required topic namespace document is determined by the target topic namespace document.

• The required topic namespace document is determined by a combination of the target WS-Notification topic namespace, and the url provided as a parameter.

Target object

There are two choices for the target type of this command:

• WSNTopicDocument (explicitly nominates the topic namespace document to be shown).

• WSNTopicNamespace (determines the required WS-Notification topic namespace; must be used in combination with the url parameter).

Required parameters

None.

Conditional parameters

-url

The web address that was used to load the XML document. This parameter must be specified if the target type is WSNTopicNamespace, and must not be specified if a WSNTopicDocument target is supplied.

Optional parameters

None.

Examples

Show the contents of the topic namespace document newTopicDoc created in the example from topic "Applying a WS-Notification topic namespace document by ":

• Jython:
  AdminTask.showWSNTopicDocument(newTopicDoc)

• Jacl:
  $AdminTask showWSNTopicDocument $newTopicDoc

Show the contents of the topic namespace document newTopicDoc created in the example from topic "Applying a WS-Notification topic namespace document by ", by using the WSNTopicNamespace target pattern:

• Jython:
  AdminTask.showWSNTopicDocument(newTopicNamespace, ["-url", "http://www.example.org/instance_doc1.xml"])

• Jacl:
  $AdminTask showWSNTopicDocument $newTopicNamespace { -url http://www.example.org/instance_doc1.xml }

Related concepts

WS-Notification

Related tasks

Use WS-Notification for publish and subscribe messaging for web services

Secure WS-Notification

Showing the contents of a WS-Notification topic namespace document

WS-Notification troubleshooting tips

Related information:

Topic namespace document [Settings] Reference topic