org.spincast.plugins.undertow

Class SpincastUndertowServer

java.lang.Object

org.spincast.plugins.undertow.SpincastUndertowServer

All Implemented Interfaces:

IServer

public class SpincastUndertowServer
extends Object
implements IServer

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(ISpincastConfig config, ISpincastUndertowConfig spincastUndertowConfig, IFrontController frontController, ISpincastUtils spincastUtils, ICookieFactory cookieFactory, ICorsHandlerFactory corsHandlerFactory, IGzipCheckerHandlerFactory gzipCheckerHandlerFactory, ISpincastResourceHandlerFactory spincastResourceHandlerFactory, ICacheBusterRemovalHandlerFactory cacheBusterRemovalHandlerFactory, IFileClassPathResourceManagerFactory fileClassPathResourceManagerFactory, ISpincastHttpAuthIdentityManagerFactory spincastHttpAuthIdentityManagerFactory, IWebsocketEndpointFactory spincastWebsocketEndpointFactory, ISSLContextFactory sslContextFactory) 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,ICookie> 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(IStaticResource<?> staticResource)
protected io.undertow.server.HttpServerExchange	castExchange(Object exchange)
void	createHttpAuthenticationRealm(String pathPrefix, String realmName)
protected IWebsocketEndpointHandler	createUndertowWebsocketEndpointHandler(String endpointId, IWebsocketEndpointHandler appHandler)
void	end(Object exchange)
void	flushBytes(Object exchange, byte[] bytes, boolean end)
boolean	forceRequestSizeValidation(Object exchangeObj)
protected ICacheBusterRemovalHandler	getCacheBusterRemovalHandler() Handler to remove cache busters from the request's URL.
protected ICacheBusterRemovalHandlerFactory	getCacheBusterRemovalHandlerFactory()
protected io.undertow.io.IoCallback	getCloseExchangeCallback()
protected ISpincastConfig	getConfig()
ContentTypeDefaults	getContentTypeBestMatch(Object exchangeObj)
protected String	getCookieEncoding()
protected ICookieFactory	getCookieFactory()
Map<String,ICookie>	getCookies(Object exchange)
protected ICorsHandlerFactory	getCorsHandlerFactory()
protected io.undertow.io.IoCallback	getDoNothingCallback()
protected IFileClassPathResourceManagerFactory	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>>	getFormDatas(Object exchangeObj)
protected io.undertow.server.handlers.form.FormParserFactory	getFormParserFactory()
protected IFrontController	getFrontController()
String	getFullUrlOriginal(Object exchangeObj)
String	getFullUrlOriginal(Object exchangeObj, boolean keepCacheBusters)
String	getFullUrlProxied(Object exchangeObj)
String	getFullUrlProxied(Object exchangeObj, boolean keepCacheBusters)
protected IGzipCheckerHandlerFactory	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,ISpincastHttpAuthIdentityManager>	getHttpAuthIdentityManagersByRealmName()
HttpMethod	getHttpMethod(Object exchange)
protected ISpincastHttpAuthIdentityManager	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)
String	getRequestScheme(Object exchange)
Map<String,List<String>>	getResponseHeaders(Object exchangeObj)
protected io.undertow.Undertow.Builder	getServerBuilder()
protected int	getServerStartTryNbr()
protected io.undertow.server.HttpHandler	getSpincastFrontControllerHandler()
protected ISpincastHttpAuthIdentityManagerFactory	getSpincastHttpAuthIdentityManagerFactory()
protected ISpincastResourceHandlerFactory	getSpincastResourceHandlerFactory()
protected ISpincastUndertowConfig	getSpincastUndertowConfig()
protected ISpincastUtils	getSpincastUtils()
protected IWebsocketEndpointFactory	getSpincastWebsocketEndpointFactory()
protected ISSLContextFactory	getSslContextFactory()
protected long	getStartServerSleepMilliseconds()
IStaticResource<?>	getStaticResourceServed(String urlPath)
protected io.undertow.server.handlers.PathHandler	getStaticResourcesPathHandler()
Set<IStaticResource<?>>	getStaticResourcesServed()
protected Map<String,IStaticResource<?>>	getStaticResourcesServedByUrlPath()
Map<String,List<File>>	getUploadedFiles(Object exchangeObj)
protected Object	getWebsocketEndpointCreationLock(String endpointId) Gets the creation/close lock for a specific Websocket endpoint.
IWebsocketEndpointManager	getWebsocketEndpointManager(String endpointId)
List<IWebsocketEndpointManager>	getWebsocketEndpointManagers()
protected Map<String,IWebsocketEndpoint>	getWebsocketEndpointsMap()
boolean	isResponseClosed(Object exchange)
boolean	isResponseHeadersSent(Object exchange)
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	websocketCloseEndpoint(String endpointId)
void	websocketCloseEndpoint(String endpointId, int closingCode, String closingReason)
void	websocketConnection(Object exchangeObj, String endpointId, String peerId)
IWebsocketEndpointManager	websocketCreateEndpoint(String endpointId, IWebsocketEndpointHandler 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(ISpincastConfig config,
                                       ISpincastUndertowConfig spincastUndertowConfig,
                                       IFrontController frontController,
                                       ISpincastUtils spincastUtils,
                                       ICookieFactory cookieFactory,
                                       ICorsHandlerFactory corsHandlerFactory,
                                       IGzipCheckerHandlerFactory gzipCheckerHandlerFactory,
                                       ISpincastResourceHandlerFactory spincastResourceHandlerFactory,
                                       ICacheBusterRemovalHandlerFactory cacheBusterRemovalHandlerFactory,
                                       IFileClassPathResourceManagerFactory fileClassPathResourceManagerFactory,
                                       ISpincastHttpAuthIdentityManagerFactory spincastHttpAuthIdentityManagerFactory,
                                       IWebsocketEndpointFactory spincastWebsocketEndpointFactory,
                                       ISSLContextFactory sslContextFactory)

Constructor

Method Detail

getConfig

protected ISpincastConfig getConfig()

getSpincastUndertowConfig

protected ISpincastUndertowConfig getSpincastUndertowConfig()

getFrontController

protected IFrontController getFrontController()

getSpincastUtils

protected ISpincastUtils getSpincastUtils()

getCookieFactory

protected ICookieFactory getCookieFactory()

getCorsHandlerFactory

protected ICorsHandlerFactory getCorsHandlerFactory()

getGzipCheckerHandlerFactory

protected IGzipCheckerHandlerFactory getGzipCheckerHandlerFactory()

getSpincastResourceHandlerFactory

protected ISpincastResourceHandlerFactory getSpincastResourceHandlerFactory()

getCacheBusterRemovalHandlerFactory

protected ICacheBusterRemovalHandlerFactory getCacheBusterRemovalHandlerFactory()

getFileClassPathResourceManagerFactory

protected IFileClassPathResourceManagerFactory getFileClassPathResourceManagerFactory()

getSpincastHttpAuthIdentityManagerFactory

protected ISpincastHttpAuthIdentityManagerFactory getSpincastHttpAuthIdentityManagerFactory()

getSpincastWebsocketEndpointFactory

protected IWebsocketEndpointFactory getSpincastWebsocketEndpointFactory()

getStaticResourcesServedByUrlPath

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

getHttpAuthIdentityManagersByRealmName

protected Map<String,ISpincastHttpAuthIdentityManager> getHttpAuthIdentityManagersByRealmName()

getWebsocketEndpointsMap

protected Map<String,IWebsocketEndpoint> getWebsocketEndpointsMap()

getHttpAuthActiveRealms

protected Map<String,String> getHttpAuthActiveRealms()

getSslContextFactory

protected ISSLContextFactory getSslContextFactory()

getHttpAuthenticationRealms

public Map<String,String> getHttpAuthenticationRealms()

Specified by:

getHttpAuthenticationRealms in interface IServer

getFormParserFactory

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

start

public void start()

Specified by:

start in interface IServer

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 ICacheBusterRemovalHandler 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 IServer

getRealmNameToDisplay

protected String getRealmNameToDisplay(String pathPrefix,
                                       String realmName)

The realm name to display.

getOrCreateHttpAuthIdentityManagersByRealmName

protected ISpincastHttpAuthIdentityManager getOrCreateHttpAuthIdentityManagersByRealmName(String realmName)

addHttpAuthentication

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

Specified by:

addHttpAuthentication in interface IServer

removeHttpAuthentication

public void removeHttpAuthentication(String username,
                                     String realmName)

Specified by:

removeHttpAuthentication in interface IServer

removeHttpAuthentication

public void removeHttpAuthentication(String username)

Specified by:

removeHttpAuthentication in interface IServer

getSpincastFrontControllerHandler

protected io.undertow.server.HttpHandler getSpincastFrontControllerHandler()

stop

public void stop()

Specified by:

stop in interface IServer

sendWebsocketEnpointsClosedWhenServerStops

protected void sendWebsocketEnpointsClosedWhenServerStops()

getStaticResourcesPathHandler

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

addStaticResourceToServe

public void addStaticResourceToServe(IStaticResource<?> staticResource)

Specified by:

addStaticResourceToServe in interface IServer

removeStaticResourcesServed

public void removeStaticResourcesServed(StaticResourceType staticResourceType,
                                        String urlPath)

Specified by:

removeStaticResourcesServed in interface IServer

removeAllStaticResourcesServed

public void removeAllStaticResourcesServed()

Specified by:

removeAllStaticResourcesServed in interface IServer

removeStaticResource

protected void removeStaticResource(StaticResourceType staticResourceType,
                                    String urlPath)

getStaticResourceServed

public IStaticResource<?> getStaticResourceServed(String urlPath)

Specified by:

getStaticResourceServed in interface IServer

getStaticResourcesServed

public Set<IStaticResource<?>> getStaticResourcesServed()

Specified by:

getStaticResourcesServed in interface IServer

getHttpMethod

public HttpMethod getHttpMethod(Object exchange)

Specified by:

getHttpMethod in interface IServer

castExchange

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

getContentTypeBestMatch

public ContentTypeDefaults getContentTypeBestMatch(Object exchangeObj)

Specified by:

getContentTypeBestMatch in interface IServer

getFullUrlProxied

public String getFullUrlProxied(Object exchangeObj)

Specified by:

getFullUrlProxied in interface IServer

getFullUrlProxied

public String getFullUrlProxied(Object exchangeObj,
                                boolean keepCacheBusters)

Specified by:

getFullUrlProxied in interface IServer

getFullUrlOriginal

public String getFullUrlOriginal(Object exchangeObj)

Specified by:

getFullUrlOriginal in interface IServer

getFullUrlOriginal

public String getFullUrlOriginal(Object exchangeObj,
                                 boolean keepCacheBusters)

Specified by:

getFullUrlOriginal in interface IServer

setResponseHeader

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

Specified by:

setResponseHeader in interface IServer

setResponseHeaders

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

Specified by:

setResponseHeaders in interface IServer

getResponseHeaders

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

Specified by:

getResponseHeaders in interface IServer

removeResponseHeader

public void removeResponseHeader(Object exchange,
                                 String name)

Specified by:

removeResponseHeader in interface IServer

setResponseStatusCode

public void setResponseStatusCode(Object exchange,
                                  int statusCode)

Specified by:

setResponseStatusCode in interface IServer

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 IServer

end

public void end(Object exchange)

Specified by:

end in interface IServer

isResponseClosed

public boolean isResponseClosed(Object exchange)

Specified by:

isResponseClosed in interface IServer

isResponseHeadersSent

public boolean isResponseHeadersSent(Object exchange)

Specified by:

isResponseHeadersSent in interface IServer

getRequestScheme

public String getRequestScheme(Object exchange)

Specified by:

getRequestScheme in interface IServer

addCookies

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

Specified by:

addCookies in interface IServer

getCookies

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

Specified by:

getCookies in interface IServer

getCookieEncoding

protected String getCookieEncoding()

getQueryStringParams

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

Specified by:

getQueryStringParams in interface IServer

getRawInputStream

public InputStream getRawInputStream(Object exchangeObj)

Specified by:

getRawInputStream in interface IServer

getFormData

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

May return NULL.

getFormDatas

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

Specified by:

getFormDatas in interface IServer

getUploadedFiles

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

Specified by:

getUploadedFiles in interface IServer

forceRequestSizeValidation

public boolean forceRequestSizeValidation(Object exchangeObj)

Specified by:

forceRequestSizeValidation in interface IServer

getRequestHeaders

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

Specified by:

getRequestHeaders in interface IServer

getWebsocketEndpointCreationLock

protected Object getWebsocketEndpointCreationLock(String endpointId)

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

websocketCreateEndpoint

public IWebsocketEndpointManager websocketCreateEndpoint(String endpointId,
                                                         IWebsocketEndpointHandler appEndpointHandler)

Specified by:

websocketCreateEndpoint in interface IServer

createUndertowWebsocketEndpointHandler

protected IWebsocketEndpointHandler createUndertowWebsocketEndpointHandler(String endpointId,
                                                                           IWebsocketEndpointHandler appHandler)

websocketCloseEndpoint

public void websocketCloseEndpoint(String endpointId)

Specified by:

websocketCloseEndpoint in interface IServer

websocketCloseEndpoint

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

Specified by:

websocketCloseEndpoint in interface IServer

websocketConnection

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

Specified by:

websocketConnection in interface IServer

getWebsocketEndpointManagers

public List<IWebsocketEndpointManager> getWebsocketEndpointManagers()

Specified by:

getWebsocketEndpointManagers in interface IServer

getWebsocketEndpointManager

public IWebsocketEndpointManager getWebsocketEndpointManager(String endpointId)

Specified by:

getWebsocketEndpointManager in interface IServer