Package com.predic8.membrane.core.interceptor.tunnel

Class WebSocketInterceptor

java.lang.Object

com.predic8.membrane.core.interceptor.AbstractInterceptor

com.predic8.membrane.core.interceptor.tunnel.WebSocketInterceptor

All Implemented Interfaces:

Interceptor

public class WebSocketInterceptor
extends AbstractInterceptor

Default

false

Description

Allow HTTP protocol upgrades to the WebSocket protocol. After the upgrade, the connection's data packets are simply forwarded and not inspected.

Nested Class Summary

Nested classes/interfaces inherited from interface com.predic8.membrane.core.interceptor.Interceptor

Interceptor.Flow

Field Summary

Fields inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

name, router

Constructor Summary

Constructors

Constructor	Description
WebSocketInterceptor()

Method Summary

Modifier and Type	Method	Description
List<WebSocketInterceptorInterface>	getInterceptors()
String	getShortDescription()
String	getUrl()
Outcome	handleRequest(Exchange exc)
void	init()	Called after parsing is complete and this has been added to the object tree (whose root is Router).
void	init(Router router)
void	setInterceptors(List<WebSocketInterceptorInterface> interceptors)
void	setUrl(String url)

Methods inherited from class com.predic8.membrane.core.interceptor.AbstractInterceptor

getDisplayName, getFlow, getHelpId, getLongDescription, getMessage, getRouter, getRule, handleAbort, handleResponse, setDisplayName, setFlow

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketInterceptor

public WebSocketInterceptor()

Method Details

init

public void init(Router router)
          throws Exception

Specified by:

init in interface Interceptor

Overrides:

init in class AbstractInterceptor

Throws:

Exception

init

public void init()
          throws Exception

Description copied from class: AbstractInterceptor

Called after parsing is complete and this has been added to the object tree (whose root is Router).

Overrides:

init in class AbstractInterceptor

Throws:

Exception

handleRequest

public Outcome handleRequest(Exchange exc)
                      throws Exception

Specified by:

handleRequest in interface Interceptor

Overrides:

handleRequest in class AbstractInterceptor

Throws:

Exception

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface Interceptor

Overrides:

getShortDescription in class AbstractInterceptor

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

Description

The URL the WebSocket connection will be forwarded to. The (host,port) pair specifies the target server. The (path,query) part are sent to the target server on the initial request. (For example, ActiveMQ listens on port 61614 and expects the incoming WebSocket connection to have a path '/' and empty query.)

Example

http://localhost:61614/

getInterceptors

public List<WebSocketInterceptorInterface> getInterceptors()

setInterceptors

public void setInterceptors(List<WebSocketInterceptorInterface> interceptors)