com.mulesoft.connectors.ws.internal.source

Class InboundMessageListener

java.lang.Object

org.mule.runtime.extension.api.runtime.source.Source<T,A>

com.mulesoft.connectors.ws.internal.source.PathSource<InputStream,InboundWebSocketAttributes>

com.mulesoft.connectors.ws.internal.source.InboundMessageListener

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable

@Alias(value="inbound-listener")
 @MediaType(value="*/*",
           strict=false)
 @DisplayName(value="On New Inbound Message")
 @Summary(value="Triggers when a message is received from an inbound WebSocket")
public class InboundMessageListener
extends PathSource<InputStream,InboundWebSocketAttributes>
implements org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Disposable

Exposes an endpoint through which external systems can connect through a WebSocket.

This source will trigger the owning flow each time one of those WebSockets send information to this server.

Additionally, any <websocket:on-inbound-connection> component with a matching path will also be triggered when that socket connection is established.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS

Fields inherited from class com.mulesoft.connectors.ws.internal.source.PathSource

config, connectionProvider, fluxCapacitor, path, webSocketServer

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
InboundMessageListener()

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	initialise()
void	onStart(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,InboundWebSocketAttributes> sourceCallback)
void	onStop()

Methods inherited from class com.mulesoft.connectors.ws.internal.source.PathSource

disengageFluxCapacitor, engageFluxCapacitor, resolvePath

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS

public static final String ALIAS

See Also:

Constant Field Values

Constructor Detail

InboundMessageListener

public InboundMessageListener()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

onStart

public void onStart(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,InboundWebSocketAttributes> sourceCallback)
             throws org.mule.runtime.api.exception.MuleException

Specified by:

onStart in class org.mule.runtime.extension.api.runtime.source.Source<InputStream,InboundWebSocketAttributes>

Throws:

org.mule.runtime.api.exception.MuleException

onStop

public void onStop()

Specified by:

onStop in class org.mule.runtime.extension.api.runtime.source.Source<InputStream,InboundWebSocketAttributes>

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable