org.jivesoftware.smack.websocket

Class XmppWebSocketTransportModuleDescriptor

java.lang.Object

org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor

org.jivesoftware.smack.websocket.XmppWebSocketTransportModuleDescriptor

public final class XmppWebSocketTransportModuleDescriptor
extends org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor

The descriptor class for XmppWebSocketTransportModule.
To add XmppWebSocketTransportModule to ModularXmppClientToServerConnection, use ModularXmppClientToServerConnectionConfiguration.Builder#addModule(ModularXmppClientToServerConnectionModuleDescriptor).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmppWebSocketTransportModuleDescriptor.Builder Builder class for XmppWebSocketTransportModuleDescriptor.

Constructor Summary

Constructors

Constructor and Description
XmppWebSocketTransportModuleDescriptor(XmppWebSocketTransportModuleDescriptor.Builder builder)

Method Summary

Modifier and Type	Method and Description
protected org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModule<? extends org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor>	constructXmppConnectionModule(org.jivesoftware.smack.c2s.internal.ModularXmppClientToServerConnectionInternal connectionInternal)
static XmppWebSocketTransportModuleDescriptor.Builder	getBuilder(org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionConfiguration.Builder connectionConfigurationBuilder) Returns a new instance of XmppWebSocketTransportModuleDescriptor.Builder.
java.net.URI	getExplicitlyProvidedUri() Returns explicitly configured websocket endpoint uri.
protected java.util.Set<java.lang.Class<? extends org.jivesoftware.smack.fsm.StateDescriptor>>	getStateDescriptors()
boolean	isWebSocketEndpointDiscoveryEnabled() Returns true if websocket endpoint discovery is true, returns false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmppWebSocketTransportModuleDescriptor

public XmppWebSocketTransportModuleDescriptor(XmppWebSocketTransportModuleDescriptor.Builder builder)

Method Detail

isWebSocketEndpointDiscoveryEnabled

public boolean isWebSocketEndpointDiscoveryEnabled()

Returns true if websocket endpoint discovery is true, returns false otherwise.

Returns:

boolean

getExplicitlyProvidedUri

public java.net.URI getExplicitlyProvidedUri()

Returns explicitly configured websocket endpoint uri.

Returns:

uri

getStateDescriptors

protected java.util.Set<java.lang.Class<? extends org.jivesoftware.smack.fsm.StateDescriptor>> getStateDescriptors()

Specified by:

getStateDescriptors in class org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor

constructXmppConnectionModule

protected org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModule<? extends org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor> constructXmppConnectionModule(org.jivesoftware.smack.c2s.internal.ModularXmppClientToServerConnectionInternal connectionInternal)

Specified by:

constructXmppConnectionModule in class org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor

getBuilder

public static XmppWebSocketTransportModuleDescriptor.Builder getBuilder(org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionConfiguration.Builder connectionConfigurationBuilder)

Returns a new instance of XmppWebSocketTransportModuleDescriptor.Builder.

Parameters:

connectionConfigurationBuilder - ModularXmppClientToServerConnectionConfiguration.Builder.

Returns:

Builder