Package org.jivesoftware.smack.websocket

Class XmppWebSocketTransportModuleDescriptor.Builder

java.lang.Object

org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor.Builder

org.jivesoftware.smack.websocket.XmppWebSocketTransportModuleDescriptor.Builder

Enclosing class:

XmppWebSocketTransportModuleDescriptor

public static final class XmppWebSocketTransportModuleDescriptor.Builder
extends ModularXmppClientToServerConnectionModuleDescriptor.Builder

Builder class for XmppWebSocketTransportModuleDescriptor.
To obtain an instance of XmppWebSocketTransportModuleDescriptor.Builder, use XmppWebSocketTransportModuleDescriptor.getBuilder(ModularXmppClientToServerConnectionConfiguration.Builder) method.
Use explicitlySetWebSocketEndpoint(URI) to configure the URI of an endpoint as a backup in case connection couldn't be established with endpoints through http lookup.
Use explicitlySetWebSocketEndpointAndDiscovery(URI, boolean) to configure endpoint and disallow websocket endpoint discovery through http lookup. By default, performWebSocketEndpointDiscovery is set to true.
Use build() to obtain XmppWebSocketTransportModuleDescriptor.

Method Summary

Modifier and Type	Method	Description
ModularXmppClientToServerConnectionModuleDescriptor	build()
XmppWebSocketTransportModuleDescriptor.Builder	disableImplicitWebsocketEndpoint()
XmppWebSocketTransportModuleDescriptor.Builder	explicitlySetWebSocketEndpoint(CharSequence endpoint)
XmppWebSocketTransportModuleDescriptor.Builder	explicitlySetWebSocketEndpoint(URI endpoint)
XmppWebSocketTransportModuleDescriptor.Builder	explicitlySetWebSocketEndpointAndDiscovery(CharSequence endpoint, boolean performWebSocketEndpointDiscovery)
XmppWebSocketTransportModuleDescriptor.Builder	explicitlySetWebSocketEndpointAndDiscovery(URI endpoint, boolean performWebSocketEndpointDiscovery)
XmppWebSocketTransportModuleDescriptor.Builder	setWebSocketFactory(WebSocketFactory webSocketFactory)

Methods inherited from class org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor.Builder

buildModule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

explicitlySetWebSocketEndpoint

public XmppWebSocketTransportModuleDescriptor.Builder explicitlySetWebSocketEndpoint(URI endpoint)

explicitlySetWebSocketEndpointAndDiscovery

public XmppWebSocketTransportModuleDescriptor.Builder explicitlySetWebSocketEndpointAndDiscovery(URI endpoint,
                                                                                                 boolean performWebSocketEndpointDiscovery)

explicitlySetWebSocketEndpoint

public XmppWebSocketTransportModuleDescriptor.Builder explicitlySetWebSocketEndpoint(CharSequence endpoint)
                                                                              throws URISyntaxException

Throws:

URISyntaxException

explicitlySetWebSocketEndpointAndDiscovery

public XmppWebSocketTransportModuleDescriptor.Builder explicitlySetWebSocketEndpointAndDiscovery(CharSequence endpoint,
                                                                                                 boolean performWebSocketEndpointDiscovery)
                                                                                          throws URISyntaxException

Throws:

URISyntaxException

disableImplicitWebsocketEndpoint

public XmppWebSocketTransportModuleDescriptor.Builder disableImplicitWebsocketEndpoint()

setWebSocketFactory

public XmppWebSocketTransportModuleDescriptor.Builder setWebSocketFactory(WebSocketFactory webSocketFactory)

build

public ModularXmppClientToServerConnectionModuleDescriptor build()

Specified by:

build in class ModularXmppClientToServerConnectionModuleDescriptor.Builder