org.spincast.plugins.undertow

Class SpincastUndertowServer

java.lang.Object

org.spincast.plugins.undertow.SpincastUndertowServer

All Implemented Interfaces:

Server

public class SpincastUndertowServer
extends Object
implements Server

Server implementation for Undertow.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger
static String	UNDERTOW_EXCEPTION_CODE_REQUEST_TOO_LARGE

Constructor Summary

Constructors

Constructor and Description

SpincastUndertowServer(SpincastConfig config, SpincastUndertowConfig spincastUndertowConfig, FrontController frontController, SpincastUtils spincastUtils, CookieFactory cookieFactory, CorsHandlerFactory corsHandlerFactory, GzipCheckerHandlerFactory gzipCheckerHandlerFactory, SkipResourceOnQueryStringHandlerFactory skipResourceOnQueryStringHandlerFactory, SpincastResourceHandlerFactory spincastResourceHandlerFactory, CacheBusterRemovalHandlerFactory cacheBusterRemovalHandlerFactory, FileClassPathResourceManagerFactory fileClassPathResourceManagerFactory, SpincastHttpAuthIdentityManagerFactory spincastHttpAuthIdentityManagerFactory, WebsocketEndpointFactory spincastWebsocketEndpointFactory, SSLContextFactory sslContextFactory, ServerUtils serverUtils) Constructor

Method Summary

