Package org.jivesoftware.smack.websocket

Class XmppWebSocketTransportModuleDescriptor

java.lang.Object

org.jivesoftware.smack.c2s.ModularXmppClientToServerConnectionModuleDescriptor

org.jivesoftware.smack.websocket.XmppWebSocketTransportModuleDescriptor

public final class XmppWebSocketTransportModuleDescriptor
extends 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	Description
static class	XmppWebSocketTransportModuleDescriptor.Builder	Builder class for XmppWebSocketTransportModuleDescriptor.

Constructor Summary

Constructors

Constructor	Description
XmppWebSocketTransportModuleDescriptor(XmppWebSocketTransportModuleDescriptor.Builder builder)

Method Summary

Modifier and Type	Method	Description
protected ModularXmppClientToServerConnectionModule<? extends ModularXmppClientToServerConnectionModuleDescriptor>	constructXmppConnectionModule(ModularXmppClientToServerConnectionInternal connectionInternal)
static XmppWebSocketTransportModuleDescriptor.Builder	getBuilder(ModularXmppClientToServerConnectionConfiguration.Builder connectionConfigurationBuilder)	Returns a new instance of XmppWebSocketTransportModuleDescriptor.Builder.
URI	getExplicitlyProvidedUri()	Returns explicitly configured websocket endpoint uri.
protected Set<Class<? extends StateDescriptor>>	getStateDescriptors()
boolean	isImplicitWebSocketEndpointEnabled()
boolean	isWebSocketEndpointDiscoveryEnabled()	Returns true if websocket endpoint discovery is true, returns false otherwise.
protected void	validateConfiguration(ModularXmppClientToServerConnectionConfiguration configuration)

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

validateConfiguration

protected void validateConfiguration(ModularXmppClientToServerConnectionConfiguration configuration)

Overrides:

validateConfiguration in class ModularXmppClientToServerConnectionModuleDescriptor

isWebSocketEndpointDiscoveryEnabled

public boolean isWebSocketEndpointDiscoveryEnabled()

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

Returns:

boolean

isImplicitWebSocketEndpointEnabled

public boolean isImplicitWebSocketEndpointEnabled()

getExplicitlyProvidedUri

public URI getExplicitlyProvidedUri()

Returns explicitly configured websocket endpoint uri.

Returns:

uri

getStateDescriptors

protected Set<Class<? extends StateDescriptor>> getStateDescriptors()

Specified by:

getStateDescriptors in class ModularXmppClientToServerConnectionModuleDescriptor

constructXmppConnectionModule

protected ModularXmppClientToServerConnectionModule<? extends ModularXmppClientToServerConnectionModuleDescriptor> constructXmppConnectionModule(ModularXmppClientToServerConnectionInternal connectionInternal)

Specified by:

constructXmppConnectionModule in class ModularXmppClientToServerConnectionModuleDescriptor

getBuilder

public static XmppWebSocketTransportModuleDescriptor.Builder getBuilder(ModularXmppClientToServerConnectionConfiguration.Builder connectionConfigurationBuilder)

Returns a new instance of XmppWebSocketTransportModuleDescriptor.Builder.

Parameters:

connectionConfigurationBuilder - ModularXmppClientToServerConnectionConfiguration.Builder.

Returns:

Builder