createWSNServicePoint command

Use the createWSNServicePoint command to create a new WS-Notification service point. A WS-Notification service point defines access to a WS-Notification service on a given bus member through a specified web service binding (for example SOAP over HTTP). Applications use the bus members associated with the WS-Notification service point to connect to the WS-Notification service.

You can create a new WS-Notification service point by using the wsadmin tool as described in this topic, or by using the administrative console as described in Creating a new Version 6.1 WS-Notification service point and Creating a new Version 7.0 WS-Notification service point.

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')

After using the command, save your changes to the master configuration by using the following command:

AdminConfig.save()

Purpose

The existence of a WS-Notification service point on a bus member implies that a WS-Notification web service is exposed from that bus member, and causes web service endpoints for the notification broker, subscription manager and publisher registration manager for this WS-Notification service to be exposed on the bus member with which the service point is associated. WS-Notification applications use these endpoints to interact with the WS-Notification service.

This command creates the following resources:
  • It creates a new WS-Notification service point on a WS-Notification service.
  • For a Version 7.0 WS-Notification service point, it causes Web service endpoints for the three roles played by the broker to be exposed on the bus member.
  • For a Version 6.1 WS-Notification service point, it creates the three service integration bus inbound ports that represent the three roles played by the broker, it creates a service integration bus endpoint listener if required, and it connects the new or existing endpoint listener to the service integration bus with which the WS-Notification service is associated.
How you use this command depends upon the topology in which the command is being run. The topology determines the conditional parameters that you provide:
  • bus member type (server or cluster)
  • endpoint listener (create new or use existing) for Version 6.1 WS-Notification service points
If the service type is Version 7.0, do not specify the following optional parameters, which relate to JAX-RPC configuration:
-eplName
-eplURLRoot
-eplWSDLServingURLRoot
If the service type is Version 6.1, do not specify the following optional parameters, which relate to JAX-WS configuration:
-transportURLRoot
-transportSoapVersion
-jaxwsHandlerListNB
-jaxwsHandlerListSM
-jaxwsHandlerListPRM

You can only create service points for Version 7.0 WS-Notification services on WebSphere® Application Server Version 7.0 or later bus members. If the bus member is a cluster, then all servers in the cluster must be WebSphere Application Server Version 7.0 or later application servers.

You can create service points for Version 6.1 WS-Notification services on WebSphere Application Server Version 6.1 or later application servers.

Target object

WSNService

Required parameters

-name
The name of the WS-Notification service point. This appears as part of the address of the web service that is exposed on the chosen server.

Conditional parameters

Choose either a server or a cluster for the associated bus member:

-server
Name of the server on which the WS-Notification service point is created.
  • If you specify the copyServicePoint parameter, then you need not specify this parameter.
  • If this parameter is used then the node parameter must be specified, and the cluster parameter must not be specified.
-node
Name of the node on which the server is located.
  • If you specify the copyServicePoint parameter, then you need not specify this parameter.
  • If this parameter is used then the server parameter must be specified, and the cluster parameter must not be specified.
-cluster
Name of the cluster on which the WS-Notification service point is created.
  • If you specify the copyServicePoint parameter, then you need not specify this parameter.
  • If this parameter is used then the server and node parameters must not be specified.

For a Version 6.1 WS-Notification service, choose either to configure a new endpoint listener or use an existing one:

-eplName
Name of an endpoint listener.
  • If you specify the copyServicePoint parameter, then you need not specify this parameter.
  • If this endpoint listener has already been defined on the chosen server or cluster, then the eplURLRoot and eplWSDLServingURLRoot parameters should not be specified. Otherwise, the eplURLRoot and eplWSDLServingURLRoot parameters must both be specified.
Only specify this parameter for Version 6.1 WS-Notification services.
-eplURLRoot
Root of the externally visible endpoint address URL for web services that are accessed through this endpoint listener.
  • If you specify the copyServicePoint parameter, then you need not specify this parameter.
  • If the endpoint listener has already been defined on the chosen server or cluster, then this parameter should not be specified.
Only specify this parameter for Version 6.1 WS-Notification services.
-eplWSDLServingURLRoot
Root of the externally visible HTTP URL where the WSDL file associated with this endpoint listener is located. In most circumstances this is http://host_name:port_number/SIBWS. For more information, see Creating a new endpoint listener configuration or createSIBWSEndpointListener command.
  • If you specify the copyServicePoint parameter, then you need not specify this parameter.
  • If the endpoint listener has already been defined on the chosen server or cluster, then this parameter should not be specified.