Modifier and Type	Method and Description
protected io.undertow.Undertow.Builder	addBuilderOptions(io.undertow.Undertow.Builder builder)
void	addCookies(Object exchange, Map<String,Cookie> cookies)
void	addHttpAuthentication(String realmName, String username, String password)
protected void	addHttpListener(io.undertow.Undertow.Builder builder, String serverHost, int httpServerPort)
protected void	addHttpsListener(io.undertow.Undertow.Builder builder, String serverHost, int httpsServerPort)
void	addStaticResourceToServe(StaticResource<?> staticResource)
protected io.undertow.server.HttpServerExchange	castExchange(Object exchange)
void	createHttpAuthenticationRealm(String pathPrefix, String realmName)
protected Path	createUndertowTempDir()
protected WebsocketEndpointHandler	createUndertowWebsocketEndpointHandler(String endpointId, WebsocketEndpointHandler appHandler)
void	end(Object exchange)
void	flushBytes(Object exchange, byte[] bytes, boolean end)
boolean	forceRequestSizeValidation(Object exchangeObj)
protected CacheBusterRemovalHandler	getCacheBusterRemovalHandler() Handler to remove cache busters from the request's URL.
protected CacheBusterRemovalHandlerFactory	getCacheBusterRemovalHandlerFactory()
protected io.undertow.io.IoCallback	getCloseExchangeCallback()
protected SpincastConfig	getConfig()
ContentTypeDefaults	getContentTypeBestMatch(Object exchangeObj)
protected String	getCookieEncoding()
protected CookieFactory	getCookieFactory()
Map<String,String>	getCookies(Object exchange)
protected CorsHandlerFactory	getCorsHandlerFactory()
protected io.undertow.io.IoCallback	getDoNothingCallback()
protected FileClassPathResourceManagerFactory	getFileClassPathResourceManagerFactory()
protected io.undertow.server.HttpHandler	getFinalHandler() The very first handler considered by Undertow.
protected io.undertow.server.handlers.form.FormData	getFormData(io.undertow.server.HttpServerExchange exchange) May return NULL.
Map<String,List<String>>	getFormData(Object exchangeObj)
protected io.undertow.server.handlers.form.FormParserFactory	getFormParserFactory()
protected FrontController	getFrontController()
String	getFullUrlOriginal(Object exchangeObj)
String	getFullUrlOriginal(Object exchangeObj, boolean keepCacheBusters)
String	getFullUrlProxied(Object exchangeObj)
String	getFullUrlProxied(Object exchangeObj, boolean keepCacheBusters)
protected GzipCheckerHandlerFactory	getGzipCheckerHandlerFactory()
protected Map<String,String>	getHttpAuthActiveRealms()
protected io.undertow.server.handlers.PathHandler	getHttpAuthenticationHandler() Handler to check for HTTP authentication requirement.
Map<String,String>	getHttpAuthenticationRealms()
protected io.undertow.server.HttpHandler	getHttpAuthHandlerNextHandler()
protected Map<String,SpincastHttpAuthIdentityManager>	getHttpAuthIdentityManagersByRealmName()
HttpMethod	getHttpMethod(Object exchange)
String	getIp(Object exchangeObj)
protected int	getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()
protected SpincastHttpAuthIdentityManager	getOrCreateHttpAuthIdentityManagersByRealmName(String realmName)
Map<String,List<String>>	getQueryStringParams(Object exchange)
InputStream	getRawInputStream(Object exchangeObj)
protected String	getRealmNameToDisplay(String pathPrefix, String realmName) The realm name to display.
Map<String,List<String>>	getRequestHeaders(Object exchangeObj) The names of the headers are case insensitive.
String	getRequestScheme(Object exchange)
Map<String,List<String>>	getResponseHeaders(Object exchangeObj)
protected int	getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()
protected io.undertow.Undertow.Builder	getServerBuilder()
protected int	getServerStartTryNbr()
protected ServerUtils	getServerUtils()
protected SkipResourceOnQueryStringHandlerFactory	getSkipResourceOnQueryStringHandlerFactory()
protected io.undertow.server.HttpHandler	getSpincastFrontControllerHandler()
protected SpincastHttpAuthIdentityManagerFactory	getSpincastHttpAuthIdentityManagerFactory()
protected SpincastResourceHandlerFactory	getSpincastResourceHandlerFactory()
protected SpincastUndertowConfig	getSpincastUndertowConfig()
protected SpincastUtils	getSpincastUtils()
protected WebsocketEndpointFactory	getSpincastWebsocketEndpointFactory()
protected SSLContextFactory	getSslContextFactory()
protected long	getStartServerSleepMilliseconds()
StaticResource<?>	getStaticResourceServed(String urlPath)
protected io.undertow.server.handlers.PathHandler	getStaticResourcesPathHandler()
Set<StaticResource<?>>	getStaticResourcesServed()
protected Map<String,StaticResource<?>>	getStaticResourcesServedByUrlPath()
Map<String,List<UploadedFile>>	getUploadedFiles(Object exchangeObj)
protected Object	getWebsocketEndpointCreationLock(String endpointId) Gets the creation/close lock for a specific Websocket endpoint.
WebsocketEndpointManager	getWebsocketEndpointManager(String endpointId)
List<WebsocketEndpointManager>	getWebsocketEndpointManagers()
protected Map<String,WebsocketEndpoint>	getWebsocketEndpointsMap()
boolean	isResponseClosed(Object exchange)
boolean	isResponseHeadersSent(Object exchange)
boolean	isRunning()
void	removeAllStaticResourcesServed()
void	removeHttpAuthentication(String username)
void	removeHttpAuthentication(String username, String realmName)
void	removeResponseHeader(Object exchange, String name)
protected void	removeStaticResource(StaticResourceType staticResourceType, String urlPath)
void	removeStaticResourcesServed(StaticResourceType staticResourceType, String urlPath)
protected void	sendWebsocketEnpointsClosedWhenServerStops()
void	setResponseHeader(Object exchangeObj, String name, List<String> values)
void	setResponseHeaders(Object exchange, Map<String,List<String>> headers)
void	setResponseStatusCode(Object exchange, int statusCode)
void	start()
void	stop()
void	stop(boolean sendClosingMessageToPeers)
void	websocketCloseEndpoint(String endpointId)
void	websocketCloseEndpoint(String endpointId, int closingCode, String closingReason)
void	websocketConnection(Object exchangeObj, String endpointId, String peerId)
WebsocketEndpointManager	websocketCreateEndpoint(String endpointId, WebsocketEndpointHandler appEndpointHandler)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

UNDERTOW_EXCEPTION_CODE_REQUEST_TOO_LARGE

public static final String UNDERTOW_EXCEPTION_CODE_REQUEST_TOO_LARGE

See Also:

Constant Field Values

Constructor Detail

SpincastUndertowServer

