Integration Server 10.11 | Built-In Services Reference Guide | Client Folder | Summary of Elements in this Folder | pub.client:websocket
 
pub.client:websocket
WmPublic. Establishes a WebSocket connection to the URL captured in the identified WebSocket client endpoint.
Input Parameters
nsName
String Namespace name of the WebSocket client endpoint.
headers
Record Optional. Headers that are part of the HTTP request used to establish the WebSocket connection.
Key
Description
name
The name of the header.
value
The value of the header
auth
String Authentication information that the pub.client:websocket service will submit to the URL in WebSocket client endpoint.
Key
Description
type
String Type of authentication scheme that you want this service to use when it submits this request. Set to:.
basic to submit a username and password.
username
String Username that this service will submit when requesting a protected resource.
password
String Password associated with user.
secure
String Optional. Parameters specifying the truststore information for certificate validation that Integration Serveruses when communicating with the WebSocket server port:
Key
Description
truststoreAlias
String Alias for the truststore that contains the list of certificates that Integration Server uses to validate the trust relationship. If you do not specify a truststore alias, the default truststore alias specified in the watt.security.trustStoreAlias property will be used.
connectTimeout
String Optional. Time (measured in milliseconds) the server will wait to connect to the remote server before timing out and terminating the request.
If a value for connectTimeout is not specified, Integration Server uses the value specified for the watt.net.timeout server configuration parameter. If no value is specified for the watt.net.timeout server configuration parameter, the server will wait for the timeout value defined by the operating system before terminating the connection request. For more information about the watt.net.timeout server configuration parameter, see webMethods Integration Server Administrator’s Guide.
cookies
String Optional. The cookies which are to be part of the HTTP request used to establish a WebSocket connection.
extensions
String Optional. The extensions which are to be part of the HTTP request used to establish a WebSocket connection.
subProtocols
String Optional. The subprotocols which are to be part of the HTTP request used to establish a WebSocket connection.
Output Parameters
sessionId
String Session ID to identify the WebSocket session.