Only specify this parameter for Version 6.1 WS-Notification services.

For a Version 7.0 WS-Notification service, configure the web service endpoint:

-transportURLRoot
Root of the externally visible endpoint address for the WS-Notification service point, in the following format:
protocol://host_nameport_number/service_location
where protocol is either http or https. For example:
http://myhostname:9080/ctx123/mySvc
You can use this parameter to associate a particular external web address with the WS-Notification service when you publish WSDL to a compressed file through the administrative console. Note that this address might not be the same as the address at which the WS-Notification service is exposed. This address is required when the WS-Notification service is accessed through a proxy.
If you do not specify this parameter, the underlying JAX-WS implementation creates an appropriate URL based on information provided as part of the service point installation process.
If you specify the copyServicePoint parameter, then you need not specify this parameter.
This attribute is the equivalent of the eplURLRoot parameter for service points created on Version 6.1 WS-Notification services. Only specify this parameter for Version 7.0 WS-Notification services.
-transportSoapVersion
Defines the version of SOAP supported by the service point. This affects the WSDL definition that will be exposed by the web service. Permitted values are 1.1 for SOAP 1.1 (the default), and 1.2 for SOAP 1.2.
If you specify the copyServicePoint parameter, then you need not specify this parameter.
Only specify this parameter for Version 7.0 WS-Notification services.

Copy the configuration from an existing WS-Notification service point definition:

-copyServicePoint
The name of an existing service point configured on the WS-Notification Service from which the other configuration attributes are copied. If you specify this parameter, then you only have to specify the name parameter. All other values are taken from the nominated existing service point.

Optional parameters

-description
An optional description of the WS-Notification service point.
-jaxwsHandlerListNB
The JAX-WS handler list that is applied to inbound requests from an application to the NotificationBroker endpoint of the WS-Notification service point.
If you specify the copyServicePoint parameter, then you need not specify this parameter.
Only specify this parameter for Version 7.0 WS-Notification services.
-jaxwsHandlerListSM
The JAX-WS handler list that is applied to inbound requests from an application to the SubscriptionManager endpoint of the WS-Notification service point.
If you specify the copyServicePoint parameter, then you need not specify this parameter.
Only specify this parameter for Version 7.0 WS-Notification services.
-jaxwsHandlerListPRM
The JAX-WS handler list that is applied to inbound requests from an application to the PublisherRegistrationManager endpoint of the WS-Notification service point.
If you specify the copyServicePoint parameter, then you need not specify this parameter.
Only specify this parameter for Version 7.0 WS-Notification services.

Examples

In the following examples, the WS-Notification service point uses the WS-Notification service newService created in the example from the topic about creating a new WS-Notification service by using the wsadmin tool.

Create a Version 6.1 WS-Notification service point on cluster1 that uses the existing endpoint listener SIBWSHTTPChannel1:

newServicePoint = AdminTask.createWSNServicePoint(newService, 
[-name, newServicePoint, -cluster, cluster1, -eplName, SIBWSHTTPChannel1] )

Create a Version 6.1 WS-Notification service point on server1 on node1 and create a new endpoint listener that uses SOAP over HTTP on channel 1, where the host address of the server is http://myHost:9080:

newServicePoint = AdminTask.createWSNServicePoint(newService, 
[-name, newServicePoint, -node, node1, -server, server1, -eplName, myNewEPL, 
-eplURLRoot, http://myhost:9080/wsn, -eplWSDLServingURLRoot, http://myhost:9080/sibws] )

Create a Version 7.0 WS-Notification service point on server1 on node1 (minimum set of parameters):

newServicePoint = AdminTask.createWSNServicePoint(newService, 
[-name, newServicePoint, -node, node1, -server, server1, 
-transportURLRoot, http://myhost:9080/myWSN] )

Create a Version 7.0 WS-Notification service point on server1 on node1 (full set of parameters):

newServicePoint = AdminTask.createWSNServicePoint(newService, 
[-name, newServicePoint, -node, node1, -server, server1, 
-transportURLRoot, http://myhost:9080/myWSN, -transportSoapVersion, 1.1, 
-jaxwsHandlerListNB, nbList, -jaxwsHandlerListSM, smList, -jaxwsHandlerListPRM, prmList] )