@Inject
public SpincastUndertowServer(SpincastConfig config,
                                       SpincastUndertowConfig spincastUndertowConfig,
                                       FrontController frontController,
                                       SpincastUtils spincastUtils,
                                       CookieFactory cookieFactory,
                                       CorsHandlerFactory corsHandlerFactory,
                                       GzipCheckerHandlerFactory gzipCheckerHandlerFactory,
                                       SkipResourceOnQueryStringHandlerFactory skipResourceOnQueryStringHandlerFactory,
                                       SpincastResourceHandlerFactory spincastResourceHandlerFactory,
                                       CacheBusterRemovalHandlerFactory cacheBusterRemovalHandlerFactory,
                                       FileClassPathResourceManagerFactory fileClassPathResourceManagerFactory,
                                       SpincastHttpAuthIdentityManagerFactory spincastHttpAuthIdentityManagerFactory,
                                       WebsocketEndpointFactory spincastWebsocketEndpointFactory,
                                       SSLContextFactory sslContextFactory,
                                       ServerUtils serverUtils)

Constructor

Method Detail

getConfig

protected SpincastConfig getConfig()

getSpincastUndertowConfig

protected SpincastUndertowConfig getSpincastUndertowConfig()

getFrontController

protected FrontController getFrontController()

getSpincastUtils

protected SpincastUtils getSpincastUtils()

getCookieFactory

protected CookieFactory getCookieFactory()

getCorsHandlerFactory

protected CorsHandlerFactory getCorsHandlerFactory()

getGzipCheckerHandlerFactory

protected GzipCheckerHandlerFactory getGzipCheckerHandlerFactory()

getSkipResourceOnQueryStringHandlerFactory

protected SkipResourceOnQueryStringHandlerFactory getSkipResourceOnQueryStringHandlerFactory()

getSpincastResourceHandlerFactory

protected SpincastResourceHandlerFactory getSpincastResourceHandlerFactory()

getCacheBusterRemovalHandlerFactory

protected CacheBusterRemovalHandlerFactory getCacheBusterRemovalHandlerFactory()

getFileClassPathResourceManagerFactory

protected FileClassPathResourceManagerFactory getFileClassPathResourceManagerFactory()

getSpincastHttpAuthIdentityManagerFactory

protected SpincastHttpAuthIdentityManagerFactory getSpincastHttpAuthIdentityManagerFactory()

getSpincastWebsocketEndpointFactory

protected WebsocketEndpointFactory getSpincastWebsocketEndpointFactory()

getStaticResourcesServedByUrlPath

protected Map<String,StaticResource<?>> getStaticResourcesServedByUrlPath()

getHttpAuthIdentityManagersByRealmName

protected Map<String,SpincastHttpAuthIdentityManager> getHttpAuthIdentityManagersByRealmName()

getWebsocketEndpointsMap

protected Map<String,WebsocketEndpoint> getWebsocketEndpointsMap()

getHttpAuthActiveRealms

protected Map<String,String> getHttpAuthActiveRealms()

getSslContextFactory

protected SSLContextFactory getSslContextFactory()

getServerUtils

protected ServerUtils getServerUtils()

getHttpAuthenticationRealms

public Map<String,String> getHttpAuthenticationRealms()

Specified by:

getHttpAuthenticationRealms in interface Server

getFormParserFactory

protected io.undertow.server.handlers.form.FormParserFactory getFormParserFactory()

createUndertowTempDir

protected Path createUndertowTempDir()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Server

start

public void start()

Specified by:

start in interface Server

getServerStartTryNbr

protected int getServerStartTryNbr()

getStartServerSleepMilliseconds

protected long getStartServerSleepMilliseconds()

getServerBuilder

protected io.undertow.Undertow.Builder getServerBuilder()

addHttpListener

protected void addHttpListener(io.undertow.Undertow.Builder builder,
                               String serverHost,
                               int httpServerPort)

addHttpsListener

protected void addHttpsListener(io.undertow.Undertow.Builder builder,
                                String serverHost,
                                int httpsServerPort)

addBuilderOptions

protected io.undertow.Undertow.Builder addBuilderOptions(io.undertow.Undertow.Builder builder)

getFinalHandler

protected io.undertow.server.HttpHandler getFinalHandler()

The very first handler considered by Undertow.

