Package io.mangoo.routing.routes

Class WebSocketRoute

java.lang.Object

io.mangoo.routing.routes.WebSocketRoute

All Implemented Interfaces:

MangooRoute

public class WebSocketRoute
extends Object
implements MangooRoute

Author:

svenkubiak

Constructor Summary

Constructors

Constructor	Description
WebSocketRoute()

Method Summary

Modifier and Type	Method	Description
Class<?>	getControllerClass()
String	getUrl()
boolean	hasAuthentication()
WebSocketRoute	onController(Class<?> clazz)	Sets the controller class for this WebSocket route
WebSocketRoute	to(String url)	Sets the URL for this route
void	withAuthentication()	Sets authentication to true, default is false

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketRoute

public WebSocketRoute()

Method Details

to

public WebSocketRoute to(String url)

Sets the URL for this route

Parameters:

url - The URL for this WebSocket route

Returns:

WebSocketRoute instance

onController

public WebSocketRoute onController(Class<?> clazz)

Sets the controller class for this WebSocket route

Parameters:

clazz - The controller class

Returns:

WebSocketRoute instance

withAuthentication

public void withAuthentication()

Sets authentication to true, default is false

getUrl

public String getUrl()

Specified by:

getUrl in interface MangooRoute

Returns:

The configured URL for this route

hasAuthentication

public boolean hasAuthentication()

getControllerClass

public Class<?> getControllerClass()