listWSNAdministeredSubscribers command

Use the listWSNAdministeredSubscribers command to list the WS-Notification administered subscribers in the configuration of the target WS-Notification service point that match the specified input parameters. An administered subscriber provides a mechanism for the WS-Notification service point to subscribe to an external notification producer at server startup time.

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 administered subscribers in the configuration of the target WS-Notification service point that match the specified input parameters. You can use this command to obtain a reference to one or more administered subscribers that have already been created in the configuration in order to work with the administered subscriber further, for example to delete the definition.

Target object

WSNServicePoint

Required parameters

None.

Conditional parameters

None.

Optional parameters

-endpoint
The remote web service endpoint by which the list is filtered. That is, the endpoint reference (web address) of a notification producer or notification broker application. For example http://remoteproducer.com.
-topic
Topic expression describing the class of notification messages by which the list is filtered. This describes the class of notification messages that are delivered to the WS-Notification service point. For example stock/IBM. This property can include wildcards if they are supported by the topic dialect that you select.
-topicNamespace
The namespace URI by which the list is filtered.
-dialect
The dialect in which the topic is expressed. That is, the name of the chosen topic dialect as defined by the WS-Topics standard, by which the list is filtered. Values of this parameter are SIMPLE, CONCRETE, FULL.

Examples

Obtain a reference to the first administered subscriber defined against the newServicePoint object:
  • Using Jython:
    wsnSubscriberList = AdminTask.listWSNAdministeredSubscribers(newServicePoint)
wsnSubscriber = wsnSubscriberList.split("\n")[0].rstrip()
  • Using Jacl:
    set wsnSubscriberList [$AdminTask listWSNAdministeredSubscribers $newServicePoint]
set wsnSubscriber [ lindex $wsnSubscriberList 0 ]
Obtain a reference to the first administered subscriber defined against the newServicePoint object with a given topic:
  • Using Jython:
    wsnSubscriberList = AdminTask.listWSNAdministeredSubscribers(newServicePoint, ["-topic", "stock"])
wsnSubscriber = wsnSubscriberList.split("\n")[0].rstrip()
  • Using Jacl:
    set wsnSubscriberList [$AdminTask listWSNAdministeredSubscribers $newServicePoint {-topic stock}]
set wsnSubscriber [ lindex $wsnSubscriberList 0 ]