getCacheBusterRemovalHandler

protected CacheBusterRemovalHandler getCacheBusterRemovalHandler()

Handler to remove cache busters from the request's URL.

getHttpAuthenticationHandler

protected io.undertow.server.handlers.PathHandler getHttpAuthenticationHandler()

Handler to check for HTTP authentication requirement.

getHttpAuthHandlerNextHandler

protected io.undertow.server.HttpHandler getHttpAuthHandlerNextHandler()

createHttpAuthenticationRealm

public void createHttpAuthenticationRealm(String pathPrefix,
                                          String realmName)

Specified by:

createHttpAuthenticationRealm in interface Server

getRealmNameToDisplay

protected String getRealmNameToDisplay(String pathPrefix,
                                       String realmName)

The realm name to display.

getOrCreateHttpAuthIdentityManagersByRealmName

protected SpincastHttpAuthIdentityManager getOrCreateHttpAuthIdentityManagersByRealmName(String realmName)

addHttpAuthentication

public void addHttpAuthentication(String realmName,
                                  String username,
                                  String password)

Specified by:

addHttpAuthentication in interface Server

removeHttpAuthentication

public void removeHttpAuthentication(String username,
                                     String realmName)

Specified by:

removeHttpAuthentication in interface Server

removeHttpAuthentication

public void removeHttpAuthentication(String username)

Specified by:

removeHttpAuthentication in interface Server

getSpincastFrontControllerHandler

protected io.undertow.server.HttpHandler getSpincastFrontControllerHandler()

stop

public void stop()

Specified by:

stop in interface Server

stop

public void stop(boolean sendClosingMessageToPeers)

Specified by:

stop in interface Server

getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer

protected int getSecondsToWaitForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()

getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer

protected int getMilliSecondsIncrementWhenWaitingForWebSocketEndpointsToBeProperlyClosedBeforeKillingTheServer()

sendWebsocketEnpointsClosedWhenServerStops

protected void sendWebsocketEnpointsClosedWhenServerStops()

getStaticResourcesPathHandler

protected io.undertow.server.handlers.PathHandler getStaticResourcesPathHandler()

addStaticResourceToServe

public void addStaticResourceToServe(StaticResource<?> staticResource)

Specified by:

addStaticResourceToServe in interface Server

removeStaticResourcesServed

public void removeStaticResourcesServed(StaticResourceType staticResourceType,
                                        String urlPath)

Specified by:

removeStaticResourcesServed in interface Server

removeAllStaticResourcesServed

public void removeAllStaticResourcesServed()

Specified by:

removeAllStaticResourcesServed in interface Server

removeStaticResource

protected void removeStaticResource(StaticResourceType staticResourceType,
                                    String urlPath)

getStaticResourceServed

public StaticResource<?> getStaticResourceServed(String urlPath)

Specified by:

getStaticResourceServed in interface Server

getStaticResourcesServed

public Set<StaticResource<?>> getStaticResourcesServed()

Specified by:

getStaticResourcesServed in interface Server

getHttpMethod

public HttpMethod getHttpMethod(Object exchange)

Specified by:

getHttpMethod in interface Server

castExchange

protected io.undertow.server.HttpServerExchange castExchange(Object exchange)

getContentTypeBestMatch

public ContentTypeDefaults getContentTypeBestMatch(Object exchangeObj)

Specified by:

getContentTypeBestMatch in interface Server

getFullUrlProxied

public String getFullUrlProxied(Object exchangeObj)

Specified by:

getFullUrlProxied in interface Server

getFullUrlProxied

public String getFullUrlProxied(Object exchangeObj,
                                boolean keepCacheBusters)

Specified by:

getFullUrlProxied in interface Server

getFullUrlOriginal

public String getFullUrlOriginal(Object exchangeObj)

Specified by:

getFullUrlOriginal in interface Server

getFullUrlOriginal

public String getFullUrlOriginal(Object exchangeObj,
                                 boolean keepCacheBusters)

Specified by:

getFullUrlOriginal in interface Server

setResponseHeader

public void setResponseHeader(Object exchangeObj,
                              String name,
                              List<String> values)

Specified by:

setResponseHeader in interface Server

setResponseHeaders

public void setResponseHeaders(Object exchange,
                               Map<String,List<String>> headers)

Specified by:

setResponseHeaders in interface Server

getResponseHeaders

public Map<String,List<String>> getResponseHeaders(Object exchangeObj)

Specified by:

getResponseHeaders in interface Server

removeResponseHeader

public void removeResponseHeader(Object exchange,
                                 String name)

Specified by:

removeResponseHeader in interface Server

setResponseStatusCode

public void setResponseStatusCode(Object exchange,
                                  int statusCode)

Specified by:

setResponseStatusCode in interface Server

getDoNothingCallback

protected io.undertow.io.IoCallback getDoNothingCallback()

getCloseExchangeCallback

protected io.undertow.io.IoCallback getCloseExchangeCallback()

flushBytes

public void flushBytes(Object exchange,
                       byte[] bytes,
                       boolean end)

Specified by:

flushBytes in interface Server

end

public void end(Object exchange)

Specified by:

end in interface Server

isResponseClosed

public boolean isResponseClosed(Object exchange)

Specified by:

isResponseClosed in interface Server

isResponseHeadersSent

public boolean isResponseHeadersSent(Object exchange)

Specified by:

isResponseHeadersSent in interface Server

getRequestScheme

public String getRequestScheme(Object exchange)

Specified by:

getRequestScheme in interface Server

addCookies

public void addCookies(Object exchange,
                       Map<String,Cookie> cookies)

Specified by:

addCookies in interface Server

getCookies

public Map<String,String> getCookies(Object exchange)

Specified by:

getCookies in interface Server

getCookieEncoding

protected String getCookieEncoding()

getQueryStringParams

public Map<String,List<String>> getQueryStringParams(Object exchange)

Specified by:

getQueryStringParams in interface Server

getRawInputStream

public InputStream getRawInputStream(Object exchangeObj)

Specified by:

getRawInputStream in interface Server

getFormData

protected io.undertow.server.handlers.form.FormData getFormData(io.undertow.server.HttpServerExchange exchange)

May return NULL.

getFormData

public Map<String,List<String>> getFormData(Object exchangeObj)

Specified by:

getFormData in interface Server

getUploadedFiles

public Map<String,List<UploadedFile>> getUploadedFiles(Object exchangeObj)

Specified by:

getUploadedFiles in interface Server

forceRequestSizeValidation

public boolean forceRequestSizeValidation(Object exchangeObj)

Specified by:

forceRequestSizeValidation in interface Server

getRequestHeaders

public Map<String,List<String>> getRequestHeaders(Object exchangeObj)

The names of the headers are case insensitive.

Specified by:

getRequestHeaders in interface Server

getWebsocketEndpointCreationLock

protected Object getWebsocketEndpointCreationLock(String endpointId)

Gets the creation/close lock for a specific Websocket endpoint.

websocketCreateEndpoint

public WebsocketEndpointManager websocketCreateEndpoint(String endpointId,
                                                        WebsocketEndpointHandler appEndpointHandler)

Specified by:

websocketCreateEndpoint in interface Server

createUndertowWebsocketEndpointHandler

protected WebsocketEndpointHandler createUndertowWebsocketEndpointHandler(String endpointId,
                                                                          WebsocketEndpointHandler appHandler)

websocketCloseEndpoint

public void websocketCloseEndpoint(String endpointId)

Specified by:

websocketCloseEndpoint in interface Server

websocketCloseEndpoint

public void websocketCloseEndpoint(String endpointId,
                                   int closingCode,
                                   String closingReason)

Specified by:

websocketCloseEndpoint in interface Server

websocketConnection

public void websocketConnection(Object exchangeObj,
                                String endpointId,
                                String peerId)

Specified by:

websocketConnection in interface Server

getWebsocketEndpointManagers

public List<WebsocketEndpointManager> getWebsocketEndpointManagers()

Specified by:

getWebsocketEndpointManagers in interface Server

getWebsocketEndpointManager

public WebsocketEndpointManager getWebsocketEndpointManager(String endpointId)

Specified by:

getWebsocketEndpointManager in interface Server

getIp

public String getIp(Object exchangeObj)

Specified by:

getIp in interface Server